Package org.apache.hadoop.hbase.ipc

Class ServerCall<T extends ServerRpcConnection>

java.lang.Object

org.apache.hadoop.hbase.ipc.ServerCall<T>

All Implemented Interfaces:

RpcCall, RpcCallContext, RpcResponse

Direct Known Subclasses:

NettyServerCall, SimpleServerCall

@Private
public abstract class ServerCall<T extends ServerRpcConnection>
extends Object
implements RpcCall, RpcResponse

Datastructure that holds all necessary to a method invocation and then afterward, carries the result.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ByteBuffAllocator	bbAllocator
protected final CellBlockBuilder	cellBlockBuilder
protected ByteBufferListOutputStream	cellBlockStream
protected final ExtendedCellScanner	cellScanner
protected final X509Certificate[]	clientCertificateChain
protected final T	connection
protected final long	deadline
private long	exceptionSize
protected final org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader	header
protected final int	id
protected boolean	isError
protected final org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor	md
protected org.apache.hbase.thirdparty.com.google.protobuf.Message	param
protected final long	receiveTime
private final AtomicInteger	reference
protected final InetAddress	remoteAddress
protected RpcServer.CallCleanup	reqCleanup
private Map<String,byte[]>	requestAttributes
protected BufferChain	response	Chain of buffers to send as response.
private long	responseBlockSize
private long	responseCellSize
private final boolean	retryImmediatelySupported
protected RpcCallback	rpcCallback
protected final org.apache.hbase.thirdparty.com.google.protobuf.BlockingService	service
protected final long	size
private final io.opentelemetry.api.trace.Span	span
protected long	startTime
protected final int	timeout
protected final User	user

Constructor Summary

Constructors

Constructor

Description

ServerCall(int id, org.apache.hbase.thirdparty.com.google.protobuf.BlockingService service, org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md, org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader header, org.apache.hbase.thirdparty.com.google.protobuf.Message param, ExtendedCellScanner cellScanner, T connection, long size, InetAddress remoteAddress, long receiveTime, int timeout, ByteBuffAllocator byteBuffAllocator, CellBlockBuilder cellBlockBuilder, RpcServer.CallCleanup reqCleanup)

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Do the necessary cleanup after the call if needed.
private BufferChain	createFallbackErrorResponse(IOException originalException)
private static ByteBuffer	createHeaderAndMessageBytes(org.apache.hbase.thirdparty.com.google.protobuf.Message result, org.apache.hbase.thirdparty.com.google.protobuf.Message header, int totalSize, int totalPBSize)
(package private) static ByteBuffer	createHeaderAndMessageBytes(org.apache.hbase.thirdparty.com.google.protobuf.Message result, org.apache.hbase.thirdparty.com.google.protobuf.Message header, int cellBlockSize, List<ByteBuffer> cellBlock)
long	disconnectSince()	Check if the caller who made this IPC call has disconnected.
void	done()	Call is done.
long	getBlockBytesScanned()	Get the number of block bytes scanned by the current call.
ExtendedCellScanner	getCellScanner()	Returns The CellScanner that can carry input and result payload.
Optional<X509Certificate[]>	getClientCertificateChain()	Returns the TLS certificate(s) that the client presented to this HBase server when making its connection.
org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.VersionInfo	getClientVersionInfo()	Returns the client version info, or null if the information is not present
Map<String,byte[]>	getConnectionAttributes()	Returns the map of attributes specified when building the Connection.
long	getDeadline()	Return the deadline of this call.
org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader	getHeader()	Returns The request header of this call.
org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor	getMethod()	Returns The service method.
org.apache.hbase.thirdparty.com.google.protobuf.Message	getParam()	Returns The call parameter message.
int	getPriority()	Returns The Priority of this call.
long	getReceiveTime()	Returns The timestamp when the call is constructed.
InetAddress	getRemoteAddress()	Returns Address of remote client in this call
int	getRemotePort()	Returns Port of remote address in this call
byte[]	getRequestAttribute(String key)	Returns a single request attribute value, or null if no value is present.
Map<String,byte[]>	getRequestAttributes()	Returns the map of attributes specified when building the request.
Optional<User>	getRequestUser()	Returns the user credentials associated with the current RPC request or not present if no credentials were provided.
BufferChain	getResponse()
long	getResponseCellSize()	The size of response cells that have been accumulated so far.
long	getResponseExceptionSize()
org.apache.hbase.thirdparty.com.google.protobuf.BlockingService	getService()	Returns The service of this call.
long	getSize()	Used to calculate the request call queue size.
long	getStartTime()	Returns The time when the call starts to be executed.
int	getTimeout()	Returns The timeout of this call.
void	incrementBlockBytesScanned(long blockSize)	Increment the number of block bytes scanned by the current call.
void	incrementResponseCellSize(long cellSize)	Add on the given amount to the retained cell size.
void	incrementResponseExceptionSize(long exSize)
boolean	isClientCellBlockSupported()	If the client connected and specified a codec to use, then we will use this codec making cellblocks to return.
boolean	isRetryImmediatelySupported()
void	releaseByWAL()
void	retainByWAL()
void	setCallBack(RpcCallback callback)	Sets a callback which has to be executed at the end of this RPC call.
(package private) static void	setExceptionResponse(Throwable t, String errorMsg, org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ResponseHeader.Builder headerBuilder)
void	setResponse(org.apache.hbase.thirdparty.com.google.protobuf.Message m, ExtendedCellScanner cells, Throwable t, String errorMsg)	Set the response resulting from this RPC call.
void	setStartTime(long t)	Set the time when the call starts to be executed.
String	toShortString()	Returns A short string format of this call without possibly lengthy params
String	toString()
private static void	writeToCOS(org.apache.hbase.thirdparty.com.google.protobuf.Message result, org.apache.hbase.thirdparty.com.google.protobuf.Message header, int totalSize, ByteBuffer pbBuf)

