org.apache.hadoop.hbase.ipc

Class SimpleRpcServer

java.lang.Object

org.apache.hadoop.hbase.ipc.RpcServer

org.apache.hadoop.hbase.ipc.SimpleRpcServer

All Implemented Interfaces:

ConfigurationObserver, RpcServerInterface

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

The RPC server with native java NIO implementation deriving from Hadoop to host protobuf described Services. It's the original one before HBASE-17262, and the default RPC server for now. An RpcServer instance has a Listener that hosts the socket. Listener has fixed number of Readers in an ExecutorPool, 10 by default. The Listener does an accept and then round robin a Reader is chosen to do the read. The reader is registered on Selector. Read does total read off the channel and the parse from which it makes a Call. The call is wrapped in a CallRunner and passed to the scheduler to be run. Reader goes back to see if more to be done and loops till done.

Scheduler can be variously implemented but default simple scheduler has handlers to which it has given the queues into which calls (i.e. CallRunner instances) are inserted. Handlers run taking from the queue. They run the CallRunner#run method on each item gotten from queue and keep taking while the server is up. CallRunner#run executes the call. When done, asks the included Call to put itself on new queue for Responder to pull from and return result to client.

See Also:

BlockingRpcClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	SimpleRpcServer.ConnectionManager
private class	SimpleRpcServer.Listener Listens on the socket.

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
protected InetSocketAddress	address
private SimpleRpcServer.ConnectionManager	connectionManager
private SimpleRpcServer.Listener	listener
protected int	port
protected long	purgeTimeout
private int	readThreads
protected SimpleRpcServerResponder	responder
protected int	socketSendBufferSize

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

allowFallbackToSimpleAuth, AUDITLOG, AUTH_FAILED_FOR, AUTH_SUCCESSFUL_FOR, authManager, authTokenSecretMgr, bindAddress, 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, isSecurityEnabled, KEY_WORD_TRUNCATED, LOG, MAPPER, MAX_REQUEST_SIZE, maxQueueSizeInBytes, maxRequestSize, metrics, MIN_CLIENT_REQUEST_TIMEOUT, minClientRequestTimeout, minSizeForReservoirUse, MONITORED_RPC, NIO_BUFFER_LIMIT, REQUEST_TOO_BIG_EXCEPTION, reservoir, 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
SimpleRpcServer(Server server, String name, List<RpcServer.BlockingServiceAndInterface> services, InetSocketAddress bindAddress, org.apache.hadoop.conf.Configuration conf, RpcScheduler scheduler, boolean reservoirEnabled) Constructs a server listening on the named port and address.

Method Summary

Modifier and Type	Method and Description
static void	bind(ServerSocket socket, InetSocketAddress address, int backlog) A convenience method to bind to a given address and report better exceptions if the address is not a valid host.
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 long	channelWrite(GatheringByteChannel channel, BufferChain bufferChain) This is a wrapper around WritableByteChannel.write(java.nio.ByteBuffer).
protected void	closeConnection(SimpleServerRpcConnection connection)
protected SimpleServerRpcConnection	getConnection(SocketChannel channel, long time) Subclasses of HBaseServer can override this to provide their own Connection implementations.
InetSocketAddress	getListenerAddress() Return the socket (ip+port) on which the RPC server is listening to.
int	getNumOpenConnections() The number of open RPC conections
void	join() Wait for the server to be stopped.
void	setSocketSendBufSize(int size) Sets the socket buffer size used for responding to RPCs.
void	start() Starts the service.
void	stop() Stops the service.

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

addCallSize, allocateByteBuffToReadInto, authorize, call, channelRead, createSecretManager, getConf, getCurrentCall, getErrorHandler, getMetrics, getMinSizeForReservoirUse, getRemoteAddress, getRemoteIp, getRequestUser, getRequestUserName, getScheduler, getSecretManager, getService, getServiceAndInterface, getServiceInterface, getStatus, initReconfigurable, isInRpcCallContext, isStarted, logResponse, onConfigurationChange, refreshAuthManager, setErrorHandler, setRsRpcServices, setSecretManager, truncateTraceLog

Methods inherited from class java.lang.Object

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

Field Detail

port

protected int port

address

protected InetSocketAddress address

readThreads

private int readThreads

socketSendBufferSize

protected int socketSendBufferSize

purgeTimeout

protected final long purgeTimeout

connectionManager

private SimpleRpcServer.ConnectionManager connectionManager

listener

private SimpleRpcServer.Listener listener

responder

protected SimpleRpcServerResponder responder

Constructor Detail

SimpleRpcServer

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

Constructs a server listening on the named port and address.

Parameters:

server - hosting instance of Server. We will do authentications if an instance else pass null for no authentication check.

name - Used keying this rpc servers' metrics and for naming the Listener thread.

services - A list of services.

bindAddress - Where to listen

conf -

scheduler -

reservoirEnabled - Enable ByteBufferPool or not.

Throws:

IOException

Method Detail

getConnection

protected SimpleServerRpcConnection getConnection(SocketChannel channel,
                                                  long time)

Subclasses of HBaseServer can override this to provide their own Connection implementations.

closeConnection

protected void closeConnection(SimpleServerRpcConnection connection)

setSocketSendBufSize

public void setSocketSendBufSize(int size)

Sets the socket buffer size used for responding to RPCs.

Parameters:

size - send size

start

public void start()

Starts the service. Must be called before any calls will be handled.

stop

public void stop()

Stops the service. No new calls will be handled after this is called.

join

public void join()
          throws InterruptedException

Wait for the server to be stopped. Does not wait for all subthreads to finish. See stop().

Throws:

InterruptedException - e

getListenerAddress

public InetSocketAddress getListenerAddress()

Return the socket (ip+port) on which the RPC server is listening to. May return null if the listener channel is closed.

Returns:

the socket (ip+port) on which the RPC server is listening to, or null if this information cannot be determined

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

channelWrite

protected long channelWrite(GatheringByteChannel channel,
                            BufferChain bufferChain)
                     throws IOException

This is a wrapper around WritableByteChannel.write(java.nio.ByteBuffer). If the amount of data is large, it writes to channel in smaller chunks. This is to avoid jdk from creating many direct buffers as the size of buffer increases. This also minimizes extra copies in NIO layer as a result of multiple write operations required to write a large buffer.

Parameters:

channel - writable byte channel to write to

bufferChain - Chain of buffers to write

Returns:

number of bytes written

Throws:

IOException - e

See Also:

WritableByteChannel.write(java.nio.ByteBuffer)

bind

public static void bind(ServerSocket socket,
                        InetSocketAddress address,
                        int backlog)
                 throws IOException

A convenience method to bind to a given address and report better exceptions if the address is not a valid host.

Parameters:

socket - the socket to bind

address - the address to bind to

backlog - the number of connections allowed in the queue

Throws:

BindException - if the address can't be bound

UnknownHostException - if the address isn't a valid host name

IOException - other random errors from bind

getNumOpenConnections

public int getNumOpenConnections()

The number of open RPC conections

Specified by:

getNumOpenConnections in class RpcServer

Returns:

the number of open rpc connections