AbstractAsyncSocketTransport (AREDIS API)

java.lang.Object
- org.aredis.net.AbstractAsyncSocketTransport

All Implemented Interfaces:

AsyncSocketTransport, ServerInfo

Direct Known Subclasses:

AsyncJavaSocketTransport
```
public abstract class AbstractAsyncSocketTransport
extends Object
implements AsyncSocketTransport
```
Provides a base implementation of AsyncSocketTransport which provides connection status handling and a retry mechanism. It maintains a common ConnectionState for all connections to the same host and port and issues only one retry for all connections.

Author:

suresh

Field Summary

Fields
Modifier and Type	Field and Description
`protected AsyncSocketTransportConfig`	`config`
`protected ConnectionStatus`	`connectionStatus` ConnectionStatus of this connection.
`protected String`	`connectionString`
`protected String`	`host`
`protected long`	`lastConnectTime` Last time a successful connection was made.
`protected long`	`lastUseTime` Last time this connection was used.
`protected int`	`port`
`protected int`	`serverIndex`
`protected AsyncSocketTransportFactory`	`transportFactory`

Constructor Summary

Constructors
Constructor and Description

AbstractAsyncSocketTransport(String phost, int pport)

Constructors
Constructor and Description
`AbstractAsyncSocketTransport(String phost, int pport)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`connect(AsyncHandler<Boolean> handler)` Connects to Socket and calls handler with true on success and false with Exception on failure.
`protected abstract void`	`connectInternal(AsyncHandler<Boolean> handler)` Connect Method to be implemented by sub-class.
`AsyncSocketTransportConfig`	`getConfig()` Gets the AsyncSocketTransport config in use.
`String`	`getConnectionString()` Gets the Connection String in the form of host:port so that it does not have to be constructed each time.
`long`	`getDownSince()` Returns the millisecond time since this connection was down.
`String`	`getHost()` Gets the host.
`int`	`getPort()` Gets the port.
`long`	`getRetryInterval()` The current retry interval as per the exponential fall back calculation.
`int`	`getServerIndex()` Gets an index identifying the server.
`ConnectionStatus`	`getStatus()` Returns the Connection Status
`AsyncSocketTransportFactory`	`getTransportFactory()` Returns the transportFactory for this connection.
`boolean`	`isStale()` Checks if the connection is stale as per configured idle timeout.
`void`	`setConfig(AsyncSocketTransportConfig pconfig)` Sets the AsyncSocketTransport config to use.
`String`	`toString()` Returns a String representation containing the host and port.
`protected void`	`updateConnectionStatus(ConnectionStatus status, Throwable e)` Method to update the connection status.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.aredis.net.AsyncSocketTransport
close, flush, read, requiresFlush, write

- Field Detail
  - host
```
protected final String host
```
  - port
```
protected final int port
```
  - connectionString
```
protected final String connectionString
```
  - serverIndex
```
protected int serverIndex
```
  - transportFactory
```
protected AsyncSocketTransportFactory transportFactory
```
  - config
```
protected AsyncSocketTransportConfig config
```
  - lastUseTime
```
protected long lastUseTime
```
    Last time this connection was used. Reads and writes of implementation should update this to current time.
  - lastConnectTime
```
protected long lastConnectTime
```
    Last time a successful connection was made. This has to be updated by the implementation.
  - connectionStatus
```
protected volatile ConnectionStatus connectionStatus
```
    ConnectionStatus of this connection.
- Constructor Detail
  - AbstractAsyncSocketTransport
```
public AbstractAsyncSocketTransport(String phost,
                            int pport)
```
    Parameters:
    phost - Server Host
    pport - Server Port
- Method Detail
  - connectInternal
```
protected abstract void connectInternal(AsyncHandler<Boolean> handler)
```
    Connect Method to be implemented by sub-class. The connect implementation in this class calls this to establish the socket connection.
    
    Parameters:
    handler - handler to call when connection is completed
  - updateConnectionStatus
```
protected void updateConnectionStatus(ConnectionStatus status,
                          Throwable e)
