org.apache.hadoop.ipc

Class WritableRpcEngine

java.lang.Object

org.apache.hadoop.ipc.WritableRpcEngine

All Implemented Interfaces:

RpcEngine

@InterfaceStability.Evolving
public class WritableRpcEngine
extends Object
implements RpcEngine

An RpcEngine implementation for Writable data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WritableRpcEngine.Server An RPC Server.

Field Summary

Fields

Modifier and Type	Field and Description
static long	writableRpcVersion

Constructor Summary

Constructors

Constructor and Description
WritableRpcEngine()

Method Summary

Methods

Modifier and Type	Method and Description
static void	ensureInitialized() Initialize this class if it isn't already.
ProtocolProxy<ProtocolMetaInfoPB>	getProtocolMetaInfoProxy(Client.ConnectionId connId, Configuration conf, SocketFactory factory) Returns a proxy for ProtocolMetaInfoPB, which uses the given connection id.
<T> ProtocolProxy<T>	getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy) Construct a client-side proxy object that implements the named protocol, talking to a server at the named address.
RPC.Server	getServer(Class<?> protocolClass, Object protocolImpl, String bindAddress, int port, int numHandlers, int numReaders, int queueSizePerHandler, boolean verbose, Configuration conf, SecretManager<? extends TokenIdentifier> secretManager, String portRangeConfig) Construct a server for a protocol implementation instance.

Methods inherited from class java.lang.Object

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

Field Detail

writableRpcVersion

public static final long writableRpcVersion

See Also:

Constant Field Values

Constructor Detail

WritableRpcEngine

public WritableRpcEngine()

Method Detail

ensureInitialized

public static void ensureInitialized()

Initialize this class if it isn't already.

getProxy

public <T> ProtocolProxy<T> getProxy(Class<T> protocol,
                            long clientVersion,
                            InetSocketAddress addr,
                            UserGroupInformation ticket,
                            Configuration conf,
                            SocketFactory factory,
                            int rpcTimeout,
                            RetryPolicy connectionRetryPolicy)
                          throws IOException

Construct a client-side proxy object that implements the named protocol, talking to a server at the named address.

Specified by:

getProxy in interface RpcEngine

Type Parameters:

T -

Throws:

IOException

getServer

public RPC.Server getServer(Class<?> protocolClass,
                   Object protocolImpl,
                   String bindAddress,
                   int port,
                   int numHandlers,
                   int numReaders,
                   int queueSizePerHandler,
                   boolean verbose,
                   Configuration conf,
                   SecretManager<? extends TokenIdentifier> secretManager,
                   String portRangeConfig)
                     throws IOException

Description copied from interface: RpcEngine

Construct a server for a protocol implementation instance.

Specified by:

getServer in interface RpcEngine

Parameters:

protocolClass - the class of protocol to use

protocolImpl - the instance of protocol whose methods will be called

bindAddress - the address to bind on to listen for connection

port - the port to listen for connections on

numHandlers - the number of method handler threads to run

numReaders - the number of reader threads to run

queueSizePerHandler - the size of the queue per hander thread

verbose - whether each call should be logged

conf - the configuration to use

secretManager - The secret manager to use to validate incoming requests.

portRangeConfig - A config parameter that can be used to restrict the range of ports used when port is 0 (an ephemeral port)

Returns:

The Server instance

Throws:

IOException - on any error

getProtocolMetaInfoProxy

public ProtocolProxy<ProtocolMetaInfoPB> getProtocolMetaInfoProxy(Client.ConnectionId connId,
                                                         Configuration conf,
                                                         SocketFactory factory)
                                                           throws IOException

Description copied from interface: RpcEngine

Returns a proxy for ProtocolMetaInfoPB, which uses the given connection id.

Specified by:

getProtocolMetaInfoProxy in interface RpcEngine

Returns:

Proxy object.

Throws:

IOException