org.jredis.ri.alphazero.connection

Class ConnectionBase

java.lang.Object

org.jredis.ri.alphazero.connection.ConnectionBase

All Implemented Interfaces:

Connection

Direct Known Subclasses:

AsyncConnection, ChunkedPipelineConnection, PipelineConnectionBase, SyncConnection

public abstract class ConnectionBase
extends java.lang.Object
implements Connection

This abstract class is responsible for managing the socket connection, and, defining the template of the Connection for concrete extensions. Given that, it basically manages all the details of dealing with Socket, and maintains the reference to the handler.

Further, it provides the default NotSupportedException response for the Connection's methods that the extending classes of various Connection.Modality are expected to support. (They would simply implement the method that they support.)

Since:

alpha.0

Version:

alpha.0, Apr 20, 2009-2011

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 java.io.InputStream	instream
private boolean	isConnected
private java.util.Set<Connection.Listener>	listeners Connector Listeners
private java.io.OutputStream	outstream
private java.net.Socket	socket socket reference -- a new instance obtained in newSocketConnect()
private java.net.InetSocketAddress	socketAddress address of the socket connection
protected ConnectionSpec	spec Connection specs used to create this Connection
(package private) java.lang.ThreadLocal<Protocol>	thrdProtocol Thread specific protocol handler -- optimize fencing Protocol specific matters are delegated to an instance of Protocol

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConnectionBase(ConnectionSpec spec) Will create and initialize a socket per the connection spec.

Method Summary

Modifier and Type	Method and Description
boolean	addListener(Connection.Listener connListener) Optional
protected void	connect()
protected void	disconnect()
protected java.io.InputStream	getInputStream()
protected java.io.OutputStream	getOutputStream()
protected Protocol	getProtocolHandler()
ConnectionSpec	getSpec() The ConnectionSpec of a Connection must be invariant during its life-cycle.
protected void	initializeAsyncConnection()
protected void	initializeComponents() Extension point: child classes may override for additional components:
protected void	initializeOnConnect()
protected void	initializeSocketStreams()
protected void	initializeSyncConnection()
protected boolean	isConnected()
protected java.io.InputStream	newInputStream(java.io.InputStream socketInputStream) Extension point: override to return stream per requirement.
protected java.io.OutputStream	newOutputStream(java.io.OutputStream socketOutputStream) Extension point: override to return stream per requirement.
protected Protocol	newProtocolHandler() Extension point: child classes may override to return specific Protocol implementations per their requirements.
private void	newSocketConnect() Instantiates a new Socket, sets its properties and flags using the spec and finally connects to the socketAddress.
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.
protected void	notifyFaulted(java.lang.String info)
protected void	notifyListeners(Connection.Event e)
protected void	notifyShuttingDown()
protected void	onConnectionFault(java.lang.String fault, boolean raiseEx) Will throw a ClientRuntimeException if raiseEx is true
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.
protected void	reconnect() Attempt reconnect.
boolean	removeListener(Connection.Listener connListener) Optional
Response	serviceRequest(Command cmd, byte[]... args) A blocking call to service the specified request.
protected void	shutdown()
private void	socketClose()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

thrdProtocol

java.lang.ThreadLocal<Protocol> thrdProtocol

Thread specific protocol handler -- optimize fencing Protocol specific matters are delegated to an instance of Protocol

spec

protected final ConnectionSpec spec

Connection specs used to create this Connection

isConnected

private boolean isConnected

socket

private java.net.Socket socket

socket reference -- a new instance obtained in newSocketConnect()

instream

private java.io.InputStream instream

outstream

private java.io.OutputStream outstream

listeners

private final java.util.Set<Connection.Listener> listeners

Connector Listeners

socketAddress

private final java.net.InetSocketAddress socketAddress

address of the socket connection

Constructor Detail

ConnectionBase

protected ConnectionBase(ConnectionSpec spec)
                  throws ClientRuntimeException