```
    Method to update the connection status. This is provided for the concrete sub-class to update the connection status. So this should be called with DOWN whenever a Async socket read or write fails and should be called with OK when a connection succeeds.
    
    Parameters:
    status - New Connection Status
    e - Exception in case the Connection Status is DOWN
  - getStatus
```
public ConnectionStatus getStatus()
```
    Description copied from interface: AsyncSocketTransport
    
    Returns the Connection Status
    
    Specified by:
    
    getStatus in interface AsyncSocketTransport
    
    Returns:
    Connection Status
  - connect
```
public void connect(AsyncHandler<Boolean> handler)
```
    Description copied from interface: AsyncSocketTransport
    
    Connects to Socket and calls handler with true on success and false with Exception on failure.
    
    Specified by:
    
    connect in interface AsyncSocketTransport
    
    Parameters:
    handler - Handler to call
  - getTransportFactory
```
public AsyncSocketTransportFactory getTransportFactory()
```
    Returns the transportFactory for this connection.
    
    Returns:
    TransportFactory
  - getDownSince
```
public long getDownSince()
```
    Description copied from interface: AsyncSocketTransport
    
    Returns the millisecond time since this connection was down. This could be common to all connections to the same server.
    
    Specified by:
    
    getDownSince in interface AsyncSocketTransport
    
    Returns:
    millisecond time since this connection was down, 0 if the connection is not down
  - getRetryInterval
```
public long getRetryInterval()
```
    Description copied from interface: AsyncSocketTransport
    
    The current retry interval as per the exponential fall back calculation. This could be common to all connections to the same server.
    
    Specified by:
    
    getRetryInterval in interface AsyncSocketTransport
    
    Returns:
    Current retry interval
  - getConfig
```
public AsyncSocketTransportConfig getConfig()
```
    Description copied from interface: AsyncSocketTransport
    
    Gets the AsyncSocketTransport config in use.
    
    Specified by:
    
    getConfig in interface AsyncSocketTransport
    
    Returns:
    config in use
  - setConfig
```
public void setConfig(AsyncSocketTransportConfig pconfig)
```
    Description copied from interface: AsyncSocketTransport
    
    Sets the AsyncSocketTransport config to use.
    
    Specified by:
    
    setConfig in interface AsyncSocketTransport
    
    Parameters:
    pconfig - to use
  - isStale
```
public boolean isStale()
```
    Description copied from interface: AsyncSocketTransport
    
    Checks if the connection is stale as per configured idle timeout. This method differs from getStatus in that it checks only for the last use time and not the current connection state if it is OK, DOWN or CLOSED.
    
    Specified by:
    
    isStale in interface AsyncSocketTransport
    
    Returns:
    True if the connection is Stale
  - toString
```
public String toString()
```
    Returns a String representation containing the host and port.
    
    Overrides:
    
    toString in class Object
  - getHost
```
public String getHost()
```
    Description copied from interface: ServerInfo
    
    Gets the host.
    
    Specified by:
    
    getHost in interface ServerInfo
    
    Returns:
    Server host
  - getPort
```
public int getPort()
```
    Description copied from interface: ServerInfo
    
    Gets the port.
    
    Specified by:
    
    getPort in interface ServerInfo
    
    Returns:
    Server Port
  - getConnectionString
```
public String getConnectionString()
```
    Description copied from interface: ServerInfo
    
    Gets the Connection String in the form of host:port so that it does not have to be constructed each time.
    
    Specified by:
    
    getConnectionString in interface ServerInfo
    
    Returns:
    Connection String
  - getServerIndex
```
public int getServerIndex()
```
    Description copied from interface: ServerInfo
    
    Gets an index identifying the server. The index should be in the constructor and saved as a field. Please refer to the source code of AbstractAsyncSocketTransport.java to see the implementation.
    
    Specified by:
    
    getServerIndex in interface ServerInfo
    
    Returns:
    An index uniquely identifying this server. Indexes start from 0 and are sequential

Class AbstractAsyncSocketTransport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.aredis.net.AsyncSocketTransport

Field Detail

host

port

connectionString

serverIndex

transportFactory

config

lastUseTime

lastConnectTime

connectionStatus

Constructor Detail

AbstractAsyncSocketTransport

Method Detail

connectInternal

updateConnectionStatus

getStatus

connect

getTransportFactory

getDownSince

getRetryInterval

getConfig

setConfig

isStale

toString

getHost

getPort

getConnectionString

getServerIndex