ServerCall (Apache HBase - Server 2.2.4 API)

java.lang.Object
- org.apache.hadoop.hbase.ipc.ServerCall<T>

所有已实现的接口:: RpcCall, RpcCallContext

@InterfaceAudience.Private
public abstract class ServerCall<T extends org.apache.hadoop.hbase.ipc.ServerRpcConnection>
extends Object
implements RpcCall

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

字段概要

字段
限定符和类型	字段和说明
`protected org.apache.hadoop.hbase.ipc.CellBlockBuilder`	`cellBlockBuilder`
`protected ByteBufferListOutputStream`	`cellBlockStream`
`protected CellScanner`	`cellScanner`
`protected T`	`connection`
`protected long`	`deadline`
`protected org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader`	`header`
`protected int`	`id`
`protected boolean`	`isError`
`protected org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor`	`md`
`protected org.apache.hbase.thirdparty.com.google.protobuf.Message`	`param`
`protected long`	`receiveTime`
`protected InetAddress`	`remoteAddress`
`protected RpcServer.CallCleanup`	`reqCleanup`
`protected ByteBufferPool`	`reservoir`
`protected org.apache.hadoop.hbase.ipc.BufferChain`	`response` Chain of buffers to send as response.
`protected RpcCallback`	`rpcCallback`
`protected org.apache.hbase.thirdparty.com.google.protobuf.BlockingService`	`service`
`protected long`	`size`
`protected long`	`startTime`
`protected int`	`timeout`
`protected User`	`user`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`cleanup()` Do the necessary cleanup after the call if needed.
`long`	`disconnectSince()` Check if the caller who made this IPC call has disconnected.
`void`	`done()` Call is done.
`CellScanner`	`getCellScanner()`
`org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.VersionInfo`	`getClientVersionInfo()`
`long`	`getDeadline()` Return the deadline of this call.
`org.apache.hadoop.hbase.shaded.protobuf.generated.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()`
`InetAddress`	`getRemoteAddress()`
`int`	`getRemotePort()`
`Optional<User>`	`getRequestUser()` Returns the user credentials associated with the current RPC request or not present if no credentials were provided.
`org.apache.hadoop.hbase.ipc.BufferChain`	`getResponse()`
`long`	`getResponseBlockSize()`
`long`	`getResponseCellSize()` The size of response cells that have been accumulated so far.
`long`	`getResponseExceptionSize()`
`org.apache.hbase.thirdparty.com.google.protobuf.BlockingService`	`getService()`
`long`	`getSize()` Used to calculate the request call queue size.
`long`	`getStartTime()`
`int`	`getTimeout()`
`void`	`incrementResponseBlockSize(long blockSize)`
`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.
`void`	`setResponse(org.apache.hbase.thirdparty.com.google.protobuf.Message m, CellScanner 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()`
`String`	`toString()`
`protected org.apache.hadoop.hbase.ipc.BufferChain`	`wrapWithSasl(org.apache.hadoop.hbase.ipc.BufferChain bc)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.hadoop.hbase.ipc.RpcCall
sendResponseIfReady

从接口继承的方法 org.apache.hadoop.hbase.ipc.RpcCallContext
getRequestUserName

- 字段详细资料
  - 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 CellScanner cellScanner
```
  - connection
```
protected final T extends org.apache.hadoop.hbase.ipc.ServerRpcConnection connection
```
  - receiveTime
```
protected final long receiveTime
```
  - timeout
```
protected final int timeout
```
  - startTime
```
protected long startTime
```
  - deadline
```
protected final long deadline
```
  - reservoir
```
protected final ByteBufferPool reservoir
```
  - cellBlockBuilder
```
protected final org.apache.hadoop.hbase.ipc.CellBlockBuilder cellBlockBuilder
```
  - response
```
protected org.apache.hadoop.hbase.ipc.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
```
  - rpcCallback
```
protected RpcCallback rpcCallback
```
- 方法详细资料
  - done
```
public void done()
```
    Call is done. Execution happened and we returned results to client. It is now safe to cleanup.
  - cleanup
```
public void cleanup()
```
    从接口复制的说明: RpcCall
    
    Do the necessary cleanup after the call if needed.
    
    指定者:
    
    cleanup 在接口中 RpcCall
  - retainByWAL
```
public void retainByWAL()
```
  - releaseByWAL
```
public void releaseByWAL()
```
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - getHeader
```
public org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader getHeader()
```
    指定者:
    
    getHeader 在接口中 RpcCall
    
    返回:
    
    The request header of this call.
  - getPriority
```
public int getPriority()
```
    指定者:
    
    getPriority 在接口中 RpcCall
    
    返回:
    
    The Priority of this call.
  - toShortString
```
public String toShortString()
```
    指定者:
    
    toShortString 在接口中 RpcCall
    
    返回:
    
    A short string format of this call without possibly lengthy params
  - setResponse
```
public void setResponse(org.apache.hbase.thirdparty.com.google.protobuf.Message m,
                        CellScanner cells,
                        Throwable t,
                        String errorMsg)
```
    从接口复制的说明: RpcCall
    
    Set the response resulting from this RPC call.
    
    指定者:
    
    setResponse 在接口中 RpcCall
    
    参数:
    
    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.
  - wrapWithSasl
```
protected org.apache.hadoop.hbase.ipc.BufferChain wrapWithSasl(org.apache.hadoop.hbase.ipc.BufferChain bc)
                                                        throws IOException
```
    抛出:
    
    IOException
  - disconnectSince
```
public long disconnectSince()
```
    从接口复制的说明: RpcCallContext
    
    Check if the caller who made this IPC call has disconnected. If called from outside the context of IPC, this does nothing.
    
    指定者:
    
    disconnectSince 在接口中 RpcCallContext
    
    返回:
    
    < 0 if the caller is still connected. The time in ms since the disconnection otherwise
  - isClientCellBlockSupported
```
public boolean isClientCellBlockSupported()
```
    从接口复制的说明: 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.
    
    指定者:
    
    isClientCellBlockSupported 在接口中 RpcCallContext
    
    返回:
    
    True if the client supports cellblocks, else return all content in pb
  - getResponseCellSize
```
public long getResponseCellSize()
```
    从接口复制的说明: 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
    
    指定者:
    
    getResponseCellSize 在接口中 RpcCallContext
  - incrementResponseCellSize
```
public void incrementResponseCellSize(long cellSize)
```
    从接口复制的说明: 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.
    
    指定者:
    
    incrementResponseCellSize 在接口中 RpcCallContext
  - getResponseBlockSize
```
public long getResponseBlockSize()
```
    指定者:
    
    getResponseBlockSize 在接口中 RpcCallContext
  - incrementResponseBlockSize
```
public void incrementResponseBlockSize(long blockSize)
```
    指定者:
    
    incrementResponseBlockSize 在接口中 RpcCallContext
  - getResponseExceptionSize
```
public long getResponseExceptionSize()
```
    指定者:
    
    getResponseExceptionSize 在接口中 RpcCallContext
  - incrementResponseExceptionSize
```
public void incrementResponseExceptionSize(long exSize)
```
    指定者:
    
    incrementResponseExceptionSize 在接口中 RpcCallContext
  - getSize
```
public long getSize()
```
    从接口复制的说明: RpcCall
    
    Used to calculate the request call queue size. If the total request call size exceeds a limit, the call will be rejected.
    
    指定者:
    
    getSize 在接口中 RpcCall
    
    返回:
    
    The raw size of this call.
  - getDeadline
```
public long getDeadline()
```
    从接口复制的说明: 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.
    
    指定者:
    
    getDeadline 在接口中 RpcCall
    
    返回:
    
    The system timestamp of deadline.
  - getRequestUser
```
public Optional<User> getRequestUser()
```
    从接口复制的说明: RpcCallContext
    
    Returns the user credentials associated with the current RPC request or not present if no credentials were provided.
    
    指定者:
    
    getRequestUser 在接口中 RpcCallContext
    
    返回:
    
    A User
  - getRemoteAddress
```
public InetAddress getRemoteAddress()
```
    指定者:
    
    getRemoteAddress 在接口中 RpcCallContext
    
    返回:
    
    Address of remote client in this call
  - getClientVersionInfo
```
public org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.VersionInfo getClientVersionInfo()
```
    指定者:
    
    getClientVersionInfo 在接口中 RpcCallContext
    
    返回:
    
    the client version info, or null if the information is not present
  - setCallBack
```
public void setCallBack(RpcCallback callback)
```
    从接口复制的说明: 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.
    
    指定者:
    
    setCallBack 在接口中 RpcCallContext
  - isRetryImmediatelySupported
```
public boolean isRetryImmediatelySupported()
```
    指定者:
    
    isRetryImmediatelySupported 在接口中 RpcCallContext
  - getService
```
public org.apache.hbase.thirdparty.com.google.protobuf.BlockingService getService()
```
    指定者:
    
    getService 在接口中 RpcCall
    
    返回:
    
    The service of this call.
  - getMethod
```
public org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor getMethod()
```
    指定者:
    
    getMethod 在接口中 RpcCall
    
    返回:
    
    The service method.
  - getParam
```
public org.apache.hbase.thirdparty.com.google.protobuf.Message getParam()
```
    指定者:
    
    getParam 在接口中 RpcCall
    
    返回:
    
    The call parameter message.
  - getCellScanner
```
public CellScanner getCellScanner()
```
    指定者:
    
    getCellScanner 在接口中 RpcCall
    
    返回:
    
    The CellScanner that can carry input and result payload.
  - getReceiveTime
```
public long getReceiveTime()
```
    指定者:
    
    getReceiveTime 在接口中 RpcCall
    
    返回:
    
    The timestamp when the call is constructed.
  - getStartTime
```
public long getStartTime()
```
    指定者:
    
    getStartTime 在接口中 RpcCall
    
    返回:
    
    The time when the call starts to be executed.
  - setStartTime
```
public void setStartTime(long t)
```
    从接口复制的说明: RpcCall
    
    Set the time when the call starts to be executed.
    
    指定者:
    
    setStartTime 在接口中 RpcCall
  - getTimeout
```
public int getTimeout()
```
    指定者:
    
    getTimeout 在接口中 RpcCall
    
    返回:
    
    The timeout of this call.
  - getRemotePort
```
public int getRemotePort()
```
    指定者:
    
    getRemotePort 在接口中 RpcCall
    
    返回:
    
    Port of remote address in this call
  - getResponse
```
public org.apache.hadoop.hbase.ipc.BufferChain getResponse()
```

类 ServerCall<T extends org.apache.hadoop.hbase.ipc.ServerRpcConnection>

字段概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.hadoop.hbase.ipc.RpcCall

从接口继承的方法 org.apache.hadoop.hbase.ipc.RpcCallContext

字段详细资料

id

service

md

header

param

cellScanner

connection

receiveTime

timeout

startTime

deadline

reservoir

cellBlockBuilder

response

size

isError

cellBlockStream

reqCleanup

user

remoteAddress

rpcCallback

方法详细资料

done

cleanup

retainByWAL

releaseByWAL

toString

getHeader

getPriority

toShortString

setResponse

wrapWithSasl

disconnectSince

isClientCellBlockSupported

getResponseCellSize

incrementResponseCellSize

getResponseBlockSize

incrementResponseBlockSize

getResponseExceptionSize

incrementResponseExceptionSize

getSize

getDeadline

getRequestUser

getRemoteAddress

getClientVersionInfo

setCallBack

isRetryImmediatelySupported

getService

getMethod

getParam

getCellScanner

getReceiveTime

getStartTime

setStartTime

getTimeout

getRemotePort

getResponse