no.rmz.blobee.rpc.peer.wireprotocol

Interface OutgoingRpcAdapter

All Known Implementing Classes:

OutgoingRpcAdapterImpl

public interface OutgoingRpcAdapter

This interface represents the outgoing direction of an RPC connection. Everything sent through this interface is atomic in the sense that is either all sent as one package or not sent at all.

Method Summary

Methods

Modifier and Type	Method and Description
void	returnRpcResult(long rpcIndex, Rpc.MethodSignature methodSignature, com.google.protobuf.Message result) 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 request) 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.

Method Detail

sendInvocation

void sendInvocation(String methodName,
                  String inputType,
                  String outputType,
                  Long rpcIndex,
                  com.google.protobuf.Message request)

Send a request to invoke a remote procedure.

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.

outputTypeThe - name of the output parameter. An fqdn in the java type namespace.

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

request - The parameter to the remote procedure.

returnRpcResult

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

Send a return value for an invocation.

Parameters:

rpcIndex - The index of this invocation.

methodSignature - The signature of the method being invoked.

result - The actual result being returned.

sendHeartbeat

void sendHeartbeat()

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

sendCancelMessage

void sendCancelMessage(long rpcIndex)

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.

Parameters:

rpcIndex - Index of the cancelled invocation.

sendInvocationFailedMessage

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.

Parameters:

rpcIndex - The index of the failed invocation.

reason - A human readable string explaing what went wrong.