org.opendaylight.vtn.manager.internal.util.rpc

Class RpcFuture<I,O>

java.lang.Object

org.opendaylight.vtn.manager.internal.util.concurrent.AbstractVTNFuture<T>

org.opendaylight.vtn.manager.internal.util.concurrent.SettableVTNFuture<org.opendaylight.yangtools.yang.common.RpcResult<O>>

org.opendaylight.vtn.manager.internal.util.rpc.RpcFuture<I,O>

Type Parameters:

I - The type of the result returned by the future associated with this future.

O - The type of the RPC output.

All Implemented Interfaces:

com.google.common.util.concurrent.CheckedFuture<org.opendaylight.yangtools.yang.common.RpcResult<O>,VTNException>, com.google.common.util.concurrent.FutureCallback<I>, com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<O>>, Future<org.opendaylight.yangtools.yang.common.RpcResult<O>>, VTNFuture<org.opendaylight.yangtools.yang.common.RpcResult<O>>

public final class RpcFuture<I,O>
extends SettableVTNFuture<org.opendaylight.yangtools.yang.common.RpcResult<O>>
implements com.google.common.util.concurrent.FutureCallback<I>

RpcFuture describes an ongoing RPC request.

An instance of RpcFuture is always associated with another future, and will return the result when the given future completes the execution.

Constructor Summary

Constructors

Constructor and Description
RpcFuture(VTNFuture<I> f, RpcOutputGenerator<I,O> gen) Construct a new future which represents an ongoing RPC request.

Method Summary

Modifier and Type	Method and Description
void	onFailure(Throwable cause) Invoked when the main task of the RPC has failed.
void	onSuccess(I result) Invoked when the main task of the RPC has completed successfully.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.concurrent.SettableVTNFuture

cancel, get, get, isCancelled, isDone, maskCancel, onFutureFailed, onFutureSucceeded, set, setException, setThread, unmaskCancel

Methods inherited from class org.opendaylight.vtn.manager.internal.util.concurrent.AbstractVTNFuture

addListener, done, getCause, getException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opendaylight.vtn.manager.internal.util.concurrent.VTNFuture

checkedGet, checkedGet

Constructor Detail

RpcFuture

public RpcFuture(VTNFuture<I> f,
                 RpcOutputGenerator<I,O> gen)

Construct a new future which represents an ongoing RPC request.

Parameters:

f - A VTNFuture associated with the main procedure of RPC.

gen - RPC output generator.

Method Detail

onSuccess

public void onSuccess(I result)

Invoked when the main task of the RPC has completed successfully.

Specified by:

onSuccess in interface com.google.common.util.concurrent.FutureCallback<I>

Parameters:

result - The result of the main task.

onFailure

public void onFailure(Throwable cause)

Invoked when the main task of the RPC has failed.

Specified by:

onFailure in interface com.google.common.util.concurrent.FutureCallback<I>

Parameters:

cause - A Throwable that indicates the cause of failure.