no.rmz.blobee.rpc.client

Class RpcClientImpl

java.lang.Object

no.rmz.blobee.rpc.client.RpcClientImpl

All Implemented Interfaces:

RpcClient

public final class RpcClientImpl
extends Object
implements RpcClient

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAXIMUM_TCP_PORT_NUMBER

Constructor Summary

Constructors

Constructor and Description
RpcClientImpl(int capacity)
RpcClientImpl(int capacity, MethodSignatureResolver resolver)

Method Summary

Methods

Modifier and Type	Method and Description
RpcClient	addInterface(Class serviceDefinition) 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.
void	setChannel(org.jboss.netty.channel.Channel channel)
RpcClient	start() Start the client.
void	start(org.jboss.netty.channel.Channel channel, ChannelShutdownCleaner channelCleanupRunnable)
void	stop() Stop the client from accepting incoming invocations.
void	terminateMultiSequence(long rpcIndex) Terminate the sequence of return values associated with the index.

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMUM_TCP_PORT_NUMBER

public static final int MAXIMUM_TCP_PORT_NUMBER

See Also:

Constant Field Values

Constructor Detail

RpcClientImpl

public RpcClientImpl(int capacity)

RpcClientImpl

public RpcClientImpl(int capacity,
             MethodSignatureResolver resolver)

Method Detail

returnCall

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

Description copied from interface: RpcClient

Return the value of an invocation.

Specified by:

returnCall in interface RpcClient

Parameters:

dc - The context for this invocation.

message - The value to return.

terminateMultiSequence

public void terminateMultiSequence(long rpcIndex)

Description copied from interface: RpcClient

Terminate the sequence of return values associated with the index.

Specified by:

terminateMultiSequence in interface RpcClient

Parameters:

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

setChannel

public void setChannel(org.jboss.netty.channel.Channel channel)

start

public void start(org.jboss.netty.channel.Channel channel,
         ChannelShutdownCleaner channelCleanupRunnable)

newClientRpcChannel

public com.google.protobuf.RpcChannel newClientRpcChannel()

Description copied from interface: RpcClient

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

Specified by:

newClientRpcChannel in interface RpcClient

Returns:

An RPCChannel that can be used to invoke remote procedures.

newController

public BlobeeRpcController newController()

Description copied from interface: RpcClient

Get a new controller associated with this client.

Specified by:

newController in interface RpcClient

Returns:

a new controller

failInvocation

public void failInvocation(long rpcIndex,
                  String errorMessage)

Description copied from interface: RpcClient

Signal that an invocation has failed.

Specified by:

failInvocation in interface RpcClient

Parameters:

rpcIndex - The index of the invocation to fail.

errorMessage - A human readable error message.

cancelInvocation

public void cancelInvocation(long rpcIndex)

Description copied from interface: RpcClient

Cancel invocation.

Specified by:

cancelInvocation in interface RpcClient

Parameters:

rpcIndex - Index of the invocation to cancel.

start

public RpcClient start()

Description copied from interface: RpcClient

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

Specified by:

start in interface RpcClient

Returns:

The present RpcClient.

addInvocationListener

public RpcClient addInvocationListener(RpcClientSideInvocationListener listener)

Description copied from interface: RpcClient

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

Specified by:

addInvocationListener in interface RpcClient

Parameters:

listener - a listener

Returns:

this rpc client.

getResolver

public MethodSignatureResolver getResolver()

Description copied from interface: RpcClient

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

Specified by:

getResolver in interface RpcClient

Returns:

the resolver.

addProtobuferRpcInterface

public RpcClient addProtobuferRpcInterface(Object instance)

Specified by:

addProtobuferRpcInterface in interface RpcClient

addInterface

public RpcClient addInterface(Class serviceDefinition)

Description copied from interface: RpcClient

Let the client handle requests for a service interface.

Specified by:

addInterface in interface RpcClient

Parameters:

serviceDefinition - A protoc generated service interface.

Returns:

The present rpc client.

stop

public void stop()

Description copied from interface: RpcClient

Stop the client from accepting incoming invocations.

Specified by:

stop in interface RpcClient