org.apache.hadoop.ipc

Class Client

java.lang.Object

org.apache.hadoop.ipc.Client

public class Client
extends Object

A client for an IPC service. IPC calls take a single Writable as a parameter, and return a Writable as their value. A service runs on a port and is defined by a parameter class and a value class.

See Also:

Server

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Client.ConnectionId This class holds the address and the user ticket.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
Client(Class<? extends Writable> valueClass, Configuration conf) Construct an IPC client with the default SocketFactory
Client(Class<? extends Writable> valueClass, Configuration conf, SocketFactory factory) Construct an IPC client whose values are of the given Writable class.

Method Summary

Methods

Modifier and Type	Method and Description
Writable	call(RPC.RpcKind rpcKind, Writable rpcRequest, Client.ConnectionId remoteId) Make a call, passing rpcRequest, to the IPC server defined by remoteId, returning the rpc respond.
Writable	call(RPC.RpcKind rpcKind, Writable rpcRequest, Client.ConnectionId remoteId, int serviceClass) Make a call, passing rpcRequest, to the IPC server defined by remoteId, returning the rpc respond.
Writable	call(RPC.RpcKind rpcKind, Writable param, InetSocketAddress address) Deprecated. Use call(RPC.RpcKind, Writable, ConnectionId) instead
Writable	call(RPC.RpcKind rpcKind, Writable param, InetSocketAddress addr, Class<?> protocol, UserGroupInformation ticket, int rpcTimeout) Deprecated. Use call(RPC.RpcKind, Writable, ConnectionId) instead
Writable	call(RPC.RpcKind rpcKind, Writable param, InetSocketAddress addr, Class<?> protocol, UserGroupInformation ticket, int rpcTimeout, Configuration conf) Make a call, passing param, to the IPC server running at address which is servicing the protocol protocol, with the ticket credentials, rpcTimeout as timeout and conf as conf for this connection, returning the value.
Writable	call(RPC.RpcKind rpcKind, Writable param, InetSocketAddress addr, UserGroupInformation ticket) Deprecated. Use call(RPC.RpcKind, Writable, ConnectionId) instead
Writable	call(Writable param, Client.ConnectionId remoteId) Same as {link call(RPC.RpcKind, Writable, ConnectionId) except the rpcKind is RPC_BUILTIN
Writable	call(Writable param, InetSocketAddress address) Same as call(RPC.RpcKind, Writable, ConnectionId) for RPC_BUILTIN
Writable	call(Writable param, InetSocketAddress addr, Class<?> protocol, UserGroupInformation ticket, int rpcTimeout, Configuration conf) Same as call(RPC.RpcKind, Writable, InetSocketAddress, Class, UserGroupInformation, int, Configuration) except that rpcKind is writable.
Writable	call(Writable param, InetSocketAddress addr, Class<?> protocol, UserGroupInformation ticket, int rpcTimeout, int serviceClass, Configuration conf) Same as call(Writable, InetSocketAddress, Class, UserGroupInformation, int, Configuration) except that specifying serviceClass.
static int	getTimeout(Configuration conf) The time after which a RPC will timeout.
static int	nextCallId() Returns the next valid sequential call ID by incrementing an atomic counter and masking off the sign bit.
static void	setCallIdAndRetryCount(int cid, int rc) Set call id and retry count for the next call.
static void	setConnectTimeout(Configuration conf, int timeout) set the connection timeout value in configuration
static void	setPingInterval(Configuration conf, int pingInterval) set the ping interval value in configuration
void	stop() Stop all threads related to this client.

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

Client

public Client(Class<? extends Writable> valueClass,
      Configuration conf,
      SocketFactory factory)

Construct an IPC client whose values are of the given Writable class.

Client

public Client(Class<? extends Writable> valueClass,
      Configuration conf)

Construct an IPC client with the default SocketFactory

Parameters:

valueClass -

conf -

Method Detail

setCallIdAndRetryCount

public static void setCallIdAndRetryCount(int cid,
                          int rc)

Set call id and retry count for the next call.

setPingInterval

public static final void setPingInterval(Configuration conf,
                   int pingInterval)

set the ping interval value in configuration

Parameters:

conf - Configuration

pingInterval - the ping interval

getTimeout

public static final int getTimeout(Configuration conf)

The time after which a RPC will timeout. If ping is not enabled (via ipc.client.ping), then the timeout value is the same as the pingInterval. If ping is enabled, then there is no timeout value.

Parameters:

conf - Configuration

Returns:

the timeout period in milliseconds. -1 if no timeout value is set

setConnectTimeout

public static final void setConnectTimeout(Configuration conf,
                     int timeout)

set the connection timeout value in configuration

Parameters:

conf - Configuration

timeout - the socket connect timeout value

stop

public void stop()

Stop all threads related to this client. No further calls may be made using this client.

call

public Writable call(Writable param,
            InetSocketAddress address)
              throws IOException

Same as call(RPC.RpcKind, Writable, ConnectionId) for RPC_BUILTIN

Throws:

IOException

call

@Deprecated
public Writable call(RPC.RpcKind rpcKind,
                       Writable param,
                       InetSocketAddress address)
              throws IOException

Deprecated. Use call(RPC.RpcKind, Writable, ConnectionId) instead

Make a call, passing param, to the IPC server running at address, returning the value. Throws exceptions if there are network problems or if the remote code threw an exception.

Throws:

IOException

call

@Deprecated
public Writable call(RPC.RpcKind rpcKind,
                       Writable param,
                       InetSocketAddress addr,
                       UserGroupInformation ticket)
              throws IOException

Deprecated. Use call(RPC.RpcKind, Writable, ConnectionId) instead

Make a call, passing param, to the IPC server running at address with the ticket credentials, returning the value. Throws exceptions if there are network problems or if the remote code threw an exception.

Throws:

IOException

call

@Deprecated
public Writable call(RPC.RpcKind rpcKind,
                       Writable param,
                       InetSocketAddress addr,
                       Class<?> protocol,
                       UserGroupInformation ticket,
                       int rpcTimeout)
              throws IOException

Deprecated. Use call(RPC.RpcKind, Writable, ConnectionId) instead

Make a call, passing param, to the IPC server running at address which is servicing the protocol protocol, with the ticket credentials and rpcTimeout as timeout, returning the value. Throws exceptions if there are network problems or if the remote code threw an exception.

Throws:

IOException

call

public Writable call(Writable param,
            InetSocketAddress addr,
            Class<?> protocol,
            UserGroupInformation ticket,
            int rpcTimeout,
            Configuration conf)
              throws IOException

Same as call(RPC.RpcKind, Writable, InetSocketAddress, Class, UserGroupInformation, int, Configuration) except that rpcKind is writable.

Throws:

IOException

call

public Writable call(Writable param,
            InetSocketAddress addr,
            Class<?> protocol,
            UserGroupInformation ticket,
            int rpcTimeout,
            int serviceClass,
            Configuration conf)
              throws IOException

Same as call(Writable, InetSocketAddress, Class, UserGroupInformation, int, Configuration) except that specifying serviceClass.

Throws:

IOException

call

public Writable call(RPC.RpcKind rpcKind,
            Writable param,
            InetSocketAddress addr,
            Class<?> protocol,
            UserGroupInformation ticket,
            int rpcTimeout,
            Configuration conf)
              throws IOException

Make a call, passing param, to the IPC server running at address which is servicing the protocol protocol, with the ticket credentials, rpcTimeout as timeout and conf as conf for this connection, returning the value. Throws exceptions if there are network problems or if the remote code threw an exception.

Throws:

IOException

call

public Writable call(Writable param,
            Client.ConnectionId remoteId)
              throws IOException

Same as {link call(RPC.RpcKind, Writable, ConnectionId) except the rpcKind is RPC_BUILTIN

Throws:

IOException

call

public Writable call(RPC.RpcKind rpcKind,
            Writable rpcRequest,
            Client.ConnectionId remoteId)
              throws IOException

Make a call, passing rpcRequest, to the IPC server defined by remoteId, returning the rpc respond.

Parameters:

rpcKind -

rpcRequest - - contains serialized method and method parameters

remoteId - - the target rpc server

Throws:

IOException

call

public Writable call(RPC.RpcKind rpcKind,
            Writable rpcRequest,
            Client.ConnectionId remoteId,
            int serviceClass)
              throws IOException

Make a call, passing rpcRequest, to the IPC server defined by remoteId, returning the rpc respond.

Parameters:

rpcKind -

rpcRequest - - contains serialized method and method parameters

remoteId - - the target rpc server

serviceClass - - service class for RPC

Throws:

IOException

nextCallId

public static int nextCallId()

Returns the next valid sequential call ID by incrementing an atomic counter and masking off the sign bit. Valid call IDs are non-negative integers in the range [ 0, 2^31 - 1 ]. Negative numbers are reserved for special purposes. The values can overflow back to 0 and be reused. Note that prior versions of the client did not mask off the sign bit, so a server may still see a negative call ID if it receives connections from an old client.

Returns:

next call ID