org.apache.hadoop.ipc

Interface RpcEngine

All Known Implementing Classes:

ProtobufRpcEngine, WritableRpcEngine

@InterfaceStability.Evolving
public interface RpcEngine

An RPC implementation.

Method Summary

Methods

Modifier and Type	Method and Description
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.
RPC.Server	getServer(Class<?> protocol, Object instance, 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.

Method Detail

getProxy

<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.

Type Parameters:

T -

Throws:

IOException

getServer

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

Construct a server for a protocol implementation instance.

Parameters:

protocol - the class of protocol to use

instance - the instance of protocol whose methods will be called

conf - the configuration to use

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

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

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

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

Parameters:

connId, - ConnectionId to be used for the proxy.

conf, - Configuration.

factory, - Socket factory.

Returns:

Proxy object.

Throws:

IOException