Methods inherited from class java.lang.Object

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

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

sendResponseIfReady

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

getRequestUserName

Field Details

id

protected final int id

service

protected final org.apache.hbase.thirdparty.com.google.protobuf.BlockingService service

md

protected final org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md

header

protected final org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader header

param

protected org.apache.hbase.thirdparty.com.google.protobuf.Message param

cellScanner

protected final ExtendedCellScanner cellScanner

connection

protected final T extends ServerRpcConnection connection

receiveTime

protected final long receiveTime

timeout

protected final int timeout

startTime

protected long startTime

deadline

protected final long deadline

bbAllocator

protected final ByteBuffAllocator bbAllocator

cellBlockBuilder

protected final CellBlockBuilder cellBlockBuilder

response

protected BufferChain response

Chain of buffers to send as response.

size

protected final long size

isError

protected boolean isError

cellBlockStream

protected ByteBufferListOutputStream cellBlockStream

reqCleanup

protected RpcServer.CallCleanup reqCleanup

user

protected final User user

remoteAddress

protected final InetAddress remoteAddress

clientCertificateChain

protected final X509Certificate[] clientCertificateChain

rpcCallback

protected RpcCallback rpcCallback

responseCellSize

private long responseCellSize

responseBlockSize

private long responseBlockSize

exceptionSize

private long exceptionSize

retryImmediatelySupported

private final boolean retryImmediatelySupported

requestAttributes

private volatile Map<String,byte[]> requestAttributes

reference

private final AtomicInteger reference

span

private final io.opentelemetry.api.trace.Span span

Constructor Details

ServerCall

ServerCall(int id,
 org.apache.hbase.thirdparty.com.google.protobuf.BlockingService service,
 org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md,
 org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader header,
 org.apache.hbase.thirdparty.com.google.protobuf.Message param,
 ExtendedCellScanner cellScanner,
 T connection,
 long size,
 InetAddress remoteAddress,
 long receiveTime,
 int timeout,
 ByteBuffAllocator byteBuffAllocator,
 CellBlockBuilder cellBlockBuilder,
 RpcServer.CallCleanup reqCleanup)

Method Details

done

public void done()

Call is done. Execution happened and we returned results to client. It is now safe to cleanup.

Specified by:

done in interface RpcResponse

cleanup

public void cleanup()

Description copied from interface: RpcCall

Do the necessary cleanup after the call if needed.

Specified by:

cleanup in interface RpcCall

retainByWAL

public void retainByWAL()

releaseByWAL

public void releaseByWAL()

toString

public String toString()

Overrides:

toString in class Object

getHeader

public org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader getHeader()

Description copied from interface: RpcCall

Returns The request header of this call.

Specified by:

getHeader in interface RpcCall

getConnectionAttributes

public Map<String,byte[]> getConnectionAttributes()

Description copied from interface: RpcCall

