RSRpcServices (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.regionserver.RSRpcServices

All Implemented Interfaces:

ConfigurationObserver, HBaseRPCErrorHandler, PriorityFunction, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface

Direct Known Subclasses:

MasterRpcServices
```
@InterfaceAudience.Private
public class RSRpcServices
extends Object
implements HBaseRPCErrorHandler, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface, PriorityFunction, ConfigurationObserver
```
Implements the regionserver RPC services.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`RSRpcServices.RegionScannerHolder` Holder class which holds the RegionScanner and nextCallSeq together.
`private class`	`RSRpcServices.ScannerListener` Instantiated as a scanner lease.

Field Summary

Fields
Modifier and Type	Field and Description
`private static long`	`DEFAULT_REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA` Default value of `REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA`
`(package private) InetSocketAddress`	`isa`
`protected static org.apache.commons.logging.Log`	`LOG`
`private long`	`maxScannerResultSize`
`private long`	`minimumScanTimeLimitDelta` The minimum allowable delta to use for the scan limit
`private PriorityFunction`	`priority`
`private static String`	`REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA` Minimum allowable time limit delta (in milliseconds) that can be enforced during scans.
`static String`	`REGION_SERVER_RPC_SCHEDULER_FACTORY_CLASS` RPC scheduler to use for the region server.
`private HRegionServer`	`regionServer`
`(package private) Counter`	`requestCount`
`(package private) RpcServerInterface`	`rpcServer`
`private int`	`rpcTimeout` The RPC timeout period (milliseconds)
`private ScannerIdGenerator`	`scannerIdGenerator`
`private int`	`scannerLeaseTimeoutPeriod` The lease timeout period for client scanners (milliseconds).
`private ConcurrentHashMap<String,RSRpcServices.RegionScannerHolder>`	`scanners`

Constructor Summary

Constructors
Constructor and Description

RSRpcServices(HRegionServer rs)

Constructors
Constructor and Description
`RSRpcServices(HRegionServer rs)`

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`addResult(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutateResponse.Builder builder, Result result, PayloadCarryingRpcController rpcc)`
`private void`	`addResults(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanResponse.Builder builder, List<Result> results, com.google.protobuf.RpcController controller, boolean isDefaultRegion)`
`(package private) long`	`addScanner(RegionScanner s, Region r)`
`(package private) Object`	`addSize(RpcCallContext context, Result r, Object lastBlock)` Method to account for the size of retained cells and retained data blocks.
`private Result`	`append(Region region, OperationQuota quota, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto m, CellScanner cellScanner, long nonceGroup)` Execute an append mutation.
`org.apache.hadoop.hbase.protobuf.generated.ClientProtos.BulkLoadHFileResponse`	`bulkLoadHFile(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.BulkLoadHFileRequest request)` Atomically bulk load several HFiles into an open region
`private boolean`	`checkAndRowMutate(Region region, List<org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action> actions, CellScanner cellScanner, byte[] row, byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, ByteArrayComparable comparator)` Mutate a list of rows atomically.
`boolean`	`checkOOME(Throwable e)` Take actions on the event of an OutOfMemoryError.
`protected void`	`checkOpen()` Called to verify that this server is up and running.
`private void`	`closeAllScanners()`
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.CloseRegionResponse`	`closeRegion(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.CloseRegionRequest request)` Close a region on the region server.
`private boolean`	`closeScanner(Region region, RegionScanner scanner, String scannerName)`
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.CompactRegionResponse`	`compactRegion(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.CompactRegionRequest request)` Compact a region on the region server.
`protected PriorityFunction`	`createPriority()`
`private void`	`doBatchOp(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionActionResult.Builder builder, Region region, OperationQuota quota, List<org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action> mutations, CellScanner cells)` Execute a list of Put/Delete mutations.
`private List<CellScannable>`	`doNonAtomicRegionMutation(Region region, OperationQuota quota, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionAction actions, CellScanner cellScanner, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionActionResult.Builder builder, List<CellScannable> cellsToReturn, long nonceGroup)` Run through the regionMutation `rm` and per Mutation, do the work, and then when done, add an instance of a `ClientProtos.ResultOrException` that corresponds to each Mutation.
`private OperationStatus[]`	`doReplayBatchOp(Region region, List<WALSplitter.MutationReplay> mutations, long replaySeqId)` Execute a list of Put/Delete mutations.
`private void`	`endNonceOperation(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto mutation, long nonceGroup, boolean success)` Ends nonce operation for a mutation, if needed.
`org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceResponse`	`execRegionServerService(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceRequest request)`
`org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceResponse`	`execService(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceRequest request)`
`private com.google.protobuf.Message`	`execServiceOnRegion(Region region, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceCall serviceCall)`
`static boolean`	`exitIfOOME(Throwable e)`
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.FlushRegionResponse`	`flushRegion(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.FlushRegionRequest request)` Flush a region on the region server.
`org.apache.hadoop.hbase.protobuf.generated.ClientProtos.GetResponse`	`get(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.GetRequest request)` Get data from a table.
`org.apache.hadoop.conf.Configuration`	`getConfiguration()`
`long`	`getDeadline(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header, com.google.protobuf.Message param)` Returns the deadline of the specified request.
`static String`	`getHostname(org.apache.hadoop.conf.Configuration conf, boolean isMaster)`
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetOnlineRegionResponse`	`getOnlineRegion(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetOnlineRegionRequest request)`
`PriorityFunction`	`getPriority()`
`int`	`getPriority(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header, com.google.protobuf.Message param, User user)` Returns the 'priority type' of the specified request.
`private RegionServerQuotaManager`	`getQuotaManager()`
`(package private) Region`	`getRegion(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.RegionSpecifier regionSpecifier)` Find the HRegion based on a region specifier
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse`	`getRegionInfo(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoRequest request)`
`private static org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException`	`getResultOrException(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Result r, int index, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionLoadStats stats)`
`private static org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException`	`getResultOrException(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException.Builder builder, int index)`
`private static org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException`	`getResultOrException(Exception e, int index)`
`String`	`getScanDetailsWithId(long scannerId)`
`(package private) RegionScanner`	`getScanner(long scannerId)`
`(package private) long`	`getScannerVirtualTime(long scannerId)` Get the vtime associated with the scanner.
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetServerInfoResponse`	`getServerInfo(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetServerInfoRequest request)` Get some information of the region server.
`protected List<RpcServer.BlockingServiceAndInterface>`	`getServices()`
`InetSocketAddress`	`getSocketAddress()`
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetStoreFileResponse`	`getStoreFile(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetStoreFileRequest request)`
`(package private) WAL`	`getWAL(Region region)`
`private Result`	`increment(Region region, OperationQuota quota, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto mutation, CellScanner cells, long nonceGroup)` Execute an increment mutation.
`private boolean`	`isClientCellBlockSupport()`
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.MergeRegionsResponse`	`mergeRegions(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.MergeRegionsRequest request)` Merge regions on the region server.
`org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MultiResponse`	`multi(com.google.protobuf.RpcController rpcc, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MultiRequest request)` Execute multiple actions on a table: get, mutate, and/or execCoprocessor
`org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutateResponse`	`mutate(com.google.protobuf.RpcController rpcc, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutateRequest request)` Mutate data in a table.
`private org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionLoadStats`	`mutateRows(Region region, List<org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action> actions, CellScanner cellScanner)` Mutate a list of rows atomically.
`void`	`onConfigurationChange(org.apache.hadoop.conf.Configuration newConf)` This method would be called by the `ConfigurationManager` object when the `Configuration` object is reloaded from disk.
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.OpenRegionResponse`	`openRegion(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.OpenRegionRequest request)` Open asynchronously a region or a set of regions on the region server.
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.ReplicateWALEntryResponse`	`replay(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.ReplicateWALEntryRequest request)` Replay the given changes when distributedLogReplay WAL edits from a failed RS.
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.ReplicateWALEntryResponse`	`replicateWALEntry(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.ReplicateWALEntryRequest request)` Replicate WAL entries on the region server.
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.RollWALWriterResponse`	`rollWALWriter(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.RollWALWriterRequest request)` Roll the WAL writer of the region server.
`org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanResponse`	`scan(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanRequest request)` Scan data in a table.
`private void`	`skipCellsForMutation(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action action, CellScanner cellScanner)`
`private void`	`skipCellsForMutations(List<org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action> actions, CellScanner cellScanner)`
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.SplitRegionResponse`	`splitRegion(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.SplitRegionRequest request)` Split a region on the region server.
`(package private) void`	`start()`
`private long`	`startNonceOperation(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto mutation, long nonceGroup)` Starts the nonce operation for a mutation, if needed.
`(package private) void`	`stop()`
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.StopServerResponse`	`stopServer(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.StopServerRequest request)` Stop the region server.
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.UpdateConfigurationResponse`	`updateConfiguration(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.UpdateConfigurationRequest request)`
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.UpdateFavoredNodesResponse`	`updateFavoredNodes(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.UpdateFavoredNodesRequest request)`
`org.apache.hadoop.hbase.protobuf.generated.AdminProtos.WarmupRegionResponse`	`warmupRegion(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.WarmupRegionRequest request)` Wamrmup a region on this server.

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

Field Detail
- LOG
```
protected static final org.apache.commons.logging.Log LOG
```
- REGION_SERVER_RPC_SCHEDULER_FACTORY_CLASS
```
public static final String REGION_SERVER_RPC_SCHEDULER_FACTORY_CLASS
```
  RPC scheduler to use for the region server.
  
  See Also:
  Constant Field Values
- REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA
```
private static final String REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA
```
  Minimum allowable time limit delta (in milliseconds) that can be enforced during scans. This configuration exists to prevent the scenario where a time limit is specified to be so restrictive that the time limit is reached immediately (before any cells are scanned).
  
  See Also:
  Constant Field Values
- DEFAULT_REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA
```
private static final long DEFAULT_REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA
```
  Default value of REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA
  
  See Also:
  Constant Field Values
- requestCount
```
final Counter requestCount
```
- rpcServer
```
final RpcServerInterface rpcServer
```
- isa
```
final InetSocketAddress isa
```
- regionServer
```
private final HRegionServer regionServer
```
- maxScannerResultSize
```
private final long maxScannerResultSize
```
- priority
```
private final PriorityFunction priority
```
- scannerIdGenerator
```
private ScannerIdGenerator scannerIdGenerator
```
- scanners
```
private final ConcurrentHashMap<String,RSRpcServices.RegionScannerHolder> scanners
```
- scannerLeaseTimeoutPeriod
```
private final int scannerLeaseTimeoutPeriod
```
  The lease timeout period for client scanners (milliseconds).
- rpcTimeout
```
private final int rpcTimeout
```
  The RPC timeout period (milliseconds)
- minimumScanTimeLimitDelta
```
private final long minimumScanTimeLimitDelta
```
  The minimum allowable delta to use for the scan limit

Constructor Detail

RSRpcServices

public RSRpcServices(HRegionServer rs)
              throws IOException

Throws:: IOException

Method Detail

getResultOrException

private static org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException getResultOrException(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Result r,
                                                                                             int index,
                                                                                             org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionLoadStats stats)

getResultOrException

private static org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException getResultOrException(Exception e,
                                                                                             int index)

getResultOrException

private static org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException getResultOrException(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException.Builder builder,
                                                                                             int index)

startNonceOperation

private long startNonceOperation(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto mutation,
                       long nonceGroup)
                          throws IOException,
                                 OperationConflictException

Starts the nonce operation for a mutation, if needed.

Parameters:: mutation - Mutation.; nonceGroup - Nonce group from the request.
Throws:: IOException; OperationConflictException

endNonceOperation
```
private void endNonceOperation(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto mutation,
                     long nonceGroup,
                     boolean success)
```
Ends nonce operation for a mutation, if needed.

Parameters:
mutation - Mutation.
nonceGroup - Nonce group from the request. Always 0 in initial implementation.
success - Whether the operation for this nonce has succeeded.

isClientCellBlockSupport
```
private boolean isClientCellBlockSupport()
```
Returns:
True if current call supports cellblocks

addResult

private void addResult(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutateResponse.Builder builder,
             Result result,
             PayloadCarryingRpcController rpcc)

addResults

private void addResults(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanResponse.Builder builder,
              List<Result> results,
              com.google.protobuf.RpcController controller,
              boolean isDefaultRegion)

mutateRows

private org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionLoadStats mutateRows(Region region,
                                                                                 List<org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action> actions,
                                                                                 CellScanner cellScanner)
                                                                                    throws IOException

Mutate a list of rows atomically.

Parameters:: region -; actions -; cellScanner - if non-null, the mutation data -- the Cell content.
Throws:: IOException

checkAndRowMutate

private boolean checkAndRowMutate(Region region,
                        List<org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action> actions,
                        CellScanner cellScanner,
                        byte[] row,
                        byte[] family,
                        byte[] qualifier,
                        CompareFilter.CompareOp compareOp,
                        ByteArrayComparable comparator)
                           throws IOException

Mutate a list of rows atomically.

Parameters:: region -; actions -; cellScanner - if non-null, the mutation data -- the Cell content.; row -; family -; qualifier -; compareOp -; comparator - @throws IOException
Throws:: IOException

append

private Result append(Region region,
            OperationQuota quota,
            org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto m,
            CellScanner cellScanner,
            long nonceGroup)
               throws IOException

Execute an append mutation.

Parameters:: region -; m -; cellScanner -
Returns:: result to return to client if default operation should be bypassed as indicated by RegionObserver, null otherwise
Throws:: IOException

increment

private Result increment(Region region,
               OperationQuota quota,
               org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto mutation,
               CellScanner cells,
               long nonceGroup)
                  throws IOException

Execute an increment mutation.

Parameters:: region -; mutation -
Returns:: the Result
Throws:: IOException

doNonAtomicRegionMutation

private List<CellScannable> doNonAtomicRegionMutation(Region region,
                                            OperationQuota quota,
                                            org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionAction actions,
                                            CellScanner cellScanner,
                                            org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionActionResult.Builder builder,
                                            List<CellScannable> cellsToReturn,
                                            long nonceGroup)

Run through the regionMutation rm and per Mutation, do the work, and then when done, add an instance of a ClientProtos.ResultOrException that corresponds to each Mutation.

Parameters:: region -; actions -; cellScanner -; builder -; cellsToReturn - Could be null. May be allocated in this method. This is what this method returns as a 'result'.
Returns:: Return the cellScanner passed

doBatchOp

private void doBatchOp(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionActionResult.Builder builder,
             Region region,
             OperationQuota quota,
             List<org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action> mutations,
             CellScanner cells)

Execute a list of Put/Delete mutations.

Parameters:: builder -; region -; mutations -

doReplayBatchOp
```
private OperationStatus[] doReplayBatchOp(Region region,
                                List<WALSplitter.MutationReplay> mutations,
                                long replaySeqId)
                                   throws IOException
```
Execute a list of Put/Delete mutations. The function returns OperationStatus instead of constructing MultiResponse to save a possible loop if caller doesn't need MultiResponse.

Parameters:
region -
mutations -
replaySeqId -

Returns:
an array of OperationStatus which internally contains the OperationStatusCode and the exceptionMessage if any

Throws:

IOException

closeAllScanners
```
private void closeAllScanners()
```

onConfigurationChange
```
public void onConfigurationChange(org.apache.hadoop.conf.Configuration newConf)
```
Description copied from interface: ConfigurationObserver

This method would be called by the ConfigurationManager object when the Configuration object is reloaded from disk.

Specified by:

onConfigurationChange in interface ConfigurationObserver

createPriority

protected PriorityFunction createPriority()

getHostname

public static String getHostname(org.apache.hadoop.conf.Configuration conf,
                 boolean isMaster)
                          throws UnknownHostException

Throws:: UnknownHostException

getScanner

RegionScanner getScanner(long scannerId)

getScanDetailsWithId

public String getScanDetailsWithId(long scannerId)

getScannerVirtualTime
```
long getScannerVirtualTime(long scannerId)
```
Get the vtime associated with the scanner. Currently the vtime is the number of "next" calls.

addScanner

long addScanner(RegionScanner s,
              Region r)
          throws Leases.LeaseStillHeldException

Throws:: Leases.LeaseStillHeldException

addSize
```
Object addSize(RpcCallContext context,
             Result r,
             Object lastBlock)
```
Method to account for the size of retained cells and retained data blocks.

Returns:
an object that represents the last referenced block from this response.

getRegion
```
Region getRegion(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.RegionSpecifier regionSpecifier)
           throws IOException
```
Find the HRegion based on a region specifier

Parameters:
regionSpecifier - the region specifier

Returns:
the corresponding region

Throws:

IOException - if the specifier is not null, but failed to find the region

getPriority
```
public PriorityFunction getPriority()
```

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

getQuotaManager

private RegionServerQuotaManager getQuotaManager()

start
```
void start()
```

stop
```
void stop()
```

checkOpen
```
protected void checkOpen()
                  throws IOException
```
Called to verify that this server is up and running.

Throws:

IOException

getServices
```
protected List<RpcServer.BlockingServiceAndInterface> getServices()
```
Returns:
list of blocking services and their security info classes that this server supports

getSocketAddress

public InetSocketAddress getSocketAddress()

getPriority
```
public int getPriority(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header,
              com.google.protobuf.Message param,
              User user)
```
Description copied from interface: PriorityFunction

Returns the 'priority type' of the specified request. The returned value is mainly used to select the dispatch queue.

Specified by:

getPriority in interface PriorityFunction

Returns:
Priority of this request.

getDeadline
```
public long getDeadline(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header,
               com.google.protobuf.Message param)
```
Description copied from interface: PriorityFunction

Returns the deadline of the specified request. The returned value is used to sort the dispatch queue.

Specified by:

getDeadline in interface PriorityFunction

Returns:
Deadline of this request. 0 now, otherwise msec of 'delay'

checkOOME
```
public boolean checkOOME(Throwable e)
```
Description copied from interface: HBaseRPCErrorHandler

Take actions on the event of an OutOfMemoryError.

Specified by:

checkOOME in interface HBaseRPCErrorHandler

Parameters:
e - the throwable

Returns:
if the server should be shut down

exitIfOOME

public static boolean exitIfOOME(Throwable e)

closeRegion

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.CloseRegionResponse closeRegion(com.google.protobuf.RpcController controller,
                                                                                     org.apache.hadoop.hbase.protobuf.generated.AdminProtos.CloseRegionRequest request)
                                                                                       throws com.google.protobuf.ServiceException

Close a region on the region server.

Specified by:: closeRegion in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Parameters:: controller - the RPC controller; request - the request
Throws:: com.google.protobuf.ServiceException

compactRegion

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.CompactRegionResponse compactRegion(com.google.protobuf.RpcController controller,
                                                                                         org.apache.hadoop.hbase.protobuf.generated.AdminProtos.CompactRegionRequest request)
                                                                                           throws com.google.protobuf.ServiceException

Compact a region on the region server.

Specified by:: compactRegion in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Parameters:: controller - the RPC controller; request - the request
Throws:: com.google.protobuf.ServiceException

flushRegion

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.FlushRegionResponse flushRegion(com.google.protobuf.RpcController controller,
                                                                                     org.apache.hadoop.hbase.protobuf.generated.AdminProtos.FlushRegionRequest request)
                                                                                       throws com.google.protobuf.ServiceException

Flush a region on the region server.

Specified by:: flushRegion in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Parameters:: controller - the RPC controller; request - the request
Throws:: com.google.protobuf.ServiceException

getOnlineRegion

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetOnlineRegionResponse getOnlineRegion(com.google.protobuf.RpcController controller,
                                                                                             org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetOnlineRegionRequest request)
                                                                                               throws com.google.protobuf.ServiceException

Specified by:: getOnlineRegion in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Throws:: com.google.protobuf.ServiceException

getRegionInfo

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse getRegionInfo(com.google.protobuf.RpcController controller,
                                                                                         org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoRequest request)
                                                                                           throws com.google.protobuf.ServiceException

Specified by:: getRegionInfo in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Throws:: com.google.protobuf.ServiceException

getServerInfo

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetServerInfoResponse getServerInfo(com.google.protobuf.RpcController controller,
                                                                                         org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetServerInfoRequest request)
                                                                                           throws com.google.protobuf.ServiceException

Get some information of the region server.

Specified by:: getServerInfo in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Parameters:: controller - the RPC controller; request - the request
Throws:: com.google.protobuf.ServiceException

getStoreFile

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetStoreFileResponse getStoreFile(com.google.protobuf.RpcController controller,
                                                                                       org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetStoreFileRequest request)
                                                                                         throws com.google.protobuf.ServiceException

Specified by:: getStoreFile in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Throws:: com.google.protobuf.ServiceException

mergeRegions

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.MergeRegionsResponse mergeRegions(com.google.protobuf.RpcController controller,
                                                                                       org.apache.hadoop.hbase.protobuf.generated.AdminProtos.MergeRegionsRequest request)
                                                                                         throws com.google.protobuf.ServiceException

Merge regions on the region server.

Specified by:: mergeRegions in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Parameters:: controller - the RPC controller; request - the request
Returns:: merge regions response
Throws:: com.google.protobuf.ServiceException

openRegion
```
public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.OpenRegionResponse openRegion(com.google.protobuf.RpcController controller,
                                                                                   org.apache.hadoop.hbase.protobuf.generated.AdminProtos.OpenRegionRequest request)
                                                                                     throws com.google.protobuf.ServiceException
```
Open asynchronously a region or a set of regions on the region server. The opening is coordinated by ZooKeeper, and this method requires the znode to be created before being called. As a consequence, this method should be called only from the master.
Different manages states for the region are:
- region not opened: the region opening will start asynchronously.
- a close is already in progress: this is considered as an error.
- an open is already in progress: this new open request will be ignored. This is important because the Master can do multiple requests if it crashes.
- the region is already opened: this new open request will be ignored.
Bulk assign: If there are more than 1 region to open, it will be considered as a bulk assign. For a single region opening, errors are sent through a ServiceException. For bulk assign, errors are put in the response as FAILED_OPENING.
Specified by:

openRegion in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface

Parameters:
controller - the RPC controller
request - the request

Throws:

com.google.protobuf.ServiceException

warmupRegion

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.WarmupRegionResponse warmupRegion(com.google.protobuf.RpcController controller,
                                                                                       org.apache.hadoop.hbase.protobuf.generated.AdminProtos.WarmupRegionRequest request)
                                                                                         throws com.google.protobuf.ServiceException

Wamrmup a region on this server. This method should only be called by Master. It synchrnously opens the region and closes the region bringing the most important pages in cache.

Specified by:: warmupRegion in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Parameters:: controller - the RPC controller; request - the request
Throws:: com.google.protobuf.ServiceException

replay

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.ReplicateWALEntryResponse replay(com.google.protobuf.RpcController controller,
                                                                                      org.apache.hadoop.hbase.protobuf.generated.AdminProtos.ReplicateWALEntryRequest request)
                                                                                        throws com.google.protobuf.ServiceException

Replay the given changes when distributedLogReplay WAL edits from a failed RS. The guarantee is that the given mutations will be durable on the receiving RS if this method returns without any exception.

Specified by:: replay in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Parameters:: controller - the RPC controller; request - the request
Throws:: com.google.protobuf.ServiceException

getWAL
```
WAL getWAL(Region region)
```

replicateWALEntry

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.ReplicateWALEntryResponse replicateWALEntry(com.google.protobuf.RpcController controller,
                                                                                                 org.apache.hadoop.hbase.protobuf.generated.AdminProtos.ReplicateWALEntryRequest request)
                                                                                                   throws com.google.protobuf.ServiceException

Replicate WAL entries on the region server.

Specified by:: replicateWALEntry in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Parameters:: controller - the RPC controller; request - the request
Throws:: com.google.protobuf.ServiceException

rollWALWriter

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.RollWALWriterResponse rollWALWriter(com.google.protobuf.RpcController controller,
                                                                                         org.apache.hadoop.hbase.protobuf.generated.AdminProtos.RollWALWriterRequest request)
                                                                                           throws com.google.protobuf.ServiceException

Roll the WAL writer of the region server.

Specified by:: rollWALWriter in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Parameters:: controller - the RPC controller; request - the request
Throws:: com.google.protobuf.ServiceException

splitRegion

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.SplitRegionResponse splitRegion(com.google.protobuf.RpcController controller,
                                                                                     org.apache.hadoop.hbase.protobuf.generated.AdminProtos.SplitRegionRequest request)
                                                                                       throws com.google.protobuf.ServiceException

Split a region on the region server.

Specified by:: splitRegion in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Parameters:: controller - the RPC controller; request - the request
Throws:: com.google.protobuf.ServiceException

stopServer

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.StopServerResponse stopServer(com.google.protobuf.RpcController controller,
                                                                                   org.apache.hadoop.hbase.protobuf.generated.AdminProtos.StopServerRequest request)
                                                                                     throws com.google.protobuf.ServiceException

Stop the region server.

Specified by:: stopServer in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Parameters:: controller - the RPC controller; request - the request
Throws:: com.google.protobuf.ServiceException

updateFavoredNodes

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.UpdateFavoredNodesResponse updateFavoredNodes(com.google.protobuf.RpcController controller,
                                                                                                   org.apache.hadoop.hbase.protobuf.generated.AdminProtos.UpdateFavoredNodesRequest request)
                                                                                                     throws com.google.protobuf.ServiceException

Specified by:: updateFavoredNodes in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Throws:: com.google.protobuf.ServiceException

bulkLoadHFile

public org.apache.hadoop.hbase.protobuf.generated.ClientProtos.BulkLoadHFileResponse bulkLoadHFile(com.google.protobuf.RpcController controller,
                                                                                          org.apache.hadoop.hbase.protobuf.generated.ClientProtos.BulkLoadHFileRequest request)
                                                                                            throws com.google.protobuf.ServiceException

Atomically bulk load several HFiles into an open region

Specified by:: bulkLoadHFile in interface org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface
Returns:: true if successful, false is failed but recoverably (no action)
Throws:: com.google.protobuf.ServiceException - if failed unrecoverably

execService

public org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceResponse execService(com.google.protobuf.RpcController controller,
                                                                                             org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceRequest request)
                                                                                               throws com.google.protobuf.ServiceException

Specified by:: execService in interface org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface
Throws:: com.google.protobuf.ServiceException

execServiceOnRegion

private com.google.protobuf.Message execServiceOnRegion(Region region,
                                              org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceCall serviceCall)
                                                 throws IOException

Throws:: IOException

get

public org.apache.hadoop.hbase.protobuf.generated.ClientProtos.GetResponse get(com.google.protobuf.RpcController controller,
                                                                      org.apache.hadoop.hbase.protobuf.generated.ClientProtos.GetRequest request)
                                                                        throws com.google.protobuf.ServiceException

Get data from a table.

Specified by:: get in interface org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface
Parameters:: controller - the RPC controller; request - the get request
Throws:: com.google.protobuf.ServiceException

multi

public org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MultiResponse multi(com.google.protobuf.RpcController rpcc,
                                                                          org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MultiRequest request)
                                                                            throws com.google.protobuf.ServiceException

Execute multiple actions on a table: get, mutate, and/or execCoprocessor

Specified by:: multi in interface org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface
Parameters:: rpcc - the RPC controller; request - the multi request
Throws:: com.google.protobuf.ServiceException

skipCellsForMutations

private void skipCellsForMutations(List<org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action> actions,
                         CellScanner cellScanner)

skipCellsForMutation

private void skipCellsForMutation(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Action action,
                        CellScanner cellScanner)

mutate

public org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutateResponse mutate(com.google.protobuf.RpcController rpcc,
                                                                            org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutateRequest request)
                                                                              throws com.google.protobuf.ServiceException

Mutate data in a table.

Specified by:: mutate in interface org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface
Parameters:: rpcc - the RPC controller; request - the mutate request
Throws:: com.google.protobuf.ServiceException

scan

public org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanResponse scan(com.google.protobuf.RpcController controller,
                                                                        org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanRequest request)
                                                                          throws com.google.protobuf.ServiceException

Scan data in a table.

Specified by:: scan in interface org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface
Parameters:: controller - the RPC controller; request - the scan request
Throws:: com.google.protobuf.ServiceException

closeScanner

private boolean closeScanner(Region region,
                   RegionScanner scanner,
                   String scannerName)
                      throws IOException

Throws:: IOException

execRegionServerService

public org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceResponse execRegionServerService(com.google.protobuf.RpcController controller,
                                                                                                         org.apache.hadoop.hbase.protobuf.generated.ClientProtos.CoprocessorServiceRequest request)
                                                                                                           throws com.google.protobuf.ServiceException

Specified by:: execRegionServerService in interface org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface
Throws:: com.google.protobuf.ServiceException

updateConfiguration

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.UpdateConfigurationResponse updateConfiguration(com.google.protobuf.RpcController controller,
                                                                                                     org.apache.hadoop.hbase.protobuf.generated.AdminProtos.UpdateConfigurationRequest request)
                                                                                                       throws com.google.protobuf.ServiceException

Specified by:: updateConfiguration in interface org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface
Throws:: com.google.protobuf.ServiceException

Class RSRpcServices

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

REGION_SERVER_RPC_SCHEDULER_FACTORY_CLASS

REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA

DEFAULT_REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA

requestCount

rpcServer

isa

regionServer

maxScannerResultSize

priority

scannerIdGenerator

scanners

scannerLeaseTimeoutPeriod

rpcTimeout

minimumScanTimeLimitDelta

Constructor Detail

RSRpcServices

Method Detail

getResultOrException

getResultOrException

getResultOrException

startNonceOperation

endNonceOperation

isClientCellBlockSupport

addResult

addResults

mutateRows

checkAndRowMutate

append

increment

doNonAtomicRegionMutation

doBatchOp

doReplayBatchOp

closeAllScanners

onConfigurationChange

createPriority

getHostname

getScanner

getScanDetailsWithId

getScannerVirtualTime

addScanner

addSize

getRegion

getPriority

getConfiguration

getQuotaManager

start

stop

checkOpen

getServices

getSocketAddress

getPriority

getDeadline

checkOOME

exitIfOOME

closeRegion

compactRegion

flushRegion

getOnlineRegion

getRegionInfo

getServerInfo

getStoreFile

mergeRegions

openRegion

warmupRegion

replay

getWAL

replicateWALEntry

rollWALWriter

splitRegion

stopServer

updateFavoredNodes

bulkLoadHFile