org.apache.hadoop.ipc

Class Server

java.lang.Object

org.apache.hadoop.ipc.Server

Direct Known Subclasses:

RPC.Server

public abstract class Server
extends Object

An abstract IPC service. IPC calls take a single Writable as a parameter, and return a Writable as their value. A service runs on a port and is defined by a parameter class and a value class.

See Also:

Client

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Server.AuthProtocol
static class	Server.Call A call queued for handling.
class	Server.Connection Reads calls from a connection and queues them for handling.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	AUDITLOG
static org.apache.commons.logging.Log	LOG
protected RpcDetailedMetrics	rpcDetailedMetrics
protected RpcMetrics	rpcMetrics

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Server(String bindAddress, int port, Class<? extends Writable> paramClass, int handlerCount, Configuration conf)
protected	Server(String bindAddress, int port, Class<? extends Writable> rpcRequestClass, int handlerCount, int numReaders, int queueSizePerHandler, Configuration conf, String serverName, SecretManager<? extends TokenIdentifier> secretManager)
protected	Server(String bindAddress, int port, Class<? extends Writable> rpcRequestClass, int handlerCount, int numReaders, int queueSizePerHandler, Configuration conf, String serverName, SecretManager<? extends TokenIdentifier> secretManager, String portRangeConfig) Constructs a server listening on the named port and address.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTerseExceptions(Class<?>... exceptionClass)
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.
static void	bind(ServerSocket socket, InetSocketAddress address, int backlog, Configuration conf, String rangeConf)
abstract Writable	call(RPC.RpcKind rpcKind, String protocol, Writable param, long receiveTime) Called for each call.
Writable	call(Writable param, long receiveTime) Deprecated. Use #call(RpcPayloadHeader.RpcKind, String, Writable, long) instead
static Server	get() Returns the server instance called under or null.
static int	getCallId() Returns the currently active RPC call's sequential ID number.
int	getCallQueueLen() The number of rpc calls in the queue.
static int	getCallRetryCount()
static byte[]	getClientId() Returns the clientId from the current RPC request
static ThreadLocal<Server.Call>	getCurCall() Get the current call
InetSocketAddress	getListenerAddress() Return the socket (ip+port) on which the RPC server is listening to.
int	getMaxQueueSize() The maximum size of the rpc call queue of this server.
int	getNumOpenConnections() The number of open RPC conections
int	getNumReaders() The number of reader threads for this server.
int	getPort() Get the port on which the IPC Server is listening for incoming connections.
static String	getRemoteAddress() Returns remote address as a string when invoked inside an RPC.
static InetAddress	getRemoteIp() Returns the remote side ip address when invoked inside an RPC Returns null incase of an error.
static UserGroupInformation	getRemoteUser() Returns the RPC remote user when invoked inside an RPC.
RpcDetailedMetrics	getRpcDetailedMetrics()
static org.apache.hadoop.ipc.RPC.RpcInvoker	getRpcInvoker(RPC.RpcKind rpcKind)
RpcMetrics	getRpcMetrics() Returns a handle to the rpcMetrics (required in tests)
Class<? extends Writable>	getRpcRequestWrapper(RpcHeaderProtos.RpcKindProto rpcKind)
ServiceAuthorizationManager	getServiceAuthorizationManager() Returns a handle to the serviceAuthorizationManager (required in tests)
static boolean	isRpcInvocation() Return true if the invocation was through an RPC.
void	join() Wait for the server to be stopped.
void	refreshServiceAcl(Configuration conf, PolicyProvider provider) Refresh the service authorization ACL for the service handled by this server.
static void	registerProtocolEngine(RPC.RpcKind rpcKind, Class<? extends Writable> rpcRequestWrapperClass, org.apache.hadoop.ipc.RPC.RpcInvoker rpcInvoker) Register a RPC kind and the class to deserialize the rpc request.
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 java.lang.Object

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

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

AUDITLOG

public static final org.apache.commons.logging.Log AUDITLOG

rpcMetrics

protected RpcMetrics rpcMetrics

rpcDetailedMetrics

protected RpcDetailedMetrics rpcDetailedMetrics

Constructor Detail

Server

protected Server(String bindAddress,
      int port,
      Class<? extends Writable> paramClass,
      int handlerCount,
      Configuration conf)
          throws IOException

Throws:

IOException

Server

protected Server(String bindAddress,
      int port,
      Class<? extends Writable> rpcRequestClass,
      int handlerCount,
      int numReaders,
      int queueSizePerHandler,
      Configuration conf,
      String serverName,
      SecretManager<? extends TokenIdentifier> secretManager)
          throws IOException

Throws:

IOException

Server

protected Server(String bindAddress,
      int port,
      Class<? extends Writable> rpcRequestClass,
      int handlerCount,
      int numReaders,
      int queueSizePerHandler,
      Configuration conf,
      String serverName,
      SecretManager<? extends TokenIdentifier> secretManager,
      String portRangeConfig)
          throws IOException

