no.rmz.blobee.rpc.peer.wireprotocol

Class OutgoingRpcAdapterImpl

java.lang.Object

no.rmz.blobee.rpc.peer.wireprotocol.OutgoingRpcAdapterImpl

All Implemented Interfaces:

OutgoingRpcAdapter

public final class OutgoingRpcAdapterImpl
extends Object
implements OutgoingRpcAdapter

An adapter that translates an API style programming into a wire-format style.

Constructor Summary

Constructors

Constructor and Description
OutgoingRpcAdapterImpl(org.jboss.netty.channel.Channel channel) Construct a new adapter that will send all its messages to the parameter channel.

Method Summary

Methods

Modifier and Type	Method and Description
void	returnRpcResult(long rpcIndex, Rpc.MethodSignature methodSignature, com.google.protobuf.Message result, boolean multiReturn) Send a return value for an invocation.
void	sendCancelMessage(long rpcIndex) Send a cancel message.
void	sendHeartbeat() Send a heartbeat message so that the peer at the other end of the connection knows that we're alive.
void	sendInvocation(String methodName, String inputType, String outputType, Long rpcIndex, com.google.protobuf.Message rpParameter, boolean multiReturn, boolean noReturn) Send a request to invoke a remote procedure.
void	sendInvocationFailedMessage(long rpcIndex, String reason) Sent by the serving side of a connection can inform the client side that an invocation failed for some reason.
void	terminateMultiReturnSequence(long rpcIndex) Terminate a sequence of return values.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutgoingRpcAdapterImpl

public OutgoingRpcAdapterImpl(org.jboss.netty.channel.Channel channel)

Construct a new adapter that will send all its messages to the parameter channel.

Parameters:

channel - the channel to send all messages to.

Method Detail

sendInvocation

public void sendInvocation(String methodName,
                  String inputType,
                  String outputType,
                  Long rpcIndex,
                  com.google.protobuf.Message rpParameter,
                  boolean multiReturn,
                  boolean noReturn)

Description copied from interface: OutgoingRpcAdapter

Send a request to invoke a remote procedure.

Specified by:

sendInvocation in interface OutgoingRpcAdapter

Parameters:

methodName - The name of the method, this is a fqdn in the java type namespace.

inputType - The name of the input parameter. An fqdn in the java type namespace.

rpcIndex - For this outgoing connection, this is an index uniquely identifying the invocation.

rpParameter - The parameter to the remote procedure.

multiReturn - True iff the invocation can return multiple values.

noReturn - true iff the invocation is expected to return no value.

returnRpcResult

public void returnRpcResult(long rpcIndex,
                   Rpc.MethodSignature methodSignature,
                   com.google.protobuf.Message result,
                   boolean multiReturn)

Description copied from interface: OutgoingRpcAdapter

Send a return value for an invocation.

Specified by:

returnRpcResult in interface OutgoingRpcAdapter

Parameters:

rpcIndex - The index of this invocation.

methodSignature - The signature of the method being invoked.

result - The actual result being returned.

multiReturn - True iff the invocation can return multiple values, meaning this return value may not be the last one.

sendHeartbeat

public void sendHeartbeat()

Description copied from interface: OutgoingRpcAdapter

Send a heartbeat message so that the peer at the other end of the connection knows that we're alive.

Specified by:

sendHeartbeat in interface OutgoingRpcAdapter

sendCancelMessage

public void sendCancelMessage(long rpcIndex)

Description copied from interface: OutgoingRpcAdapter

Send a cancel message. This is always sent by the client side of an invocation and will result in the invocation being flagged as "cancelled". The serving method will be informed of this through the RpcController interface.

Specified by:

sendCancelMessage in interface OutgoingRpcAdapter

Parameters:

rpcIndex - Index of the cancelled invocation.

sendInvocationFailedMessage

public void sendInvocationFailedMessage(long rpcIndex,
                               String reason)

Description copied from interface: OutgoingRpcAdapter

Sent by the serving side of a connection can inform the client side that an invocation failed for some reason.

Specified by:

sendInvocationFailedMessage in interface OutgoingRpcAdapter

Parameters:

rpcIndex - The index of the failed invocation.

reason - A human readable string explaing what went wrong.

terminateMultiReturnSequence

public void terminateMultiReturnSequence(long rpcIndex)

Description copied from interface: OutgoingRpcAdapter

Terminate a sequence of return values. After this invocation the receiving client can delete all references to the invocation.

Specified by:

terminateMultiReturnSequence in interface OutgoingRpcAdapter

Parameters:

rpcIndex - The invocation that is now terminating.