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.mdsal.binding.api;
10 import org.eclipse.jdt.annotation.NonNull;
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 RpcProviderService}.
21 public interface RpcConsumerRegistry extends BindingService {
23 * Returns an implementation of a requested RPC service.
26 * The returned instance is not an actual implementation of the RPC service interface, but a
27 * proxy implementation of the interface that forwards to an actual implementation, if any.
30 * The following describes the behavior of the proxy when invoking RPC methods:
32 * <li>If an actual implementation is registered with the MD-SAL, all invocations are forwarded
33 * to the registered implementation.</li>
34 * <li>If no actual implementation is registered, all invocations will fail by throwing
35 * {@link IllegalStateException}.</li>
36 * <li>Prior to invoking the actual implementation, the method arguments are are validated. If
37 * any are invalid, an {@link IllegalArgumentException} is thrown.
39 * The returned proxy is automatically updated with the most recent registered implementation.
42 * The generated RPC method APIs require implementors to return a
43 * {@link java.util.concurrent.Future Future} instance that wraps the
44 * {@link org.opendaylight.yangtools.yang.common.RpcResult RpcResult}. Since RPC methods may be
45 * implemented asynchronously, callers should avoid blocking on the
46 * {@link java.util.concurrent.Future Future} result. Instead, it is recommended to use
47 * {@link com.google.common.util.concurrent.JdkFutureAdapters#listenInPoolThread(java.util.concurrent.Future)}
49 * {@link com.google.common.util.concurrent.JdkFutureAdapters#listenInPoolThread(java.util.concurrent.Future,
50 * java.util.concurrent.Executor)} to listen for Rpc Result. This will asynchronously listen for future result
51 * in executor and will not block current thread.
54 * final Future<RpcResult<SomeRpcOutput>> future = someRpcService.someRpc( ... );
55 * Futures.addCallback(JdkFutureAdapters.listenInThreadPool(future), new FutureCallback<RpcResult<
56 * 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
69 * generated from a YANG model.
70 * @return the proxy for the requested RPC service. This method never returns null.
72 <T extends RpcService> @NonNull T getRpcService(@NonNull Class<T> serviceInterface);