Package org.apache.hadoop.ipc

Interface RpcEngine

All Known Implementing Classes:

ProtobufRpcEngine, ProtobufRpcEngine2, WritableRpcEngine

@Evolving
public interface RpcEngine

An RPC implementation.

Method Summary

Modifier and Type	Method	Description
ProtocolProxy<ProtocolMetaInfoPB>	getProtocolMetaInfoProxy(Client.ConnectionId connId, Configuration conf, javax.net.SocketFactory factory)	Returns a proxy for ProtocolMetaInfoPB, which uses the given connection id.
<T> ProtocolProxy<T>	getProxy(java.lang.Class<T> protocol, long clientVersion, java.net.InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, javax.net.SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy)	Construct a client-side proxy object.
<T> ProtocolProxy<T>	getProxy(java.lang.Class<T> protocol, long clientVersion, java.net.InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, javax.net.SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy, java.util.concurrent.atomic.AtomicBoolean fallbackToSimpleAuth, AlignmentContext alignmentContext)	Construct a client-side proxy object.
<T> ProtocolProxy<T>	getProxy(java.lang.Class<T> protocol, long clientVersion, Client.ConnectionId connId, Configuration conf, javax.net.SocketFactory factory, AlignmentContext alignmentContext)	Construct a client-side proxy object with a ConnectionId.
RPC.Server	getServer(java.lang.Class<?> protocol, java.lang.Object instance, java.lang.String bindAddress, int port, int numHandlers, int numReaders, int queueSizePerHandler, boolean verbose, Configuration conf, SecretManager<? extends TokenIdentifier> secretManager, java.lang.String portRangeConfig, AlignmentContext alignmentContext)	Construct a server for a protocol implementation instance.

Method Detail

getProxy

<T> ProtocolProxy<T> getProxy(java.lang.Class<T> protocol,
                              long clientVersion,
                              java.net.InetSocketAddress addr,
                              UserGroupInformation ticket,
                              Configuration conf,
                              javax.net.SocketFactory factory,
                              int rpcTimeout,
                              RetryPolicy connectionRetryPolicy)
                       throws java.io.IOException

Construct a client-side proxy object.

Type Parameters:

T - Generics Type T.

Parameters:

protocol - input protocol.

clientVersion - input clientVersion.

addr - input addr.

ticket - input ticket.

conf - input Configuration.

factory - input factory.

rpcTimeout - input rpcTimeout.

connectionRetryPolicy - input connectionRetryPolicy.

Returns:

ProtocolProxy.

Throws:

java.io.IOException - raised on errors performing I/O.

getProxy

<T> ProtocolProxy<T> getProxy(java.lang.Class<T> protocol,
                              long clientVersion,
                              Client.ConnectionId connId,
                              Configuration conf,
                              javax.net.SocketFactory factory,
                              AlignmentContext alignmentContext)
                       throws java.io.IOException

Construct a client-side proxy object with a ConnectionId.

Type Parameters:

T - Generics Type T.

Parameters:

protocol - input protocol.

clientVersion - input clientVersion.

connId - input ConnectionId.

conf - input Configuration.

factory - input factory.

alignmentContext - Alignment context

Returns:

ProtocolProxy.

Throws:

java.io.IOException - raised on errors performing I/O.

getProxy

<T> ProtocolProxy<T> getProxy(java.lang.Class<T> protocol,
                              long clientVersion,
                              java.net.InetSocketAddress addr,
                              UserGroupInformation ticket,
                              Configuration conf,
                              javax.net.SocketFactory factory,
                              int rpcTimeout,
                              RetryPolicy connectionRetryPolicy,
                              java.util.concurrent.atomic.AtomicBoolean fallbackToSimpleAuth,
                              AlignmentContext alignmentContext)
                       throws java.io.IOException

Construct a client-side proxy object.

Type Parameters:

T - Generics Type T.

Parameters:

protocol - input protocol.

clientVersion - input clientVersion.

addr - input addr.

ticket - input tocket.

conf - input Configuration.

factory - input factory.

rpcTimeout - input rpcTimeout.

connectionRetryPolicy - input connectionRetryPolicy.

fallbackToSimpleAuth - input fallbackToSimpleAuth.

alignmentContext - input alignmentContext.

Returns:

ProtocolProxy.

Throws:

java.io.IOException - raised on errors performing I/O.

getServer

RPC.Server getServer(java.lang.Class<?> protocol,
                     java.lang.Object instance,
                     java.lang.String bindAddress,
                     int port,
                     int numHandlers,
                     int numReaders,
                     int queueSizePerHandler,
                     boolean verbose,
                     Configuration conf,
                     SecretManager<? extends TokenIdentifier> secretManager,
                     java.lang.String portRangeConfig,
                     AlignmentContext alignmentContext)
              throws java.io.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)

alignmentContext - provides server state info on client responses

Returns:

The Server instance

Throws:

java.io.IOException - on any error

getProtocolMetaInfoProxy

ProtocolProxy<ProtocolMetaInfoPB> getProtocolMetaInfoProxy(Client.ConnectionId connId,
                                                           Configuration conf,
                                                           javax.net.SocketFactory factory)
                                                    throws java.io.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:

java.io.IOException - raised on errors performing I/O.