X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-binding-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fbinding%2Fapi%2FRpcConsumerRegistry.java;h=cd70e4c8524ff59b590d9d3d3806b86bc198a2f8;hp=0c5e7649f865403eb2a3c9903ff30223767d6f38;hb=aa1c4a51361239aeaa064eb11eb935be194b6eeb;hpb=9db24f2b887db47a63e56579ecdd6839b0a31b55 diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java index 0c5e7649f8..cd70e4c852 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java @@ -13,20 +13,22 @@ import org.opendaylight.yangtools.yang.binding.RpcService; /** * Provides access to registered Remote Procedure Call (RPC) service implementations. The RPCs are * defined in YANG models. + * *

* RPC implementations are registered using the {@link RpcProviderRegistry}. * + * @deprecated Use {@link org.opendaylight.mdsal.binding.api.RpcConsumerRegistry} instead */ +@Deprecated public interface RpcConsumerRegistry extends BindingAwareService, BindingService { /** * Returns an implementation of a requested RPC service. * *

- * The returned instance is not an actual implementation of the RPC service - * interface, but a proxy implementation of the interface that forwards to - * an actual implementation, if any. - *

+ * The returned instance is not an actual implementation of the RPC service interface, but a proxy implementation + * of the interface that forwards to an actual implementation, if any. * + *

* The following describes the behavior of the proxy when invoking RPC methods: *

* - * The returned proxy is automatically updated with the most recent - * registered implementation. *

- * The generated RPC method APIs require implementors to return a {@link java.util.concurrent.Future Future} - * instance that wraps the {@link org.opendaylight.yangtools.yang.common.RpcResult RpcResult}. Since - * RPC methods may be implemented asynchronously, callers should avoid blocking on the - * {@link java.util.concurrent.Future Future} result. Instead, it is recommended to use - * {@link com.google.common.util.concurrent.JdkFutureAdapters#listenInPoolThread(java.util.concurrent.Future)} - * or {@link com.google.common.util.concurrent.JdkFutureAdapters#listenInPoolThread(java.util.concurrent.Future, java.util.concurrent.Executor)} - * to listen for Rpc Result. This will asynchronously listen for future result in executor and - * will not block current thread. - * - *

+     * The returned proxy is automatically updated with the most recent registered implementation.
+     * {@code
      *   final Future> future = someRpcService.someRpc( ... );
-     *   Futures.addCallback(JdkFutureAdapters.listenInThreadPool(future), new FutureCallback>() {
+     *   Futures.addCallback(future,
+     *       new FutureCallback>() {
+     *           public void onSuccess(RpcResult result) {
+     *               // process result ...
+     *           }
      *
-     *       public void onSuccess(RpcResult result) {
-     *          // process result ...
-     *       }
+     *           public void onFailure(Throwable t) {
+     *              // RPC failed
+     *           }
+     *       });
+     *  }
      *
-     *       public void onFailure(Throwable t) {
-     *          // RPC failed
-     *       }
-     *   );
-     * 
* @param serviceInterface the interface of the RPC Service. Typically this is an interface generated * from a YANG model. * @return the proxy for the requested RPC service. This method never returns null.