org.aredis.net

Interface AsyncSocketTransport

All Superinterfaces:

ServerInfo

All Known Implementing Classes:

AbstractAsyncSocketTransport, AsyncJavaSocketTransport

public interface AsyncSocketTransport
extends ServerInfo

Specifies an Async Socket Transport interface that can be used by AsyncRedisConnection to connect to a Redis Server.

Author:

suresh

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the Socket connection.
void	connect(AsyncHandler<Boolean> handler) Connects to Socket and calls handler with true on success and false with Exception on failure.
boolean	flush(AsyncHandler<Integer> handler) Flushes bytes in buffer to Socket Output.
AsyncSocketTransportConfig	getConfig() Gets the AsyncSocketTransport config in use.
long	getDownSince() Returns the millisecond time since this connection was down.
long	getRetryInterval() The current retry interval as per the exponential fall back calculation.
ConnectionStatus	getStatus() Returns the Connection Status
boolean	isStale() Checks if the connection is stale as per configured idle timeout.
int	read(OutputStream dest, int maxBytes, AsyncHandler<Integer> handler) Reads atleast 1 byte and a max of upto maxBytes writing bytes read to specified Stream.
boolean	requiresFlush() Whether the Socket Output requires a flush to transfer bytes in buffer.
void	setConfig(AsyncSocketTransportConfig pconfig) Sets the AsyncSocketTransport config to use.
int	write(byte[] b, int ofs, int len, AsyncHandler<Integer> handler) Writes specified bytes to Output Stream.

Methods inherited from interface org.aredis.net.ServerInfo

getConnectionString, getHost, getPort, getServerIndex

Method Detail

connect

void connect(AsyncHandler<Boolean> handler)

Connects to Socket and calls handler with true on success and false with Exception on failure.

Parameters:

handler - Handler to call

read

int read(OutputStream dest,
       int maxBytes,
       AsyncHandler<Integer> handler)

Reads atleast 1 byte and a max of upto maxBytes writing bytes read to specified Stream.

Parameters:

dest - OutputStream to write bytes Read

maxBytes - max Bytes to read

handler - handler to call in case of Async operation

Returns:

0 if Operation will be completed by callback to handler with bytes read or positive value indicating actual bytes read immediately in which case handler will not be called.

write

int write(byte[] b,
        int ofs,
        int len,
        AsyncHandler<Integer> handler)

Writes specified bytes to Output Stream.

Parameters:

b - Byte Array containing bytes to write

ofs - offset to write from

len - number of bytes to write

handler - handler to call in case of Async operation. The handler is called after all bytes have been written with the number of bytes actaully transferred to the Socket Output.

Returns:

len if all bytes can be transferred immediately to local buffer in in which case handler will not be called. 0 if it requires an Async operation in which case handler is called on completion with bytes actually transferred to socket Output (The remaining bytes will be in buffer).

requiresFlush

boolean requiresFlush()

Whether the Socket Output requires a flush to transfer bytes in buffer.

Returns:

true if flush is required

flush

boolean flush(AsyncHandler<Integer> handler)

Flushes bytes in buffer to Socket Output. May require repeated calls.

Parameters:

handler - Callback handler in case flush is required. The handler is called with bytes transferred if further flush call is required or a negative value of -bytes transferred if further flush call is not required.

Returns:

true if flush is required, false if not required in which case handler is not called.

close

void close()
           throws IOException

Closes the Socket connection. Can be opened again by calling connect.

Throws:

IOException

getStatus

ConnectionStatus getStatus()

Returns the Connection Status

Returns:

Connection Status

isStale

boolean isStale()

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.

Returns:

True if the connection is Stale

getConfig

AsyncSocketTransportConfig getConfig()

Gets the AsyncSocketTransport config in use.

Returns:

config in use

setConfig

void setConfig(AsyncSocketTransportConfig pconfig)

Sets the AsyncSocketTransport config to use.

Parameters:

pconfig - to use

getDownSince

long getDownSince()

Returns the millisecond time since this connection was down. This could be common to all connections to the same server.

Returns:

millisecond time since this connection was down, 0 if the connection is not down

getRetryInterval

long getRetryInterval()

The current retry interval as per the exponential fall back calculation. This could be common to all connections to the same server.

Returns:

Current retry interval