RpcServer.Call (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.ipc.RpcServer.Call

All Implemented Interfaces:: RpcCallContext

Enclosing class:: RpcServer

@InterfaceAudience.LimitedPrivate(value={"Coprocesssor","Phoenix"})
@InterfaceStability.Evolving
public class RpcServer.Call
extends Object
implements RpcCallContext

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

Field Summary

Fields
Modifier and Type	Field and Description
`private ByteBuffer`	`cellBlock`
`protected CellScanner`	`cellScanner`
`protected RpcServer.Connection`	`connection`
`protected org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader`	`header`
`protected int`	`id`
`protected boolean`	`isError`
`protected com.google.protobuf.Descriptors.MethodDescriptor`	`md`
`protected com.google.protobuf.Message`	`param`
`private InetAddress`	`remoteAddress`
`protected RpcServer.Responder`	`responder`
`protected BufferChain`	`response` Chain of buffers to send as response.
`private long`	`responseBlockSize`
`private long`	`responseCellSize`
`private boolean`	`retryImmediatelySupported`
`protected com.google.protobuf.BlockingService`	`service`
`protected long`	`size`
`protected long`	`timestamp`
`protected org.apache.htrace.TraceInfo`	`tinfo`
`private User`	`user`

Constructor Summary

Constructors
Constructor and Description
`RpcServer.Call(int id, com.google.protobuf.BlockingService service, com.google.protobuf.Descriptors.MethodDescriptor md, org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header, com.google.protobuf.Message param, CellScanner cellScanner, RpcServer.Connection connection, RpcServer.Responder responder, long size, org.apache.htrace.TraceInfo tinfo, InetAddress remoteAddress)`

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`disconnectSince()` Check if the caller who made this IPC call has disconnected.
`(package private) void`	`done()` Call is done.
`org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.VersionInfo`	`getClientVersionInfo()`
`protected org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader`	`getHeader()`
`int`	`getPriority()`
`InetAddress`	`getRemoteAddress()`
`org.apache.hadoop.security.UserGroupInformation`	`getRemoteUser()`
`User`	`getRequestUser()` Returns the user credentials associated with the current RPC request or `null` if no credentials were provided.
`String`	`getRequestUserName()`
`long`	`getResponseBlockSize()`
`long`	`getResponseCellSize()` The size of response cells that have been accumulated so far.
`long`	`getSize()`
`boolean`	`hasPriority()`
`void`	`incrementResponseBlockSize(long blockSize)`
`void`	`incrementResponseCellSize(long cellSize)` Add on the given amount to the retained cell size.
`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`	`sendResponseIfReady()`
`protected void`	`setResponse(Object m, CellScanner cells, Throwable t, String errorMsg)`
`protected void`	`setSaslTokenResponse(ByteBuffer response)`
`(package private) String`	`toShortString()`
`String`	`toString()`
`(package private) String`	`toTraceString()`
`private BufferChain`	`wrapWithSasl(BufferChain bc)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - id
```
protected int id
```
  - service
```
protected com.google.protobuf.BlockingService service
```
  - md
```
protected com.google.protobuf.Descriptors.MethodDescriptor md
```
  - header
```
protected org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header
```
  - param
```
protected com.google.protobuf.Message param
```
  - cellScanner
```
protected CellScanner cellScanner
```
  - connection
```
protected RpcServer.Connection connection
```
  - timestamp
```
protected long timestamp
```
  - response
```
protected BufferChain response
```
    Chain of buffers to send as response.
  - responder
```
protected RpcServer.Responder responder
```
  - size
```
protected long size
```
  - isError
```
protected boolean isError
```
  - tinfo
```
protected org.apache.htrace.TraceInfo tinfo
```
  - cellBlock
```
private ByteBuffer cellBlock
```
  - user
```
private User user
```
  - remoteAddress
```
private InetAddress remoteAddress
```
  - responseCellSize
```
private long responseCellSize
```
  - responseBlockSize
```
private long responseBlockSize
```
  - retryImmediatelySupported
```
private boolean retryImmediatelySupported
```
- Constructor Detail
  - RpcServer.Call
```
RpcServer.Call(int id,
              com.google.protobuf.BlockingService service,
              com.google.protobuf.Descriptors.MethodDescriptor md,
              org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header,
              com.google.protobuf.Message param,
              CellScanner cellScanner,
              RpcServer.Connection connection,
              RpcServer.Responder responder,
              long size,
              org.apache.htrace.TraceInfo tinfo,
              InetAddress remoteAddress)
```
- Method Detail
  - done
```
void done()
```
    Call is done. Execution happened and we returned results to client. It is now safe to cleanup.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getHeader
```
protected org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader getHeader()
```
  - hasPriority
```
public boolean hasPriority()
```
  - getPriority
```
public int getPriority()
```
  - toShortString
```
String toShortString()
```
  - toTraceString
```
String toTraceString()
```
  - setSaslTokenResponse
```
protected void setSaslTokenResponse(ByteBuffer response)
```
  - setResponse
```
protected void setResponse(Object m,
               CellScanner cells,
               Throwable t,
               String errorMsg)
```
  - wrapWithSasl
```
private BufferChain wrapWithSasl(BufferChain bc)
                          throws IOException
```
    Throws:
    
    IOException
  - 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
  - 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
  - getSize
```
public long getSize()
```
  - 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
  - getResponseBlockSize
```
public long getResponseBlockSize()
```
    Specified by:
    
    getResponseBlockSize in interface RpcCallContext
  - incrementResponseBlockSize
```
public void incrementResponseBlockSize(long blockSize)
```
    Specified by:
    
    incrementResponseBlockSize in interface RpcCallContext
  - sendResponseIfReady
```
public void sendResponseIfReady()
                         throws IOException
```
    Throws:
    
    IOException
  - getRemoteUser
```
public org.apache.hadoop.security.UserGroupInformation getRemoteUser()
```
  - getRequestUser
```
public User getRequestUser()
```
    Description copied from interface: RpcCallContext
    
    Returns the user credentials associated with the current RPC request or null if no credentials were provided.
    
    Specified by:
    
    getRequestUser in interface RpcCallContext
    
    Returns:
    A User
  - getRequestUserName
```
public String getRequestUserName()
```
    Specified by:
    
    getRequestUserName in interface RpcCallContext
    
    Returns:
    Current request's user name or null if none ongoing.
  - getRemoteAddress
```
public InetAddress getRemoteAddress()
```
    Specified by:
    
    getRemoteAddress in interface RpcCallContext
    
    Returns:
    Address of remote client if a request is ongoing, else null
  - getClientVersionInfo
```
public org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.VersionInfo getClientVersionInfo()
```
    Specified by:
    
    getClientVersionInfo in interface RpcCallContext
    
    Returns:
    the client version info, or null if the information is not present
  - isRetryImmediatelySupported
```
public boolean isRetryImmediatelySupported()
```
    Specified by:
    
    isRetryImmediatelySupported in interface RpcCallContext

Class RpcServer.Call

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

service

md

header

param

cellScanner

connection

timestamp

response

responder

size

isError

tinfo

cellBlock

user

remoteAddress

responseCellSize

responseBlockSize

retryImmediatelySupported

Constructor Detail

RpcServer.Call

Method Detail

done

toString

getHeader

hasPriority

getPriority

toShortString

toTraceString

setSaslTokenResponse

setResponse

wrapWithSasl

isClientCellBlockSupported

disconnectSince

getSize

getResponseCellSize

incrementResponseCellSize

getResponseBlockSize

incrementResponseBlockSize

sendResponseIfReady

getRemoteUser

getRequestUser

getRequestUserName

getRemoteAddress

getClientVersionInfo

isRetryImmediatelySupported