org.aredis.cache

Class AsyncRedisConnection

java.lang.Object

org.aredis.cache.AbstractAsyncRedisClient

org.aredis.cache.AsyncRedisConnection

All Implemented Interfaces:

AsyncRedisClient

public class AsyncRedisConnection
extends AbstractAsyncRedisClient

This is the pipelined asynchronous implementation of AsyncRedisClient that is the basis of aredis.

Author:

suresh

Field Summary

Fields

Modifier and Type	Field and Description
static ExecutorService	bootstrapExecutor Executor used to initialize the pipeline when there is no NIO request listener.
static ClassDescriptorStorageFactory	DEFAULT_CLASS_DESCRIPTOR_STORAGE_FACTORY Default Per Connection Class Descriptor Storage used by OPTI_JAVA_HANDLER.
static DataHandler	DEFAULT_HANDLER The Default Data Handler if none is configured.
static int	DEFAULT_MAX_PIPELINE_SIZE Default value of max pipeline size to restrict the number of commands in pipeline after which the request processing is suspended till the pipeline size reduces.
static DataHandler	JAVA_HANDLER This DataHandler is an instance of JavaHandler with normal Object serialization.
static DataHandler	JAVA_HANDLER_NO_COMPRESS Identical to JAVA_HANDLER but without compression.
static DataHandler	KEY_HANDLER This DataHandler is an instance of StringHandler.
static int	MAX_SHUTDOWN_WAIT_MILLIS
static DataHandler	OPTI_JAVA_HANDLER This DataHandler is an instance of JavaHandler.
static DataHandler	OPTI_JAVA_HANDLER_NO_COMPRESS Identical to OPTI_JAVA_HANDLER but without compression.
static Thread	shutDownHook
protected Executor	taskExecutor Task executor for invoking completionHandlers for Async commands.

Constructor Summary

Constructors

Constructor and Description
AsyncRedisConnection(AsyncSocketTransport pcon, int pdbIndex, Executor ptaskExecutor) Constructor to create a SHARED AsyncRedisConnection.
AsyncRedisConnection(AsyncSocketTransport pcon, int pdbIndex, Executor ptaskExecutor, ConnectionType pconnectionType) Constructor to create an AsyncRedisConnection of the given connection type.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeStaleConnection() Closes the connection if it has been idle beyond the configured idle timeout or the Redis Server timeout.
AsyncSocketTransport	getConnection() Returns the Async Socket Transport used
DataHandler	getDataHandler() The default DataHandler for commands
int	getDbIndex() Returns the DB Index of the connection
int	getMaxPipelineSize() Max Pipeline Size
static void	setBootstrapExecutorPoolSize(int poolSize) Method to change the size of the bootstrapExecutor
void	setDataHandler(DataHandler pdataHandler) Sets the default DataHandler for commands
void	setMaxPipelineSize(int pmaxPipelineSize) Sets the max number of commands pending for response in the Redis Server.
void	shutdown(long delayMillis) Shutdown the connection.
Future<RedisCommandInfo>	submitCommand(RedisCommandInfo command, AsyncHandler<RedisCommandInfo> completionHandler, boolean requireFutureResult, boolean isSyncCallback) Submit a Redis Command.
Future<RedisCommandInfo[]>	submitCommands(RedisCommandInfo[] commands, AsyncHandler<RedisCommandInfo[]> completionHandler, boolean requireFutureResult, boolean isSyncCallback) Submit multiple Redis Commands.

Methods inherited from class org.aredis.cache.AbstractAsyncRedisClient

sendCommand, sendCommand, sendCommand, sendCommand, submitCommand, submitCommand, submitCommand, submitCommand, submitCommand, submitCommand, submitCommand, submitCommand, submitCommand, submitCommand, submitCommands, submitCommands

Methods inherited from class java.lang.Object

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

Field Detail

KEY_HANDLER

public static final DataHandler KEY_HANDLER

This DataHandler is an instance of StringHandler. It is also used to serialize keys and other non-value parameters to the Redis Commands.

DEFAULT_CLASS_DESCRIPTOR_STORAGE_FACTORY

public static final ClassDescriptorStorageFactory DEFAULT_CLASS_DESCRIPTOR_STORAGE_FACTORY

Default Per Connection Class Descriptor Storage used by OPTI_JAVA_HANDLER.

OPTI_JAVA_HANDLER

public static final DataHandler OPTI_JAVA_HANDLER

This DataHandler is an instance of JavaHandler. It is configured to optimize object storage by storing the class descriptors for the classes separately.

JAVA_HANDLER

public static final DataHandler JAVA_HANDLER

This DataHandler is an instance of JavaHandler with normal Object serialization.

OPTI_JAVA_HANDLER_NO_COMPRESS

public static final DataHandler OPTI_JAVA_HANDLER_NO_COMPRESS

Identical to OPTI_JAVA_HANDLER but without compression.

JAVA_HANDLER_NO_COMPRESS

public static final DataHandler JAVA_HANDLER_NO_COMPRESS

Identical to JAVA_HANDLER but without compression.

DEFAULT_HANDLER

public static final DataHandler DEFAULT_HANDLER

The Default Data Handler if none is configured. It is initialized to OPTI_JAVA_HANDLER by default.

DEFAULT_MAX_PIPELINE_SIZE

public static final int DEFAULT_MAX_PIPELINE_SIZE

Default value of max pipeline size to restrict the number of commands in pipeline after which the request processing is suspended till the pipeline size reduces.

See Also:

