org.aredis.net

Class ConnectionState

java.lang.Object

org.aredis.net.ConnectionState

public class ConnectionState
extends Object

Captures the Connection State for all AsyncSocketTransports connected to a given host and port. Please note that this is an internal class only relevant if you want to add a new AsyncSocketTransport.

Author:

suresh

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_MAX_RETRY_INTERVAL The default value of maxRetryInterval.
static long	INIT_RETRY_INTERVAL The starting Retry interval in milliseconds
long	maxRetryInterval max retry interval for this server.

Constructor Summary

Constructors

Constructor and Description
ConnectionState() Creates a new ConnectionState.

Method Summary

Methods

Modifier and Type	Method and Description
ConnectionStatus	checkRetry(AsyncHandler<ConnectionStatus> callBack) This method is to be called when the getStatus method returns RETRY.
long	getDownSince() Milliseconds time when the connection was found to be down.
static ConnectionState	getInstance(String serverKey) Gets the connection state for the given server.
long	getLastDownTime() Milliseconds time when the connection was found to be down.
Throwable	getLastException() The last exception for which updateStatus call.
long	getRetryInterval() Current Retry Interval when retrying broken connections.
void	updateStatus(ConnectionStatus status, Throwable exception) Method called to update the connectionStatus after a successful connection or if an error occurs in connection.

Methods inherited from class java.lang.Object

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

Field Detail

INIT_RETRY_INTERVAL

public static final long INIT_RETRY_INTERVAL

The starting Retry interval in milliseconds

See Also:

Constant Field Values

DEFAULT_MAX_RETRY_INTERVAL

public static final long DEFAULT_MAX_RETRY_INTERVAL

The default value of maxRetryInterval. Default is 2 minutes.

See Also:

Constant Field Values

maxRetryInterval

public volatile long maxRetryInterval

max retry interval for this server.

Constructor Detail

ConnectionState

public ConnectionState()

Creates a new ConnectionState.

Method Detail

getInstance

public static ConnectionState getInstance(String serverKey)

Gets the connection state for the given server. Returns a common instance for a given serverKey.

Parameters:

serverKey - Server Key in the form host:port

Returns:

Connection State for the server

checkRetry

public ConnectionStatus checkRetry(AsyncHandler<ConnectionStatus> callBack)

This method is to be called when the getStatus method returns RETRY. If this method returns RETRY then the caller should try to connect and update the result of the attempt as DOWN or OK by calling updateStatus. RETRY is returned for only one of the callers for a given server. The others get null as a response and are called back with the status via updateStatus.

Parameters:

callBack - Callback to be called with the connection status if another connection is making a retry on the same server.

Returns:

null if another connection is making a RETRY in which case a call is made on the callBack with the status. RETRY indicating the caller has to try to connect. DOWN to indicate that the conneciton is DOWN.

updateStatus

public void updateStatus(ConnectionStatus status,
                Throwable exception)

Method called to update the connectionStatus after a successful connection or if an error occurs in connection.

Parameters:

status - ConnectionStatus indicating connection status

exception - Exception which was thrown

getLastException

public Throwable getLastException()

The last exception for which updateStatus call.

Returns:

last exception

getRetryInterval

public long getRetryInterval()

Current Retry Interval when retrying broken connections.

Returns:

retry interval in milliseconds

getDownSince

public long getDownSince()

Milliseconds time when the connection was found to be down.

Returns:

milliseconds time when the connection was last down

getLastDownTime

public long getLastDownTime()

Milliseconds time when the connection was found to be down. This is not reset on re-connection. The connection is re-tried if there was a downtime since a connection was made.

Returns:

Last time when one of the AsyncRedisConnection's had a downtime with this server