org.apache.hadoop.ipc

Class RPC

java.lang.Object

org.apache.hadoop.ipc.RPC

public class RPC
extends Object

A simple RPC mechanism. A protocol is a Java interface. All parameters and return types must be one of:

• a primitive type, boolean, byte, char, short, int, long, float, double, or void; or
• a String; or
• a Writable; or
• an array of the above types

All methods in the protocol should throw only IOException. No field data of the protocol instance is transmitted.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RPC.Builder Class to construct instances of RPC server with specific options.
static class	RPC.RpcKind
static class	RPC.Server An RPC Server.
static class	RPC.VersionMismatch A version mismatch for the RPC protocol.

Method Summary

Methods

Modifier and Type	Method and Description
static Client.ConnectionId	getConnectionIdForProxy(Object proxy) Return the connection ID of the given object.
static String	getProtocolName(Class<?> protocol) Get the protocol name.
static <T> ProtocolProxy<T>	getProtocolProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, Configuration conf) Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server
static <T> ProtocolProxy<T>	getProtocolProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, Configuration conf, SocketFactory factory) Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server
static <T> ProtocolProxy<T>	getProtocolProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory) Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server
static <T> ProtocolProxy<T>	getProtocolProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy) Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server
static long	getProtocolVersion(Class<?> protocol) Get the protocol version from protocol class.
static <T> T	getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, Configuration conf) Construct a client-side proxy object with the default SocketFactory
static <T> T	getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, Configuration conf, SocketFactory factory) Construct a client-side proxy object that implements the named protocol, talking to a server at the named address.
static <T> T	getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory) Construct a client-side proxy object that implements the named protocol, talking to a server at the named address.
static <T> T	getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout) Construct a client-side proxy that implements the named protocol, talking to a server at the named address.
static InetSocketAddress	getServerAddress(Object proxy) Returns the server address for a given proxy.
static void	setProtocolEngine(Configuration conf, Class<?> protocol, Class<?> engine) Set a protocol to use a non-default RpcEngine.
static void	stopProxy(Object proxy) Stop the proxy.
static <T> ProtocolProxy<T>	waitForProtocolProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, Configuration conf) Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server
static <T> ProtocolProxy<T>	waitForProtocolProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, Configuration conf, int rpcTimeout, RetryPolicy connectionRetryPolicy, long timeout) Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server
static <T> ProtocolProxy<T>	waitForProtocolProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, Configuration conf, long connTimeout) Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server
static <T> T	waitForProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, Configuration conf) Get a proxy connection to a remote server
static <T> T	waitForProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, Configuration conf, int rpcTimeout, long timeout) Get a proxy connection to a remote server
static <T> T	waitForProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, Configuration conf, long connTimeout) Get a proxy connection to a remote server

Methods inherited from class java.lang.Object

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

Method Detail

getProtocolName

public static String getProtocolName(Class<?> protocol)

Get the protocol name. If the protocol class has a ProtocolAnnotation, then get the protocol name from the annotation; otherwise the class name is the protocol name.

getProtocolVersion

public static long getProtocolVersion(Class<?> protocol)

Get the protocol version from protocol class. If the protocol class has a ProtocolAnnotation, then get the protocol name from the annotation; otherwise the class name is the protocol name.

setProtocolEngine

public static void setProtocolEngine(Configuration conf,
                     Class<?> protocol,
                     Class<?> engine)

Set a protocol to use a non-default RpcEngine.

Parameters:

conf - configuration to use

protocol - the protocol interface

engine - the RpcEngine impl

waitForProxy

public static <T> T waitForProxy(Class<T> protocol,
                 long clientVersion,
                 InetSocketAddress addr,
                 Configuration conf)
                      throws IOException

Get a proxy connection to a remote server

Parameters:

protocol - protocol class

clientVersion - client version

addr - remote address

conf - configuration to use

Returns:

the proxy

Throws:

IOException - if the far end through a RemoteException

waitForProtocolProxy

public static <T> ProtocolProxy<T> waitForProtocolProxy(Class<T> protocol,
                                        long clientVersion,
                                        InetSocketAddress addr,
                                        Configuration conf)
                                             throws IOException

Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server

Parameters:

protocol - protocol class

clientVersion - client version

addr - remote address

conf - configuration to use

Returns:

the protocol proxy

Throws:

IOException - if the far end through a RemoteException

waitForProxy

public static <T> T waitForProxy(Class<T> protocol,
                 long clientVersion,
                 InetSocketAddress addr,
                 Configuration conf,
                 long connTimeout)
                      throws IOException

Get a proxy connection to a remote server

Parameters:

protocol - protocol class

clientVersion - client version

addr - remote address

conf - configuration to use

connTimeout - time in milliseconds before giving up

Returns:

the proxy

Throws:

IOException - if the far end through a RemoteException