Will create and initialize a socket per the connection spec.

Parameters:

spec -

connectImmediately - will connect the socket immediately if true

Throws:

ClientRuntimeException - if connection attempt to specified host is not possible and connect immediate was requested.

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)

Optional

Specified by:

addListener in interface Connection

Parameters:

connListener -

Returns:

removeListener

public final boolean removeListener(Connection.Listener connListener)

Optional

Specified by:

removeListener in interface Connection

Parameters:

connListener -

Returns:

initializeComponents

protected void initializeComponents()

Extension point: child classes may override for additional components:

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

notifyConnected

protected void notifyConnected()

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!.

notifyDisconnected

protected void notifyDisconnected()

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!.

notifyFaulted

protected void notifyFaulted(java.lang.String info)

notifyShuttingDown

protected void notifyShuttingDown()

newProtocolHandler

protected Protocol newProtocolHandler()

Extension point: child classes may override to return specific Protocol implementations per their requirements.

Returns:

newInputStream

protected java.io.InputStream newInputStream(java.io.InputStream socketInputStream)

Extension point: override to return stream per requirement. Base implementation uses FastBufferedInputStream by default, with buffer size matching the SO_RCVBUF property of the Connection's ConnectionSpec

Parameters:

socketInputStream -

Returns:

newOutputStream

protected java.io.OutputStream newOutputStream(java.io.OutputStream socketOutputStream)

Extension point: override to return stream per requirement. Base implementation simply returns the input param

Parameters:

socketOutputStream -

Returns:

notifyListeners

protected final void notifyListeners(Connection.Event e)

isConnected

protected final boolean isConnected()

Returns:

connected status

reconnect

protected final void reconnect()

Attempt reconnect. Must be in a (previously) connected state when called.

Throws:

java.lang.IllegalStateException - if not (logically) connected.

onConnectionFault

protected final void onConnectionFault(java.lang.String fault,
                                       boolean raiseEx)
                                throws ClientRuntimeException

Will throw a ClientRuntimeException if raiseEx is true

Throws:

java.lang.IllegalStateException

ClientRuntimeException

connect

protected final void connect()
                      throws java.lang.IllegalStateException,
                             ClientRuntimeException

Throws:

java.io.IOException

java.lang.IllegalStateException

ClientRuntimeException

disconnect

protected final void disconnect()
                         throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

shutdown

protected final void shutdown()
                       throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

newSocketConnect

private final void newSocketConnect()
                             throws java.io.IOException

Instantiates a new Socket, sets its properties and flags using the spec and finally connects to the socketAddress.

Note that if the platform default send and receive buffers are larger than that specified, this method will not use the (smaller) values defined in the spec.

Further note that method will not check connection state.

Throws:

java.io.IOException - thrown by the socket object.

socketClose

private final void socketClose()

initializeSocketStreams

protected final void initializeSocketStreams()
                                      throws java.lang.IllegalArgumentException,
                                             java.io.IOException

Throws:

java.lang.IllegalStateException - if socket is null

java.io.IOException - thrown by socket instance stream accessors

java.lang.IllegalArgumentException

initializeOnConnect

protected final void initializeOnConnect()
                                  throws ProviderException,
                                         ClientRuntimeException,
                                         RedisException

Throws:

RedisException

ClientRuntimeException

ProviderException

initializeSyncConnection

protected final void initializeSyncConnection()
                                       throws ProviderException,
                                              ClientRuntimeException,
                                              RedisException

Throws:

ProviderException

ClientRuntimeException

RedisException

initializeAsyncConnection

protected final void initializeAsyncConnection()
                                        throws ProviderException,
                                               ClientRuntimeException,
                                               RedisException

Throws:

ProviderException

ClientRuntimeException

RedisException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getProtocolHandler

protected final Protocol getProtocolHandler()

getOutputStream

protected final java.io.OutputStream getOutputStream()

getInputStream

protected final java.io.InputStream getInputStream()