Constructs a server listening on the named port and address. Parameters passed must be of the named class. The handlerCount determines the number of handler threads that will be used to process calls. If queueSizePerHandler or numReaders are not -1 they will be used instead of parameters from configuration. Otherwise the configuration will be picked up. If rpcRequestClass is null then the rpcRequestClass must have been registered via #registerProtocolEngine(RpcPayloadHeader.RpcKind, Class, RPC.RpcInvoker) This parameter has been retained for compatibility with existing tests and usage.

Throws:

IOException

Method Detail

addTerseExceptions

public void addTerseExceptions(Class<?>... exceptionClass)

registerProtocolEngine

public static void registerProtocolEngine(RPC.RpcKind rpcKind,
                          Class<? extends Writable> rpcRequestWrapperClass,
                          org.apache.hadoop.ipc.RPC.RpcInvoker rpcInvoker)

Register a RPC kind and the class to deserialize the rpc request. Called by static initializers of rpcKind Engines

Parameters:

rpcKind -

rpcRequestWrapperClass - - this class is used to deserialze the the rpc request.

rpcInvoker - - use to process the calls on SS.

getRpcRequestWrapper

public Class<? extends Writable> getRpcRequestWrapper(RpcHeaderProtos.RpcKindProto rpcKind)

getRpcInvoker

public static org.apache.hadoop.ipc.RPC.RpcInvoker getRpcInvoker(RPC.RpcKind rpcKind)

get

public static Server get()

Returns the server instance called under or null. May be called under call(Writable, long) implementations, and under Writable methods of paramters and return values. Permits applications to access the server context.

getCurCall

public static ThreadLocal<Server.Call> getCurCall()

Get the current call

getCallId

public static int getCallId()

Returns the currently active RPC call's sequential ID number. A negative call ID indicates an invalid value, such as if there is no currently active RPC call.

Returns:

int sequential ID number of currently active RPC call

getCallRetryCount

public static int getCallRetryCount()

Returns:

The current active RPC call's retry count. -1 indicates the retry cache is not supported in the client side.

getRemoteIp

public static InetAddress getRemoteIp()

Returns the remote side ip address when invoked inside an RPC Returns null incase of an error.

getClientId

public static byte[] getClientId()

Returns the clientId from the current RPC request

getRemoteAddress

public static String getRemoteAddress()

Returns remote address as a string when invoked inside an RPC. Returns null in case of an error.

getRemoteUser

public static UserGroupInformation getRemoteUser()

Returns the RPC remote user when invoked inside an RPC. Note this may be different than the current user if called within another doAs

Returns:

connection's UGI or null if not an RPC

isRpcInvocation

public static boolean isRpcInvocation()

Return true if the invocation was through an RPC.

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

bind

public static void bind(ServerSocket socket,
        InetSocketAddress address,
        int backlog,
        Configuration conf,
        String rangeConf)
                 throws IOException

Throws:

IOException

getRpcMetrics

public RpcMetrics getRpcMetrics()

Returns a handle to the rpcMetrics (required in tests)

Returns:

rpc metrics

getRpcDetailedMetrics

public RpcDetailedMetrics getRpcDetailedMetrics()

refreshServiceAcl

public void refreshServiceAcl(Configuration conf,
                     PolicyProvider provider)

Refresh the service authorization ACL for the service handled by this server.

getServiceAuthorizationManager

@InterfaceAudience.LimitedPrivate(value={"HDFS","MapReduce"})
public ServiceAuthorizationManager getServiceAuthorizationManager()

Returns a handle to the serviceAuthorizationManager (required in tests)

Returns:

instance of ServiceAuthorizationManager for this server

setSocketSendBufSize

public void setSocketSendBufSize(int size)

Sets the socket buffer size used for responding to RPCs

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

getListenerAddress

public InetSocketAddress getListenerAddress()

Return the socket (ip+port) on which the RPC server is listening to.

Returns:

the socket (ip+port) on which the RPC server is listening to.

call

@Deprecated
public Writable call(Writable param,
                       long receiveTime)
              throws Exception

Deprecated. Use #call(RpcPayloadHeader.RpcKind, String, Writable, long) instead

Called for each call.

Throws:

Exception

call

public abstract Writable call(RPC.RpcKind rpcKind,
            String protocol,
            Writable param,
            long receiveTime)
                       throws Exception

Called for each call.

Throws:

Exception

getPort

public int getPort()

Get the port on which the IPC Server is listening for incoming connections. This could be an ephemeral port too, in which case we return the real port on which the Server has bound.

Returns:

port on which IPC Server is listening

getNumOpenConnections

public int getNumOpenConnections()

The number of open RPC conections

Returns:

the number of open rpc connections

getCallQueueLen

public int getCallQueueLen()

The number of rpc calls in the queue.

Returns:

The number of rpc calls in the queue.

getMaxQueueSize

public int getMaxQueueSize()

The maximum size of the rpc call queue of this server.

Returns:

The maximum size of the rpc call queue.

getNumReaders

public int getNumReaders()

The number of reader threads for this server.

Returns:

The number of reader threads.