no.rmz.blobee.rpc.client

Interface RpcClient

All Known Implementing Classes:

ConnectingRpcClientImpl, RpcClientImpl

public interface RpcClient

An implement implementing an RPC client that can be used as an utility function for clients implementing protoc generated rpc interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
RpcClient	addInterface(Class serviceInterface) Let the client handle requests for a service interface.
RpcClient	addInvocationListener(RpcClientSideInvocationListener listener) Used for debugging and testing.
RpcClient	addProtobuferRpcInterface(Object instance)
void	cancelInvocation(long rpcIndex) Cancel invocation.
void	failInvocation(long rpcIndex, String errorMessage) Signal that an invocation has failed.
MethodSignatureResolver	getResolver() Get the resolver instance used by this client to map methods to parameter/return value prototypes.
com.google.protobuf.RpcChannel	newClientRpcChannel() Generate a new client channel to be used for communicating through this RpcClient.
BlobeeRpcController	newController() Get a new controller associated with this client.
void	returnCall(RemoteExecutionContext dc, com.google.protobuf.Message message) Return the value of an invocation.
RpcClient	start() Start the client.
void	stop() Stop the client from accepting incoming invocations.
void	terminateMultiSequence(long rpcIdx) Terminate the sequence of return values associated with the index.

Method Detail

cancelInvocation

void cancelInvocation(long rpcIndex)

Cancel invocation.

Parameters:

rpcIndex - Index of the invocation to cancel.

failInvocation

void failInvocation(long rpcIndex,
                  String errorMessage)

Signal that an invocation has failed.

Parameters:

rpcIndex - The index of the invocation to fail.

errorMessage - A human readable error message.

newClientRpcChannel

com.google.protobuf.RpcChannel newClientRpcChannel()

Generate a new client channel to be used for communicating through this RpcClient.

Returns:

An RPCChannel that can be used to invoke remote procedures.

newController

BlobeeRpcController newController()

Get a new controller associated with this client.

Returns:

a new controller

returnCall

void returnCall(RemoteExecutionContext dc,
              com.google.protobuf.Message message)

Return the value of an invocation.

Parameters:

dc - The context for this invocation.

message - The value to return.

start

RpcClient start()

Start the client. After the client is started it an be used to handle requests.

Returns:

The present RpcClient.

stop

void stop()

Stop the client from accepting incoming invocations.

addProtobuferRpcInterface

RpcClient addProtobuferRpcInterface(Object instance)

addInterface

RpcClient addInterface(Class serviceInterface)

Let the client handle requests for a service interface.

Parameters:

serviceInterface - A protoc generated service interface.

Returns:

The present rpc client.

getResolver

MethodSignatureResolver getResolver()

Get the resolver instance used by this client to map methods to parameter/return value prototypes.

Returns:

the resolver.

addInvocationListener

RpcClient addInvocationListener(RpcClientSideInvocationListener listener)

Used for debugging and testing. Used to listen in on rpc requests that pass through the client.

Parameters:

listener - a listener

Returns:

this rpc client.

terminateMultiSequence

void terminateMultiSequence(long rpcIdx)

Terminate the sequence of return values associated with the index.

Parameters:

rpcIdx - The index we're ending the return sequence for.