org.apache.river.jeri.internal.mux

Class MuxClient

java.lang.Object

org.apache.river.jeri.internal.mux.MuxClient

public class MuxClient
extends Object

A MuxClient controls the client side of multiplexed connection.

Author:

Sun Microsystems, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_REQUESTS

Constructor Summary

Constructors

Constructor and Description
MuxClient(OutputStream out, InputStream in, long handshakeTimeout) Initiates the client side of the multiplexed connection over the given input/output stream pair.
MuxClient(SocketChannel channel, long handshakeTimeout)

Method Summary

Modifier and Type	Method and Description
protected void	handleDown() Handles indication that this multiplexed connection has gone down, either through normal operation or failure.
OutboundRequest	newRequest() Starts a new request over this connection, returning the corresponding OutboundRequest object.
protected void	populateContext(Collection context) Populates the context collection with information representing this connection.
int	requestsInProgress() Returns the current number of requests in progress over this connection.
void	shutdown(String message) Shuts down this multiplexed connection.
void	start() Starts I/O processing.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_REQUESTS

public static final int MAX_REQUESTS

See Also:

Constant Field Values

Constructor Detail

MuxClient

public MuxClient(OutputStream out,
                 InputStream in,
                 long handshakeTimeout)
          throws IOException

Initiates the client side of the multiplexed connection over the given input/output stream pair.

Parameters:

out - the output stream of the underlying connection

in - the input stream of the underlying connection

handshakeTimeout -

Throws:

IOException

MuxClient

public MuxClient(SocketChannel channel,
                 long handshakeTimeout)
          throws IOException

Throws:

IOException

Method Detail

newRequest

public OutboundRequest newRequest()
                           throws IOException

Starts a new request over this connection, returning the corresponding OutboundRequest object.

Returns:

the OutboundRequest for the newly created request

Throws:

IOException

requestsInProgress

public int requestsInProgress()
                       throws IOException

Returns the current number of requests in progress over this connection. The value is guaranteed to not increase until the next invocation of the newRequest method.

Returns:

the number of requests in progress over this connection

Throws:

IOException - if the multiplexed connection is no longer active

shutdown

public void shutdown(String message)

Shuts down this multiplexed connection. Requests in progress will throw IOException for future I/O operations.

Parameters:

message - reason for shutdown to be included in IOExceptions thrown from future I/O operations

populateContext

protected void populateContext(Collection context)

Populates the context collection with information representing this connection. This method should be overridden by subclasses to implement the desired behavior of the populateContext method for OutboundRequest instances generated for this connection.

start

public void start()
           throws IOException

Starts I/O processing. This method should be invoked only after this instance has been completely initialized, so that subclasses will not see uninitialized state.

Throws:

IOException

handleDown

protected void handleDown()

Handles indication that this multiplexed connection has gone down, either through normal operation or failure. This method should be overridden by subclasses that want to implement custom behavior when this connection has gone down.