org.apache.hadoop.ipc

Class ProtobufRpcEngine

java.lang.Object

org.apache.hadoop.ipc.ProtobufRpcEngine

All Implemented Interfaces:

RpcEngine

@InterfaceStability.Evolving
public class ProtobufRpcEngine
extends Object
implements RpcEngine

RPC Engine for for protobuf based RPCs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtobufRpcEngine.RpcRequestMessageWrapper
static class	ProtobufRpcEngine.RpcResponseMessageWrapper
static class	ProtobufRpcEngine.RpcResponseWrapper Wrapper for Protocol Buffer Responses Note while this wrapper is writable, the request on the wire is in Protobuf.
static class	ProtobufRpcEngine.Server

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	LOG

Constructor Summary

Constructors

Constructor and Description
ProtobufRpcEngine()

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

LOG

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

Constructor Detail

ProtobufRpcEngine

public ProtobufRpcEngine()

Method Detail

getProxy

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

Throws:

IOException

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

Description copied from interface: RpcEngine

Construct a client-side proxy object.

Specified by:

getProxy in interface RpcEngine

Throws:

IOException

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

getServer

public RPC.Server getServer(Class<?> protocol,
                   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:

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