org.apache.hadoop.hbase.ipc

Class NettyRpcServer

java.lang.Object

org.apache.hadoop.hbase.ipc.RpcServer

org.apache.hadoop.hbase.ipc.NettyRpcServer

All Implemented Interfaces:

ConfigurationObserver, RpcServerInterface

@InterfaceAudience.LimitedPrivate(value="Configuration")
public class NettyRpcServer
extends RpcServer

An RPC server with Netty4 implementation.

Since:

2.0.0

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.ipc.RpcServer

RpcServer.BlockingServiceAndInterface, RpcServer.CallCleanup

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANNEL_WRITABLE_FATAL_WATERMARK_KEY Fatal watermark for pending outbound bytes of a single netty channel.
static String	CHANNEL_WRITABLE_HIGH_WATERMARK_KEY High watermark for pending outbound bytes of a single netty channel.
static String	CHANNEL_WRITABLE_LOW_WATERMARK_KEY Low watermark for pending outbound bytes of a single netty channel.
static String	HBASE_NETTY_ALLOCATOR_KEY Name of property to change the byte buf allocator for the netty channels.
static org.slf4j.Logger	LOG

Fields inherited from class org.apache.hadoop.hbase.ipc.RpcServer

allowFallbackToSimpleAuth, AUDITLOG, AUTH_FAILED_FOR, AUTH_SUCCESSFUL_FOR, authManager, authTokenSecretMgr, bbAllocator, CALL_QUEUE_TOO_BIG_EXCEPTION, callQueueSizeInBytes, cellBlockBuilder, conf, CurCall, CURRENT_VERSION, DEFAULT_MAX_CALLQUEUE_LENGTH_PER_HANDLER, DEFAULT_MAX_CALLQUEUE_SIZE, DEFAULT_MAX_REQUEST_SIZE, DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT, DEFAULT_TRACE_LOG_MAX_LENGTH, DEFAULT_WARN_RESPONSE_SIZE, DEFAULT_WARN_RESPONSE_TIME, errorHandler, FALLBACK_TO_INSECURE_CLIENT_AUTH, GSON, isSecurityEnabled, KEY_WORD_TRUNCATED, MAX_REQUEST_SIZE, maxQueueSizeInBytes, maxRequestSize, metrics, MIN_CLIENT_REQUEST_TIMEOUT, minClientRequestTimeout, MONITORED_RPC, NIO_BUFFER_LIMIT, saslProps, scheduler, secretManager, server, serverPrincipal, services, tcpKeepAlive, tcpNoDelay, TRACE_LOG_MAX_LENGTH, userProvider, WARN_RESPONSE_SIZE, WARN_RESPONSE_TIME, WARN_SCAN_RESPONSE_SIZE, WARN_SCAN_RESPONSE_TIME, warnResponseSize, warnResponseTime, warnScanResponseSize, warnScanResponseTime

Constructor Summary

Constructors

Constructor and Description
NettyRpcServer(Server server, String name, List<RpcServer.BlockingServiceAndInterface> services, InetSocketAddress bindAddress, org.apache.hadoop.conf.Configuration conf, RpcScheduler scheduler, boolean reservoirEnabled)

Method Summary

Modifier and Type	Method and Description
Pair<org.apache.hbase.thirdparty.com.google.protobuf.Message,CellScanner>	call(org.apache.hbase.thirdparty.com.google.protobuf.BlockingService service, org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md, org.apache.hbase.thirdparty.com.google.protobuf.Message param, CellScanner cellScanner, long receiveTime, MonitoredRPCHandler status)
Pair<org.apache.hbase.thirdparty.com.google.protobuf.Message,CellScanner>	call(org.apache.hbase.thirdparty.com.google.protobuf.BlockingService service, org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md, org.apache.hbase.thirdparty.com.google.protobuf.Message param, CellScanner cellScanner, long receiveTime, MonitoredRPCHandler status, long startTime, int timeout)
protected org.apache.hadoop.hbase.ipc.NettyServerRpcConnection	createNettyServerRpcConnection(org.apache.hbase.thirdparty.io.netty.channel.Channel channel)
InetSocketAddress	getListenerAddress()
int	getNumOpenConnections() The number of open RPC conections
Pair<Long,Long>	getTotalAndMaxNettyOutboundBytes()
int	getWriteBufferFatalThreshold()
boolean	isWritabilityBackpressureEnabled()
void	join()
void	onConfigurationChange(org.apache.hadoop.conf.Configuration newConf)
void	setSocketSendBufSize(int size)
void	start()
void	stop()

Methods inherited from class org.apache.hadoop.hbase.ipc.RpcServer

