org.jredis.connector

Class FaultedConnection

java.lang.Object

org.jredis.connector.FaultedConnection

All Implemented Interfaces:

Connection

public class FaultedConnection
extends java.lang.Object
implements Connection

FaultedConnection is a support class for implementors of JRedis API.

Since:

alpha.0

Version:

alpha.0, Apr 11, 2009

Nested Class Summary

Nested classes/interfaces inherited from interface org.jredis.connector.Connection

Connection.Event, Connection.Factory, Connection.Flag, Connection.Listener, Connection.Modality, Connection.Property, Connection.Socket, Connection.State

Field Summary

Fields

Modifier and Type	Field and Description
private ConnectionSpec	connSpec
private java.lang.String	errorMsg

Constructor Summary

Constructors

Constructor and Description
FaultedConnection(ConnectionSpec connSpec, java.lang.String errMsg) instantiates a faulted connection for the given ConnectionSpec

Method Summary

Modifier and Type	Method and Description
boolean	addListener(Connection.Listener connListener) Connection.Event propagation.
ConnectionSpec	getSpec() The ConnectionSpec of a Connection must be invariant during its life-cycle.
java.util.concurrent.Future<Response>	queueRequest(Command cmd, byte[]... args) A non-blocking call to service the specified request at some point in the future.
boolean	removeListener(Connection.Listener connListener) Optional event propagation method.
Response	serviceRequest(Command cmd, byte[]... args) A blocking call to service the specified request.

Methods inherited from class java.lang.Object

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

Field Detail

errorMsg

private final java.lang.String errorMsg

connSpec

private final ConnectionSpec connSpec

Constructor Detail

FaultedConnection

public FaultedConnection(ConnectionSpec connSpec,
                         java.lang.String errMsg)

instantiates a faulted connection for the given ConnectionSpec

Parameters:

connSpec -

errMsg -

Method Detail

getSpec

public ConnectionSpec getSpec()

Description copied from interface: Connection

The ConnectionSpec of a Connection must be invariant during its life-cycle.

Specified by:

getSpec in interface Connection

Returns:

the associated ConnectionSpec for this Connection.

serviceRequest

public Response serviceRequest(Command cmd,
                               byte[]... args)
                        throws RedisException,
                               ClientRuntimeException,
                               ProviderException

Description copied from interface: Connection

A blocking call to service the specified request. This method will return upon the completion of the request response protocol with the connected redis server. Timeouts and related matters are not addressed by this method or the Protocol interface and can (and should) be addressed at the implementation level (for example when creating handler instances using a specification set, including max wait for synchronous response.)

Connection.Modality.Asynchronous handlers must always throw a ClientRuntimeException for this method which violates the contract for Connection.Modality.Asynchronous handlers.

Specified by:

serviceRequest in interface Connection

Returns:

Throws:

RedisException

ClientRuntimeException

ProviderException

queueRequest

public java.util.concurrent.Future<Response> queueRequest(Command cmd,
                                                          byte[]... args)
                                                   throws ClientRuntimeException,
                                                          ProviderException

Description copied from interface: Connection

A non-blocking call to service the specified request at some point in the future. This method will return immediately with a Future object of parametric type Response

When the request is serviced, call to Future.get() will return the request response.

Connection.Modality.Synchronous handlers must always throw a ClientRuntimeException for this method which violates the contract for Connection.Modality.Synchronous handlers.

If request resulted in a redis error (RedisException), the exception will be set as the cause of the corresponding ExecutionException of the Future object returned.

Specified by:

queueRequest in interface Connection

Returns:

the Future Response.

Throws:

ClientRuntimeException

ProviderException

See Also:

Future, ExecutionException

addListener

public final boolean addListener(Connection.Listener connListener)

Description copied from interface: Connection

Connection.Event propagation.

Specified by:

addListener in interface Connection

Returns:

true if listener was successfully added.

removeListener

public final boolean removeListener(Connection.Listener connListener)

Description copied from interface: Connection

Optional event propagation method. Removes the specified listenr from the list of Connection.Listeners.

Specified by:

removeListener in interface Connection

Returns:

true if the listener was actually present and was removed.