Returns the map of attributes specified when building the Connection.

Specified by:

getConnectionAttributes in interface RpcCall

See Also:

• ConnectionFactory.createConnection(Configuration, ExecutorService, User, Map)

getRequestAttributes

public Map<String,byte[]> getRequestAttributes()

Description copied from interface: RpcCall

Returns the map of attributes specified when building the request. This map is lazily evaluated so if you only need a single attribute then it may be cheaper to use RpcCall.getRequestAttribute(String)

Specified by:

getRequestAttributes in interface RpcCall

See Also:

• TableBuilder.setRequestAttribute(String, byte[])

getRequestAttribute

public byte[] getRequestAttribute(String key)

Description copied from interface: RpcCall

Returns a single request attribute value, or null if no value is present. If you need many request attributes then you should fetch the lazily evaluated map via RpcCall.getRequestAttributes()

Specified by:

getRequestAttribute in interface RpcCall

See Also:

• TableBuilder.setRequestAttribute(String, byte[])

getPriority

public int getPriority()

Description copied from interface: RpcCall

Returns The Priority of this call.

Specified by:

getPriority in interface RpcCall

toShortString

public String toShortString()

Description copied from interface: RpcCall

Returns A short string format of this call without possibly lengthy params

Specified by:

toShortString in interface RpcCall

setResponse

public void setResponse(org.apache.hbase.thirdparty.com.google.protobuf.Message m,
 ExtendedCellScanner cells,
 Throwable t,
 String errorMsg)

Description copied from interface: RpcCall

Set the response resulting from this RPC call.

Specified by:

setResponse in interface RpcCall

Parameters:

m - The result message as response.

cells - The CellScanner that possibly carries the payload.

t - The error Throwable resulting from the call.

errorMsg - Extra error message.

setExceptionResponse

static void setExceptionResponse(Throwable t,
 String errorMsg,
 org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ResponseHeader.Builder headerBuilder)

createFallbackErrorResponse

private BufferChain createFallbackErrorResponse(IOException originalException)

createHeaderAndMessageBytes

static ByteBuffer createHeaderAndMessageBytes(org.apache.hbase.thirdparty.com.google.protobuf.Message result,
 org.apache.hbase.thirdparty.com.google.protobuf.Message header,
 int cellBlockSize,
 List<ByteBuffer> cellBlock)
                                       throws IOException

Throws:

IOException

writeToCOS

private static void writeToCOS(org.apache.hbase.thirdparty.com.google.protobuf.Message result,
 org.apache.hbase.thirdparty.com.google.protobuf.Message header,
 int totalSize,
 ByteBuffer pbBuf)
                        throws IOException

Throws:

IOException

createHeaderAndMessageBytes

private static ByteBuffer createHeaderAndMessageBytes(org.apache.hbase.thirdparty.com.google.protobuf.Message result,
 org.apache.hbase.thirdparty.com.google.protobuf.Message header,
 int totalSize,
 int totalPBSize)
                                               throws IOException

Throws:

IOException

disconnectSince

public long disconnectSince()

Description copied from interface: RpcCallContext

Check if the caller who made this IPC call has disconnected. If called from outside the context of IPC, this does nothing.

Specified by:

disconnectSince in interface RpcCallContext

Returns:

< 0 if the caller is still connected. The time in ms since the disconnection otherwise

isClientCellBlockSupported

public boolean isClientCellBlockSupported()

Description copied from interface: RpcCallContext

If the client connected and specified a codec to use, then we will use this codec making cellblocks to return. If the client did not specify a codec, we assume it does not support cellblocks and will return all content protobuf'd (though it makes our serving slower). We need to ask this question per call because a server could be hosting both clients that support cellblocks while fielding requests from clients that do not.

Specified by:

isClientCellBlockSupported in interface RpcCallContext

Returns:

True if the client supports cellblocks, else return all content in pb

getResponseCellSize

public long getResponseCellSize()

Description copied from interface: RpcCallContext

The size of response cells that have been accumulated so far. This along with the corresponding increment call is used to ensure that multi's or scans dont get too excessively large

Specified by:

getResponseCellSize in interface RpcCallContext

incrementResponseCellSize

public void incrementResponseCellSize(long cellSize)

Description copied from interface: RpcCallContext

Add on the given amount to the retained cell size. This is not thread safe and not synchronized at all. If this is used by more than one thread then everything will break. Since this is called for every row synchronization would be too onerous.

