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
(package private) org.apache.hbase.thirdparty.io.netty.channel.group.ChannelGroup	allChannels
private InetSocketAddress	bindAddress
private org.apache.hbase.thirdparty.io.netty.buffer.ByteBufAllocator	channelAllocator
private CountDownLatch	closed
static String	HBASE_NETTY_ALLOCATOR_KEY Name of property to change the byte buf allocator for the netty channels.
(package private) static String	HEAP_ALLOCATOR_TYPE
static org.slf4j.Logger	LOG
(package private) static String	POOLED_ALLOCATOR_TYPE
private org.apache.hbase.thirdparty.io.netty.channel.Channel	serverChannel
(package private) static String	UNPOOLED_ALLOCATOR_TYPE

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, running, saslProps, scheduler, secretManager, server, services, started, tcpKeepAlive, tcpNoDelay, TRACE_LOG_MAX_LENGTH, userProvider, WARN_RESPONSE_SIZE, WARN_RESPONSE_TIME, warnResponseSize, warnResponseTime

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 NettyRpcServerPreambleHandler	createNettyRpcServerPreambleHandler()
private org.apache.hbase.thirdparty.io.netty.buffer.ByteBufAllocator	getChannelAllocator(org.apache.hadoop.conf.Configuration conf)
InetSocketAddress	getListenerAddress()
int	getNumOpenConnections() The number of open RPC conections
void	join()
void	setSocketSendBufSize(int size)
void	start()
void	stop()

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

addCallSize, authorize, call, channelRead, createSecretManager, getByteBuffAllocator, getConf, getCurrentCall, getErrorHandler, getMetrics, getRemoteAddress, getRemoteIp, getRequestUser, getRequestUserName, getScheduler, getSecretManager, getService, getServiceAndInterface, getServiceInterface, getStatus, initReconfigurable, isInRpcCallContext, isStarted, logResponse, needAuthorization, onConfigurationChange, refreshAuthManager, setCurrentCall, setErrorHandler, setNamedQueueRecorder, setRsRpcServices, setSecretManager, truncateTraceLog, 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

POOLED_ALLOCATOR_TYPE

static final String POOLED_ALLOCATOR_TYPE

See Also:

Constant Field Values

UNPOOLED_ALLOCATOR_TYPE

static final String UNPOOLED_ALLOCATOR_TYPE

See Also:

Constant Field Values

HEAP_ALLOCATOR_TYPE

static final String HEAP_ALLOCATOR_TYPE

See Also:

Constant Field Values

bindAddress

private final InetSocketAddress bindAddress

closed

private final CountDownLatch closed

serverChannel

private final org.apache.hbase.thirdparty.io.netty.channel.Channel serverChannel

allChannels

final org.apache.hbase.thirdparty.io.netty.channel.group.ChannelGroup allChannels

channelAllocator

private final org.apache.hbase.thirdparty.io.netty.buffer.ByteBufAllocator channelAllocator

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

getChannelAllocator

private org.apache.hbase.thirdparty.io.netty.buffer.ByteBufAllocator getChannelAllocator(org.apache.hadoop.conf.Configuration conf)
                                                                                  throws IOException

Throws:

IOException

createNettyRpcServerPreambleHandler

@InterfaceAudience.Private
protected NettyRpcServerPreambleHandler createNettyRpcServerPreambleHandler()

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