2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.sal.binding.api;
10 import org.opendaylight.controller.md.sal.binding.api.BindingService;
11 import org.opendaylight.yangtools.yang.binding.RpcService;
14 * Provides access to registered Remote Procedure Call (RPC) service implementations. The RPCs are
15 * defined in YANG models.
18 * RPC implementations are registered using the {@link RpcProviderRegistry}.
21 public interface RpcConsumerRegistry extends BindingAwareService, BindingService {
23 * Returns an implementation of a requested RPC service.
26 * The returned instance is not an actual implementation of the RPC service
27 * interface, but a proxy implementation of the interface that forwards to
28 * an actual implementation, if any.
31 * The following describes the behavior of the proxy when invoking RPC methods:
33 * <li>If an actual implementation is registered with the MD-SAL, all invocations are
34 * forwarded to the registered implementation.</li>
35 * <li>If no actual implementation is registered, all invocations will fail by
36 * throwing {@link IllegalStateException}.</li>
37 * <li>Prior to invoking the actual implementation, the method arguments are are validated.
38 * If any are invalid, an {@link IllegalArgumentException} is thrown.
41 * The returned proxy is automatically updated with the most recent
42 * registered implementation.
44 * The generated RPC method APIs require implementors to return a {@link java.util.concurrent.Future Future}
45 * instance that wraps the {@link org.opendaylight.yangtools.yang.common.RpcResult RpcResult}. Since
46 * RPC methods may be implemented asynchronously, callers should avoid blocking on the
47 * {@link java.util.concurrent.Future Future} result. Instead, it is recommended to use
48 * {@link com.google.common.util.concurrent.JdkFutureAdapters#listenInPoolThread(java.util.concurrent.Future)}
49 * or {@link com.google.common.util.concurrent.JdkFutureAdapters#listenInPoolThread(java.util.concurrent.Future,
50 * java.util.concurrent.Executor)}
51 * to listen for Rpc Result. This will asynchronously listen for future result in executor and
52 * will not block current thread.
55 * final Future<RpcResult<SomeRpcOutput>> future = someRpcService.someRpc( ... );
56 * Futures.addCallback(JdkFutureAdapters.listenInThreadPool(future),
57 * new FutureCallback<RpcResult<SomeRpcOutput>>() {
58 * public void onSuccess(RpcResult<SomeRpcOutput> result) {
59 * // process result ...
62 * public void onFailure(Throwable t) {
68 * @param serviceInterface the interface of the RPC Service. Typically this is an interface generated
70 * @return the proxy for the requested RPC service. This method never returns null.
72 <T extends RpcService> T getRpcService(Class<T> serviceInterface);