Specified by:

incrementResponseCellSize in interface RpcCallContext

getBlockBytesScanned

public long getBlockBytesScanned()

Description copied from interface: RpcCallContext

Get the number of block bytes scanned by the current call. In order to serve a response, 1 or more lower level blocks must be loaded (from disk or cache) and scanned for the requested cells. This value includes the total block size for each block loaded for the request.

Specified by:

getBlockBytesScanned in interface RpcCallContext

incrementBlockBytesScanned

public void incrementBlockBytesScanned(long blockSize)

Description copied from interface: RpcCallContext

Increment the number of block bytes scanned by the current call. See RpcCallContext.getBlockBytesScanned() for details.

Specified by:

incrementBlockBytesScanned in interface RpcCallContext

getResponseExceptionSize

public long getResponseExceptionSize()

Specified by:

getResponseExceptionSize in interface RpcCallContext

incrementResponseExceptionSize

public void incrementResponseExceptionSize(long exSize)

Specified by:

incrementResponseExceptionSize in interface RpcCallContext

getSize

public long getSize()

Description copied from interface: RpcCall

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

Specified by:

getSize in interface RpcCall

Returns:

The raw size of this call.

getDeadline

public long getDeadline()

Description copied from interface: RpcCall

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.

Specified by:

getDeadline in interface RpcCall

Returns:

The system timestamp of deadline.

getRequestUser

public Optional<User> getRequestUser()

Description copied from interface: RpcCallContext

Returns the user credentials associated with the current RPC request or not present if no credentials were provided.

Specified by:

getRequestUser in interface RpcCallContext

Returns:

A User

getClientCertificateChain

public Optional<X509Certificate[]> getClientCertificateChain()

Description copied from interface: RpcCallContext

Returns the TLS certificate(s) that the client presented to this HBase server when making its connection. TLS is orthogonal to Kerberos, so this is unrelated to RpcCallContext.getRequestUser(). Both, one, or neither may be present.

Specified by:

getClientCertificateChain in interface RpcCallContext

getRemoteAddress

public InetAddress getRemoteAddress()

Description copied from interface: RpcCallContext

Returns Address of remote client in this call

Specified by:

getRemoteAddress in interface RpcCallContext

getClientVersionInfo

public org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.VersionInfo getClientVersionInfo()

Description copied from interface: RpcCallContext

Returns the client version info, or null if the information is not present

Specified by:

getClientVersionInfo in interface RpcCallContext

setCallBack

public void setCallBack(RpcCallback callback)

Description copied from interface: RpcCallContext

Sets a callback which has to be executed at the end of this RPC call. Such a callback is an optional one for any Rpc call.

Specified by:

setCallBack in interface RpcCallContext

isRetryImmediatelySupported

public boolean isRetryImmediatelySupported()

Specified by:

isRetryImmediatelySupported in interface RpcCallContext

getService

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

Description copied from interface: RpcCall

Returns The service of this call.

Specified by:

getService in interface RpcCall

getMethod

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

Description copied from interface: RpcCall

Returns The service method.

Specified by:

getMethod in interface RpcCall

getParam

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

Description copied from interface: RpcCall

Returns The call parameter message.

Specified by:

getParam in interface RpcCall

getCellScanner

public ExtendedCellScanner getCellScanner()

Description copied from interface: RpcCall

Returns The CellScanner that can carry input and result payload.

Specified by:

getCellScanner in interface RpcCall

getReceiveTime

public long getReceiveTime()

Description copied from interface: RpcCall

Returns The timestamp when the call is constructed.

Specified by:

getReceiveTime in interface RpcCall

getStartTime

public long getStartTime()

Description copied from interface: RpcCall

Returns The time when the call starts to be executed.

Specified by:

getStartTime in interface RpcCall

setStartTime

public void setStartTime(long t)

Description copied from interface: RpcCall

Set the time when the call starts to be executed.

Specified by:

setStartTime in interface RpcCall

getTimeout

public int getTimeout()

Description copied from interface: RpcCall

Returns The timeout of this call.

Specified by:

getTimeout in interface RpcCall

getRemotePort

public int getRemotePort()

Description copied from interface: RpcCall

Returns Port of remote address in this call

Specified by:

getRemotePort in interface RpcCall

getResponse

public BufferChain getResponse()

Specified by:

getResponse in interface RpcResponse