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

Field Summary

static org.apache.commons.logging.Log

LOG

Constructor Summary

Client(Class<?> valueClass, Configuration conf)
Construct an IPC client with the default SocketFactory

Client(Class valueClass, Configuration conf, SocketFactory factory)
Construct an IPC client whose values are of the given Writable class.

Method Summary

Writable[]	call(Writable[] params, InetSocketAddress[] addresses) Makes a set of calls in parallel.
Writable	call(Writable param, InetSocketAddress address) Make a call, passing param, to the IPC server running at address, returning the value.
Writable	call(Writable param, InetSocketAddress addr, UserGroupInformation ticket)
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 valueClass,
              Configuration conf,
              SocketFactory factory)

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

Client

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

Construct an IPC client with the default SocketFactory

Parameters:

valueClass -

conf -

Method Detail

setPingInterval

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

set the ping interval value in configuration

Parameters:

conf - Configuration

pingInterval - the ping interval

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 InterruptedException,
                     IOException

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:

InterruptedException

IOException

call

public Writable call(Writable param,
                     InetSocketAddress addr,
                     UserGroupInformation ticket)
              throws InterruptedException,
                     IOException

Throws:

InterruptedException

IOException

call

public Writable[] call(Writable[] params,
                       InetSocketAddress[] addresses)
                throws IOException

Makes a set of calls in parallel. Each parameter is sent to the corresponding address. When all values are available, or have timed out or errored, the collected results are returned in an array. The array contains nulls for calls that timed out or errored.

Throws:

IOException