org.apache.hadoop.hbase.ipc

Interface RpcCall

All Superinterfaces:

RpcCallContext

All Known Implementing Classes:

ServerCall

@InterfaceAudience.LimitedPrivate(value={"Coprocesssor","Phoenix"})
 @InterfaceStability.Evolving
public interface RpcCall
extends RpcCallContext

Interface of all necessary to carry out a RPC method invocation on the server.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Do the necessary cleanup after the call if needed.
CellScanner	getCellScanner()
long	getDeadline() Return the deadline of this call.
RPCProtos.RequestHeader	getHeader()
org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor	getMethod()
org.apache.hbase.thirdparty.com.google.protobuf.Message	getParam()
int	getPriority()
long	getReceiveTime()
int	getRemotePort()
org.apache.hbase.thirdparty.com.google.protobuf.BlockingService	getService()
long	getSize() Used to calculate the request call queue size.
long	getStartTime()
int	getTimeout()
void	sendResponseIfReady() Send the response of this RPC call.
void	setResponse(org.apache.hbase.thirdparty.com.google.protobuf.Message param, CellScanner cells, Throwable errorThrowable, String error) Set the response resulting from this RPC call.
void	setStartTime(long startTime) Set the time when the call starts to be executed.
String	toShortString()

Methods inherited from interface org.apache.hadoop.hbase.ipc.RpcCallContext

disconnectSince, getClientVersionInfo, getRemoteAddress, getRequestUser, getRequestUserName, getResponseBlockSize, getResponseCellSize, getResponseExceptionSize, incrementResponseBlockSize, incrementResponseCellSize, incrementResponseExceptionSize, isClientCellBlockSupported, isRetryImmediatelySupported, setCallBack

Method Detail

getService

org.apache.hbase.thirdparty.com.google.protobuf.BlockingService getService()

Returns:

The service of this call.

getMethod

org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor getMethod()

Returns:

The service method.

getParam

org.apache.hbase.thirdparty.com.google.protobuf.Message getParam()

Returns:

The call parameter message.

getCellScanner

CellScanner getCellScanner()

Returns:

The CellScanner that can carry input and result payload.

getReceiveTime

long getReceiveTime()

Returns:

The timestamp when the call is constructed.

getStartTime

long getStartTime()

Returns:

The time when the call starts to be executed.

setStartTime

void setStartTime(long startTime)

Set the time when the call starts to be executed.

getTimeout

int getTimeout()

Returns:

The timeout of this call.

getPriority

int getPriority()

Returns:

The Priority of this call.

getDeadline

long getDeadline()

Return the deadline of this call. If we can not complete this call in time, we can throw a TimeoutIOException and RPCServer will drop it.

Returns:

The system timestamp of deadline.

getSize

long getSize()

Used to calculate the request call queue size. If the total request call size exceeds a limit, the call will be rejected.

Returns:

The raw size of this call.

getHeader

RPCProtos.RequestHeader getHeader()

Returns:

The request header of this call.

getRemotePort

int getRemotePort()

Returns:

Port of remote address in this call

setResponse

void setResponse(org.apache.hbase.thirdparty.com.google.protobuf.Message param,
                 CellScanner cells,
                 Throwable errorThrowable,
                 String error)

Set the response resulting from this RPC call.

Parameters:

param - The result message as response.

cells - The CellScanner that possibly carries the payload.

errorThrowable - The error Throwable resulting from the call.

error - Extra error message.

sendResponseIfReady

void sendResponseIfReady()
                  throws IOException

Send the response of this RPC call. Implementation provides the underlying facility (connection, etc) to send.

Throws:

IOException

cleanup

void cleanup()

Do the necessary cleanup after the call if needed.

toShortString

String toShortString()

Returns:

A short string format of this call without possibly lengthy params