org.jredis.ri.alphazero.connection

Class PipelineConnectionBase

java.lang.Object

org.jredis.ri.alphazero.connection.ConnectionBase

org.jredis.ri.alphazero.connection.PipelineConnectionBase

All Implemented Interfaces:

Connection

Direct Known Subclasses:

AsyncPipelineConnection, SyncPipelineConnection

public abstract class PipelineConnectionBase
extends ConnectionBase

Abstract base for all Pipeline connections, providing basically all of the required functionality for a pipeline with asynchronous semantics. Synchronous pipelines can simply call the PipelineConnectionBase#queueRequest(Command, byte[]) method in their implementation of the synchronous Connection#serviceRequest(Command, byte[]) method and block on Future.get() to realize the blocking semantics and results required.

Since:

alpha.0

Version:

alpha.0, Sep 7, 2009

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PipelineConnectionBase.ResponseHandler Provides the response processing logic as a Runnable.

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 java.util.concurrent.CountDownLatch	connectionEstablished counted down on notifyConnect
private java.util.concurrent.atomic.AtomicBoolean	isActive used by the Pipeline to indicate its state.
private boolean	pendingQuit flag (default false) indicates if a pending QUIT command is being processed.
(package private) java.util.concurrent.BlockingQueue<PendingRequest>	pendingResponseQueue
private PipelineConnectionBase.ResponseHandler	respHandler
private java.lang.Thread	respHandlerThread
private java.lang.Object	serviceLock synchronization object used to serialize request queuing

Fields inherited from class org.jredis.ri.alphazero.connection.ConnectionBase

spec, thrdProtocol

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PipelineConnectionBase(ConnectionSpec spec)

Method Summary

Modifier and Type	Method and Description
protected void	initializeComponents() Extension point: child classes may override for additional components:
protected java.io.InputStream	newInputStream(java.io.InputStream socketInputStream) Just make sure its a FastBufferedInputStream.
protected Protocol	newProtocolHandler() Pipeline must use a concurrent protocol handler.
protected void	notifyConnected() Extension point -- callback on this method when ConnectionBase has connected to server.
protected void	notifyDisconnected() Extension point -- callback on this method when ConnectionBase has disconnected from server.
(package private) void	onResponseHandlerError(ClientRuntimeException cre, PendingRequest request)
java.util.concurrent.Future<Response>	queueRequest(Command cmd, byte[]... args) This is a pseudo asynchronous method.

Methods inherited from class org.jredis.ri.alphazero.connection.ConnectionBase

addListener, connect, disconnect, getInputStream, getOutputStream, getProtocolHandler, getSpec, initializeAsyncConnection, initializeOnConnect, initializeSocketStreams, initializeSyncConnection, isConnected, newOutputStream, notifyFaulted, notifyListeners, notifyShuttingDown, onConnectionFault, reconnect, removeListener, serviceRequest, shutdown, toString

Methods inherited from class java.lang.Object

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

Field Detail

respHandler

private PipelineConnectionBase.ResponseHandler respHandler

respHandlerThread

private java.lang.Thread respHandlerThread

pendingResponseQueue

java.util.concurrent.BlockingQueue<PendingRequest> pendingResponseQueue

serviceLock

private java.lang.Object serviceLock

synchronization object used to serialize request queuing

pendingQuit

private boolean pendingQuit

flag (default false) indicates if a pending QUIT command is being processed. If true, any calls to queueRequests will result in a raise runtime exception

isActive

private java.util.concurrent.atomic.AtomicBoolean isActive

used by the Pipeline to indicate its state. Set to true on connect and false on Quit/Close

connectionEstablished

private java.util.concurrent.CountDownLatch connectionEstablished

counted down on notifyConnect

Constructor Detail

PipelineConnectionBase

protected PipelineConnectionBase(ConnectionSpec spec)
                          throws ClientRuntimeException

Parameters:

spec -

Throws:

ClientRuntimeException

Method Detail

initializeComponents

protected void initializeComponents()

Description copied from class: ConnectionBase

Extension point: child classes may override for additional components:

 In the extended class:
 
 protected void initializeComponents() {
    super.initializeComponents();
    // my components here ...
    //
 }
 
 

Overrides:

initializeComponents in class ConnectionBase

notifyConnected

protected void notifyConnected()

Description copied from class: ConnectionBase

Extension point -- callback on this method when ConnectionBase has connected to server. It is important to note that the extension must call super.notifyConnected if reliable service (using heartbeats) is required!.

Overrides:

notifyConnected in class ConnectionBase

notifyDisconnected

protected void notifyDisconnected()

Description copied from class: ConnectionBase

Extension point -- callback on this method when ConnectionBase has disconnected from server. It is important to note that the extension must call super.notifyDisconnected if reliable service (using heartbeats) is required!.

Overrides:

notifyDisconnected in class ConnectionBase

newProtocolHandler

protected Protocol newProtocolHandler()

Pipeline must use a concurrent protocol handler.

Overrides:

newProtocolHandler in class ConnectionBase

Returns:

See Also:

ConnectionBase.newProtocolHandler()

newInputStream

protected final java.io.InputStream newInputStream(java.io.InputStream socketInputStream)
                                            throws java.lang.IllegalArgumentException

Just make sure its a FastBufferedInputStream.

Overrides:

newInputStream in class ConnectionBase

Returns:

Throws:

java.lang.IllegalArgumentException

queueRequest

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

This is a pseudo asynchronous method. The actual write to server does occur in this method, so when this method returns, your request has been sent. This simply defers the response read to the response handler.

Other item of note is that once a QUIT request has been queued, no further requests are accepted and a ClientRuntimeException is thrown.

Specified by:

queueRequest in interface Connection

Overrides:

queueRequest in class ConnectionBase

Returns:

the Future Response.

Throws:

ClientRuntimeException

ProviderException

See Also:

ConnectionBase.queueRequest(org.jredis.protocol.Command, byte[][])

onResponseHandlerError

void onResponseHandlerError(ClientRuntimeException cre,
                            PendingRequest request)