Constant Field Values

bootstrapExecutor

public static final ExecutorService bootstrapExecutor

Executor used to initialize the pipeline when there is no NIO request listener. It is also used as the executor if for completionHandlers if none is supplied which is not a good thing since there are only 10 threads.

shutDownHook

public static final Thread shutDownHook

MAX_SHUTDOWN_WAIT_MILLIS

public static volatile int MAX_SHUTDOWN_WAIT_MILLIS

taskExecutor

protected Executor taskExecutor

Task executor for invoking completionHandlers for Async commands.

Constructor Detail

AsyncRedisConnection

public AsyncRedisConnection(AsyncSocketTransport pcon,
                    int pdbIndex,
                    Executor ptaskExecutor,
                    ConnectionType pconnectionType)

Constructor to create an AsyncRedisConnection of the given connection type. It is preferable to use AsyncRedisFactory than this constructor.

Parameters:

pcon - Async Socket Transport implementation

pdbIndex - Redis DB index

ptaskExecutor - Task Executor to use for Asyc APIs. Can be null if you do not use Async APIs with completion handler

pconnectionType - ConnectionType indicating type of connection. A normal SHARED connection type is for Shared usage and the WATCH command is not allowed. If the ConnectionType is BORROWED WATCH is allowed but not blocking commands like BLPOP. If the ConnectionType is STANDALONE all commands except SUBSCRIBE are allowed.

AsyncRedisConnection

public AsyncRedisConnection(AsyncSocketTransport pcon,
                    int pdbIndex,
                    Executor ptaskExecutor)

Constructor to create a SHARED AsyncRedisConnection. It is preferable to use AsyncRedisFactory than this constructor.

Parameters:

pcon - Async Socket Transport implementation

pdbIndex - Redis DB index

ptaskExecutor - Task Executor to use for Asyc APIs. Can be null if you do not use Async APIs with completion handler

Method Detail

closeStaleConnection

public void closeStaleConnection()

Closes the connection if it has been idle beyond the configured idle timeout or the Redis Server timeout. A connection will be automatically re-established on the next command.

shutdown

public void shutdown(long delayMillis)

Shutdown the connection. The connection is closed as soon as it is idle and re-opened whenever a command arrives till delayMillis milliseconds. After that new commands are rejected. This method however is currently not the preferred way to shutdown because the socket connections close automatically once the JVM is eligible for shutdown. Idle connections are closed after the configure timeout in any case.

Parameters:

delayMillis - Max delay till which to support commands

submitCommands

public Future<RedisCommandInfo[]> submitCommands(RedisCommandInfo[] commands,
                                        AsyncHandler<RedisCommandInfo[]> completionHandler,
                                        boolean requireFutureResult,
                                        boolean isSyncCallback)

Description copied from interface: AsyncRedisClient

Submit multiple Redis Commands.

Specified by:

submitCommands in interface AsyncRedisClient

Specified by:

submitCommands in class AbstractAsyncRedisClient

Parameters:

commands - commands to run along with their parameters

completionHandler - Handler to call upon command completion. Can be null

requireFutureResult - Whether a Future return value is required

isSyncCallback - If true the callback is made directly by the Socket Channel Thread and not the configured executor. Pass true only if the handler logic is extremely light like moving the command to another Q.

Returns:

a Future Object to retrieve the submitted commands containing the results or null if requireFutureResult is passed as false

submitCommand

public Future<RedisCommandInfo> submitCommand(RedisCommandInfo command,
                                     AsyncHandler<RedisCommandInfo> completionHandler,
                                     boolean requireFutureResult,
                                     boolean isSyncCallback)

Description copied from interface: AsyncRedisClient

Submit a Redis Command.

Specified by:

submitCommand in interface AsyncRedisClient

Specified by:

submitCommand in class AbstractAsyncRedisClient

Parameters:

command - command to run along with its parameters

completionHandler - Handler to call upon command completion. Can be null

requireFutureResult - Whether a Future return value is required

isSyncCallback - If true the callback is made directly by the Socket Channel Thread and not the configured executor. Pass true only if the handler logic is extremely light like moving the command to another Q.

Returns:

a Future Object to retrieve the submitted command containing the result or null if requireFutureResult is passed as false

getConnection

public AsyncSocketTransport getConnection()

Returns the Async Socket Transport used

Returns:

Async Socket Transport used

getDbIndex

public int getDbIndex()

Returns the DB Index of the connection

Returns:

DB Index

getDataHandler

public DataHandler getDataHandler()

The default DataHandler for commands

Returns:

Default Data handler

setDataHandler

public void setDataHandler(DataHandler pdataHandler)

Sets the default DataHandler for commands

Parameters:

pdataHandler - Data Handler to set

getMaxPipelineSize

public int getMaxPipelineSize()

Max Pipeline Size

Returns:

Max Pipeline Size beyond which the request processing is suspended

setMaxPipelineSize

public void setMaxPipelineSize(int pmaxPipelineSize)

Sets the max number of commands pending for response in the Redis Server. This includes the commands in the local Q. Once this limit is reached the submitCommand calls are delayed upto a max of 100 ms for the pipeline size to come down by 100 or more. If the value supplied is less than 200 the pipeline size is taken as 200.

Parameters:

pmaxPipelineSize - max number of commands allowed in Redis Server pipeline

setBootstrapExecutorPoolSize

public static void setBootstrapExecutorPoolSize(int poolSize)

Method to change the size of the bootstrapExecutor

Parameters:

poolSize - New Pool size