addCallSize, authorize, call, channelRead, createSecretManager, getByteBuffAllocator, getCurrentCall, getErrorHandler, getMetrics, getRemoteAddress, getRemoteIp, getRequestUser, getRequestUserName, getScheduler, getSecretManager, getService, getServiceAndInterface, getServiceInterface, getServices, getStatus, initReconfigurable, isInRpcCallContext, isStarted, needAuthorization, refreshAuthManager, setCurrentCall, setErrorHandler, setNamedQueueRecorder, setRsRpcServices, setSecretManager, unsetCurrentCall

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

HBASE_NETTY_ALLOCATOR_KEY

public static final String HBASE_NETTY_ALLOCATOR_KEY

Name of property to change the byte buf allocator for the netty channels. Default is no value, which causes us to use PooledByteBufAllocator. Valid settings here are "pooled", "unpooled", and "heap", or, the name of a class implementing ByteBufAllocator.

"pooled" and "unpooled" may prefer direct memory depending on netty configuration, which is controlled by platform specific code and documented system properties.

"heap" will prefer heap arena allocations.

See Also:

Constant Field Values

CHANNEL_WRITABLE_LOW_WATERMARK_KEY

public static final String CHANNEL_WRITABLE_LOW_WATERMARK_KEY

Low watermark for pending outbound bytes of a single netty channel. If the high watermark was exceeded, channel will have setAutoRead to true again. The server will start reading incoming bytes (requests) from the client channel.

See Also:

Constant Field Values

CHANNEL_WRITABLE_HIGH_WATERMARK_KEY

public static final String CHANNEL_WRITABLE_HIGH_WATERMARK_KEY

High watermark for pending outbound bytes of a single netty channel. If the number of pending outbound bytes exceeds this threshold, setAutoRead will be false for the channel. The server will stop reading incoming requests from the client channel.

Note: any requests already in the call queue will still be processed.

See Also:

Constant Field Values

CHANNEL_WRITABLE_FATAL_WATERMARK_KEY

public static final String CHANNEL_WRITABLE_FATAL_WATERMARK_KEY

Fatal watermark for pending outbound bytes of a single netty channel. If the number of pending outbound bytes exceeds this threshold, the connection will be forcibly closed so that memory can be reclaimed. The client will have to re-establish a new connection and retry any in-flight requests.

Note: must be higher than the high watermark, otherwise it's ignored.

See Also:

Constant Field Values

Constructor Detail

NettyRpcServer

public NettyRpcServer(Server server,
                      String name,
                      List<RpcServer.BlockingServiceAndInterface> services,
                      InetSocketAddress bindAddress,
                      org.apache.hadoop.conf.Configuration conf,
                      RpcScheduler scheduler,
                      boolean reservoirEnabled)
               throws IOException

Throws:

IOException

Method Detail

onConfigurationChange

public void onConfigurationChange(org.apache.hadoop.conf.Configuration newConf)

Specified by:

onConfigurationChange in interface ConfigurationObserver

Overrides:

onConfigurationChange in class RpcServer

isWritabilityBackpressureEnabled

public boolean isWritabilityBackpressureEnabled()

createNettyServerRpcConnection

@InterfaceAudience.Private
protected org.apache.hadoop.hbase.ipc.NettyServerRpcConnection createNettyServerRpcConnection(org.apache.hbase.thirdparty.io.netty.channel.Channel channel)

start

public void start()

stop

public void stop()

join

public void join()
          throws InterruptedException

Throws:

InterruptedException

getListenerAddress

public InetSocketAddress getListenerAddress()

setSocketSendBufSize

public void setSocketSendBufSize(int size)

getNumOpenConnections

public int getNumOpenConnections()

Description copied from class: RpcServer

The number of open RPC conections

Specified by:

getNumOpenConnections in class RpcServer

Returns:

the number of open rpc connections

call

public Pair<org.apache.hbase.thirdparty.com.google.protobuf.Message,CellScanner> call(org.apache.hbase.thirdparty.com.google.protobuf.BlockingService service,
                                                                                      org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md,
                                                                                      org.apache.hbase.thirdparty.com.google.protobuf.Message param,
                                                                                      CellScanner cellScanner,
                                                                                      long receiveTime,
                                                                                      MonitoredRPCHandler status)
                                                                               throws IOException

Throws:

IOException

call

public Pair<org.apache.hbase.thirdparty.com.google.protobuf.Message,CellScanner> call(org.apache.hbase.thirdparty.com.google.protobuf.BlockingService service,
                                                                                      org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md,
                                                                                      org.apache.hbase.thirdparty.com.google.protobuf.Message param,
                                                                                      CellScanner cellScanner,
                                                                                      long receiveTime,
                                                                                      MonitoredRPCHandler status,
                                                                                      long startTime,
                                                                                      int timeout)
                                                                               throws IOException

Throws:

IOException

getWriteBufferFatalThreshold

public int getWriteBufferFatalThreshold()

getTotalAndMaxNettyOutboundBytes

public Pair<Long,Long> getTotalAndMaxNettyOutboundBytes()