org.opendaylight.mdsal.binding.api

Interface RpcConsumerRegistry

All Superinterfaces:

BindingService

All Known Implementing Classes:

BindingDOMRpcServiceAdapter

public interface RpcConsumerRegistry
extends BindingService

Provides access to registered Remote Procedure Call (RPC) service implementations. The RPCs are defined in YANG models.

RPC implementations are registered using the RpcProviderService.

Method Summary

Modifier and Type	Method and Description
<T extends RpcService> T	getRpcService(@NonNull Class<T> serviceInterface) Returns an implementation of a requested RPC service.

Method Detail

getRpcService

<T extends RpcService> T getRpcService(@NonNull Class<T> serviceInterface)

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 following describes the behavior of the proxy when invoking RPC methods:

• If an actual implementation is registered with the MD-SAL, all invocations are forwarded to the registered implementation.
• If no actual implementation is registered, all invocations will fail by throwing IllegalStateException.
• Prior to invoking the actual implementation, the method arguments are are validated. If any are invalid, an IllegalArgumentException is thrown.

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

The generated RPC method APIs require implementors to return a Future instance that wraps the RpcResult. Since RPC methods may be implemented asynchronously, callers should avoid blocking on the Future result. Instead, it is recommended to use JdkFutureAdapters.listenInPoolThread(java.util.concurrent.Future) or 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.

   final Future<RpcResult<SomeRpcOutput>> future = someRpcService.someRpc( ... );
   Futures.addCallback(JdkFutureAdapters.listenInThreadPool(future), new FutureCallback<RpcResult<
   SomeRpcOutput>>() {

       public void onSuccess(RpcResult<SomeRpcOutput> result) {
          // process result ...
       }

       public void onFailure(Throwable t) {
          // RPC failed
       }
   );
 

Parameters:

serviceInterface - the interface of the RPC Service. Typically this is an interface generated from a YANG model.

Returns:

the proxy for the requested RPC service. This method never returns null.