org.opendaylight.controller.md.sal.dom.api

Interface DOMRpcImplementation

All Known Implementing Classes:

BindingDOMRpcImplementationAdapter, ForwardingDOMRpcImplementation, GetConstantService, RoutedGetConstantService, SingletonGetConstantService

public interface DOMRpcImplementation

Interface implemented by an individual RPC implementation. This API allows for dispatch implementations, e.g. an individual object handling a multitude of RPCs.

Method Summary

Modifier and Type	Method and Description
default long	invocationCost() Return the relative invocation cost of this implementation.
@NonNull com.google.common.util.concurrent.CheckedFuture<DOMRpcResult,DOMRpcException>	invokeRpc(@NonNull DOMRpcIdentifier rpc, @Nullable org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> input) Initiate invocation of the RPC.

Method Detail

invokeRpc

@NonNull com.google.common.util.concurrent.CheckedFuture<DOMRpcResult,DOMRpcException> invokeRpc(@NonNull DOMRpcIdentifier rpc,
                                                                                                 @Nullable org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> input)

Initiate invocation of the RPC. Implementations of this method are expected to not block on external resources.

Parameters:

rpc - RPC identifier which was invoked

input - Input arguments, null if the RPC does not take any.

Returns:

A CheckedFuture which will return either a result structure, or report a subclass of DOMRpcException reporting a transport error.

invocationCost

default long invocationCost()

Return the relative invocation cost of this implementation. Default implementation return 0.

Returns:

Non-negative cost of invoking this implementation.