MonitoredRPCHandlerImpl (Apache HBase

java.lang.Object
- org.apache.hadoop.hbase.monitoring.MonitoredRPCHandlerImpl

所有已实现的接口:

Cloneable, MonitoredRPCHandler, MonitoredTask
```
@InterfaceAudience.Private
public class MonitoredRPCHandlerImpl
extends Object
implements MonitoredRPCHandler
```
A MonitoredTask implementation designed for use with RPC Handlers handling frequent, short duration tasks. String concatenations and object allocations are avoided in methods that will be hit by every RPC call.

嵌套类概要
- 从接口继承的嵌套类/接口 org.apache.hadoop.hbase.monitoring.MonitoredTask
  MonitoredTask.State, MonitoredTask.StatusJournalEntry

字段概要

字段
限定符和类型字段和说明

protected MonitoredTask.State state

字段
限定符和类型	字段和说明
`protected MonitoredTask.State`	`state`

构造器概要

构造器
构造器和说明

MonitoredRPCHandlerImpl()

构造器
构造器和说明
`MonitoredRPCHandlerImpl()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`abort(String msg)`
`void`	`cleanup()` Explicitly mark this status as able to be cleaned up, even though it might not be complete.
`MonitoredRPCHandlerImpl`	`clone()` Public exposure of Object.clone() in order to allow clients to easily capture current state.
`void`	`disableStatusJournal()`
`void`	`enableStatusJournal(boolean includeCurrentStatus)` Enables journaling of this monitored task, the first invocation will lazily initialize the journal.
`void`	`expireNow()` Force the completion timestamp backwards so that it expires now.
`String`	`getClient()` If an RPC call is currently running, produces a String representation of the connection from which it was received.
`long`	`getCompletionTimestamp()`
`String`	`getDescription()`
`String`	`getRPC()` Produces a string representation of the method currently being serviced by this Handler.
`String`	`getRPC(boolean withParams)` Produces a string representation of the method currently being serviced by this Handler.
`long`	`getRPCPacketLength()` Produces a string representation of the method currently being serviced by this Handler.
`long`	`getRPCQueueTime()` Accesses the queue time for the currently running RPC on the monitored Handler.
`long`	`getRPCStartTime()` Accesses the start time for the currently running RPC on the monitored Handler.
`long`	`getStartTime()`
`MonitoredTask.State`	`getState()`
`long`	`getStateTime()`
`String`	`getStatus()` Gets the status of this handler; if it is currently servicing an RPC, this status will include the RPC information.
`List<MonitoredTask.StatusJournalEntry>`	`getStatusJournal()` Returns the status journal.
`long`	`getStatusTime()`
`long`	`getWarnTime()`
`boolean`	`isOperationRunning()` Indicates to the client whether this task is monitoring a currently active RPC call to a database command.
`boolean`	`isRPCRunning()` Indicates to the client whether this task is monitoring a currently active RPC call.
`void`	`markComplete(String status)`
`void`	`pause(String msg)`
`String`	`prettyPrintJournal()`
`void`	`resume(String msg)`
`void`	`setConnection(String clientAddress, int remotePort)` Registers current handler client details.
`void`	`setDescription(String description)`
`void`	`setRPC(String methodName, Object[] params, long queueTime)` Tells this instance that it is monitoring a new RPC call.
`void`	`setRPCPacket(org.apache.hbase.thirdparty.com.google.protobuf.Message param)` Gives this instance a reference to the protobuf received by the RPC, so that it can later compute its size if asked for it.
`protected void`	`setState(MonitoredTask.State state)`
`void`	`setStatus(String status)`
`void`	`setWarnTime(long t)`
`String`	`toJSON()` Creates a JSON object for parseable exposure of monitored tasks.
`Map<String,Object>`	`toMap()` Creates a string map of internal details for extensible exposure of monitored tasks.
`String`	`toString()`

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

从接口继承的方法 org.apache.hadoop.hbase.monitoring.MonitoredTask
abort, cleanup, disableStatusJournal, enableStatusJournal, expireNow, getCompletionTimestamp, getDescription, getStartTime, getState, getStateTime, getStatusJournal, getStatusTime, getWarnTime, pause, prettyPrintJournal, resume, setDescription, setStatus, setWarnTime, toJSON

- 字段详细资料
  - state
```
protected volatile MonitoredTask.State state
```
- 构造器详细资料
  - MonitoredRPCHandlerImpl
```
public MonitoredRPCHandlerImpl()
```
- 方法详细资料
  - clone
```
public MonitoredRPCHandlerImpl clone()
```
    从接口复制的说明: MonitoredTask
    
    Public exposure of Object.clone() in order to allow clients to easily capture current state.
    
    指定者:
    
    clone 在接口中 MonitoredTask
    
    返回:
    
    a copy of the object whose references will not change
  - getStatus
```
public String getStatus()
```
    Gets the status of this handler; if it is currently servicing an RPC, this status will include the RPC information.
    
    指定者:
    
    getStatus 在接口中 MonitoredTask
    
    返回:
    
    a String describing the current status.
  - getRPCQueueTime
```
public long getRPCQueueTime()
```
    Accesses the queue time for the currently running RPC on the monitored Handler.
    
    指定者:
    
    getRPCQueueTime 在接口中 MonitoredRPCHandler
    
    返回:
    
    the queue timestamp or -1 if there is no RPC currently running.
  - getRPCStartTime
```
public long getRPCStartTime()
```
    Accesses the start time for the currently running RPC on the monitored Handler.
    
    指定者:
    
    getRPCStartTime 在接口中 MonitoredRPCHandler
    
    返回:
    
    the start timestamp or -1 if there is no RPC currently running.
  - getRPC
```
public String getRPC()
```
    Produces a string representation of the method currently being serviced by this Handler.
    
    指定者:
    
    getRPC 在接口中 MonitoredRPCHandler
    
    返回:
    
    a string representing the method call without parameters
  - getRPC
```
public String getRPC(boolean withParams)
```
    Produces a string representation of the method currently being serviced by this Handler.
    
    指定者:
    
    getRPC 在接口中 MonitoredRPCHandler
    
    参数:
    
    withParams - toggle inclusion of parameters in the RPC String
    
    返回:
    
    A human-readable string representation of the method call.
  - getRPCPacketLength
```
public long getRPCPacketLength()
```
    Produces a string representation of the method currently being serviced by this Handler.
    
    指定者:
    
    getRPCPacketLength 在接口中 MonitoredRPCHandler
    
    返回:
    
    A human-readable string representation of the method call.
  - getClient
```
public String getClient()
```
    If an RPC call is currently running, produces a String representation of the connection from which it was received.
    
    指定者:
    
    getClient 在接口中 MonitoredRPCHandler
    
    返回:
    
    A human-readable string representation of the address and port of the client.
  - isRPCRunning
```
public boolean isRPCRunning()
```
    Indicates to the client whether this task is monitoring a currently active RPC call.
    
    指定者:
    
    isRPCRunning 在接口中 MonitoredRPCHandler
    
    返回:
    
    true if the monitored handler is currently servicing an RPC call.
  - isOperationRunning
```
public boolean isOperationRunning()
```
    Indicates to the client whether this task is monitoring a currently active RPC call to a database command. (as defined by o.a.h.h.client.Operation)
    
    指定者:
    
    isOperationRunning 在接口中 MonitoredRPCHandler
    
    返回:
    
    true if the monitored handler is currently servicing an RPC call to a database command.
  - setRPC
```
public void setRPC(String methodName,
                   Object[] params,
                   long queueTime)
```
    Tells this instance that it is monitoring a new RPC call.
    
    指定者:
    
    setRPC 在接口中 MonitoredRPCHandler
    
    参数:
    
    methodName - The name of the method that will be called by the RPC.
    
    params - The parameters that will be passed to the indicated method.
  - setRPCPacket
```
public void setRPCPacket(org.apache.hbase.thirdparty.com.google.protobuf.Message param)
```
    Gives this instance a reference to the protobuf received by the RPC, so that it can later compute its size if asked for it.
    
    指定者:
    
    setRPCPacket 在接口中 MonitoredRPCHandler
    
    参数:
    
    param - The protobuf received by the RPC for this call
  - setConnection
```
public void setConnection(String clientAddress,
                          int remotePort)
```
    Registers current handler client details.
    
    指定者:
    
    setConnection 在接口中 MonitoredRPCHandler
    
    参数:
    
    clientAddress - the address of the current client
    
    remotePort - the port from which the client connected
  - markComplete
```
public void markComplete(String status)
```
    指定者:
    
    markComplete 在接口中 MonitoredTask
  - toMap
```
public Map<String,Object> toMap()
```
    从接口复制的说明: MonitoredTask
    
    Creates a string map of internal details for extensible exposure of monitored tasks.
    
    指定者:
    
    toMap 在接口中 MonitoredTask
    
    返回:
    
    A Map containing information for this task.
  - toString
```
public String toString()
```
  - getStartTime
```
public long getStartTime()
```
    指定者:
    
    getStartTime 在接口中 MonitoredTask
  - getDescription
```
public String getDescription()
```
    指定者:
    
    getDescription 在接口中 MonitoredTask
  - getStatusTime
```
public long getStatusTime()
```
    指定者:
    
    getStatusTime 在接口中 MonitoredTask
  - getState
```
public MonitoredTask.State getState()
```
    指定者:
    
    getState 在接口中 MonitoredTask
  - getStateTime
```
public long getStateTime()
```
    指定者:
    
    getStateTime 在接口中 MonitoredTask
  - getWarnTime
```
public long getWarnTime()
```
    指定者:
    
    getWarnTime 在接口中 MonitoredTask
  - getCompletionTimestamp
```
public long getCompletionTimestamp()
```
    指定者:
    
    getCompletionTimestamp 在接口中 MonitoredTask
  - pause
```
public void pause(String msg)
```
    指定者:
    
    pause 在接口中 MonitoredTask
  - resume
```
public void resume(String msg)
```
    指定者:
    
    resume 在接口中 MonitoredTask
  - abort
```
public void abort(String msg)
```
    指定者:
    
    abort 在接口中 MonitoredTask
  - setStatus
```
public void setStatus(String status)
```
    指定者:
    
    setStatus 在接口中 MonitoredTask
  - setState
```
protected void setState(MonitoredTask.State state)
```
  - setDescription
```
public void setDescription(String description)
```
    指定者:
    
    setDescription 在接口中 MonitoredTask
  - setWarnTime
```
public void setWarnTime(long t)
```
    指定者:
    
    setWarnTime 在接口中 MonitoredTask
  - cleanup
```
public void cleanup()
```
    从接口复制的说明: MonitoredTask
    
    Explicitly mark this status as able to be cleaned up, even though it might not be complete.
    
    指定者:
    
    cleanup 在接口中 MonitoredTask
  - expireNow
```
public void expireNow()
```
    Force the completion timestamp backwards so that it expires now.
    
    指定者:
    
    expireNow 在接口中 MonitoredTask
  - toJSON
```
public String toJSON()
              throws IOException
```
    从接口复制的说明: MonitoredTask
    
    Creates a JSON object for parseable exposure of monitored tasks.
    
    指定者:
    
    toJSON 在接口中 MonitoredTask
    
    返回:
    
    An encoded JSON object containing information for this task.
    
    抛出:
    
    IOException
  - getStatusJournal
```
public List<MonitoredTask.StatusJournalEntry> getStatusJournal()
```
    Returns the status journal. This implementation of status journal is not thread-safe. Currently we use this to track various stages of flushes and compactions where we can use this/pretty print for post task analysis, by which time we are already done changing states (writing to journal)
    
    指定者:
    
    getStatusJournal 在接口中 MonitoredTask
  - enableStatusJournal
```
public void enableStatusJournal(boolean includeCurrentStatus)
```
    Enables journaling of this monitored task, the first invocation will lazily initialize the journal. The journal implementation itself and this method are not thread safe
    
    指定者:
    
    enableStatusJournal 在接口中 MonitoredTask
    
    参数:
    
    includeCurrentStatus - whether to include the current set status in the journal
  - disableStatusJournal
```
public void disableStatusJournal()
```
    指定者:
    
    disableStatusJournal 在接口中 MonitoredTask
  - prettyPrintJournal
```
public String prettyPrintJournal()
```
    指定者:
    
    prettyPrintJournal 在接口中 MonitoredTask

类 MonitoredRPCHandlerImpl

嵌套类概要

从接口继承的嵌套类/接口 org.apache.hadoop.hbase.monitoring.MonitoredTask

字段概要

构造器概要

方法概要

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

从接口继承的方法 org.apache.hadoop.hbase.monitoring.MonitoredTask

字段详细资料

state

构造器详细资料

MonitoredRPCHandlerImpl

方法详细资料

clone

getStatus

getRPCQueueTime

getRPCStartTime

getRPC

getRPC

getRPCPacketLength

getClient

isRPCRunning

isOperationRunning

setRPC

setRPCPacket

setConnection

markComplete

toMap

toString

getStartTime

getDescription

getStatusTime

getState

getStateTime

getWarnTime

getCompletionTimestamp

pause

resume

abort

setStatus

setState

setDescription

setWarnTime

cleanup

expireNow

toJSON

getStatusJournal

enableStatusJournal

disableStatusJournal

prettyPrintJournal