waitForProtocolProxy

public static <T> ProtocolProxy<T> waitForProtocolProxy(Class<T> protocol,
                                        long clientVersion,
                                        InetSocketAddress addr,
                                        Configuration conf,
                                        long connTimeout)
                                             throws IOException

Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server

Parameters:

protocol - protocol class

clientVersion - client version

addr - remote address

conf - configuration to use

connTimeout - time in milliseconds before giving up

Returns:

the protocol proxy

Throws:

IOException - if the far end through a RemoteException

waitForProxy

public static <T> T waitForProxy(Class<T> protocol,
                 long clientVersion,
                 InetSocketAddress addr,
                 Configuration conf,
                 int rpcTimeout,
                 long timeout)
                      throws IOException

Get a proxy connection to a remote server

Parameters:

protocol - protocol class

clientVersion - client version

addr - remote address

conf - configuration to use

rpcTimeout - timeout for each RPC

timeout - time in milliseconds before giving up

Returns:

the proxy

Throws:

IOException - if the far end through a RemoteException

waitForProtocolProxy

public static <T> ProtocolProxy<T> waitForProtocolProxy(Class<T> protocol,
                                        long clientVersion,
                                        InetSocketAddress addr,
                                        Configuration conf,
                                        int rpcTimeout,
                                        RetryPolicy connectionRetryPolicy,
                                        long timeout)
                                             throws IOException

Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server

Parameters:

protocol - protocol class

clientVersion - client version

addr - remote address

conf - configuration to use

rpcTimeout - timeout for each RPC

timeout - time in milliseconds before giving up

Returns:

the proxy

Throws:

IOException - if the far end through a RemoteException

getProxy

public static <T> T getProxy(Class<T> protocol,
             long clientVersion,
             InetSocketAddress addr,
             Configuration conf,
             SocketFactory factory)
                  throws IOException

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

Type Parameters:

T -

Throws:

IOException

getProtocolProxy

public static <T> ProtocolProxy<T> getProtocolProxy(Class<T> protocol,
                                    long clientVersion,
                                    InetSocketAddress addr,
                                    Configuration conf,
                                    SocketFactory factory)
                                         throws IOException

Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server

Parameters:

protocol - protocol class

clientVersion - client version

addr - remote address

conf - configuration to use

factory - socket factory

Returns:

the protocol proxy

Throws:

IOException - if the far end through a RemoteException

getProxy

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

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

Type Parameters:

T -

Throws:

IOException

getProtocolProxy

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

Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server

Parameters:

protocol - protocol class

clientVersion - client version

addr - remote address

ticket - user group information

conf - configuration to use

factory - socket factory

Returns:

the protocol proxy

Throws:

IOException - if the far end through a RemoteException

getProxy

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

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

Type Parameters:

T -

Parameters:

protocol - protocol

clientVersion - client's version

addr - server address

ticket - security ticket

conf - configuration

factory - socket factory

rpcTimeout - max time for each rpc; 0 means no timeout

Returns:

the proxy

Throws:

IOException - if any error occurs

getProtocolProxy

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

Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server

Parameters:

protocol - protocol

clientVersion - client's version

addr - server address

ticket - security ticket

conf - configuration

factory - socket factory

rpcTimeout - max time for each rpc; 0 means no timeout

Returns:

the proxy

Throws:

IOException - if any error occurs

getProxy

public static <T> T getProxy(Class<T> protocol,
             long clientVersion,
             InetSocketAddress addr,
             Configuration conf)
                  throws IOException

Construct a client-side proxy object with the default SocketFactory

Type Parameters:

T -

Parameters:

protocol -

clientVersion -

addr -

conf -

Returns:

a proxy instance

Throws:

IOException

getServerAddress

public static InetSocketAddress getServerAddress(Object proxy)

Returns the server address for a given proxy.

getConnectionIdForProxy

public static Client.ConnectionId getConnectionIdForProxy(Object proxy)

Return the connection ID of the given object. If the provided object is in fact a protocol translator, we'll get the connection ID of the underlying proxy object.

Parameters:

proxy - the proxy object to get the connection ID of.

Returns:

the connection ID for the provided proxy object.

getProtocolProxy

public static <T> ProtocolProxy<T> getProtocolProxy(Class<T> protocol,
                                    long clientVersion,
                                    InetSocketAddress addr,
                                    Configuration conf)
                                         throws IOException

Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server

Parameters:

protocol -

clientVersion -

addr -

conf -

Returns:

a protocol proxy

Throws:

IOException

stopProxy

public static void stopProxy(Object proxy)

Stop the proxy. Proxy must either implement Closeable or must have associated RpcInvocationHandler.

Parameters:

proxy - the RPC proxy object to be stopped

Throws:

HadoopIllegalArgumentException - if the proxy does not implement Closeable interface or does not have closeable InvocationHandler