org.aredis.cache

Class AbstractAsyncRedisClient

java.lang.Object

org.aredis.cache.AbstractAsyncRedisClient

All Implemented Interfaces:

AsyncRedisClient

Direct Known Subclasses:

AsyncRedisConnection, ShardedAsyncRedisClient

public abstract class AbstractAsyncRedisClient
extends Object
implements AsyncRedisClient

A basic implementation of AsyncRedisClient based on 2 abstract methods. The rest of the calls pass appropriate defaults to one of the abstract methods.

Author:

suresh

Constructor Summary

Constructors

Constructor and Description
AbstractAsyncRedisClient()

Method Summary

Methods

Modifier and Type	Method and Description
void	sendCommand(DataHandler dataHandler, Object metaData, RedisCommand command, Object... params) Send a command without looking for a return value.
void	sendCommand(DataHandler dataHandler, RedisCommand command, Object... params) Send a command without looking for a return value.
void	sendCommand(Object metaData, RedisCommand command, Object... params) Send a command without looking for a return value.
void	sendCommand(RedisCommand command, Object... params) Send a command without looking for a return value.
void	submitCommand(AsyncHandler<RedisCommandInfo> completionHandler, DataHandler dataHandler, Object metaData, RedisCommand command, Object... params) Submit a Redis Command.
void	submitCommand(AsyncHandler<RedisCommandInfo> completionHandler, DataHandler dataHandler, RedisCommand command, Object... params) Submit a Redis Command.
void	submitCommand(AsyncHandler<RedisCommandInfo> completionHandler, Object metaData, RedisCommand command, Object... params) Submit a Redis Command.
void	submitCommand(AsyncHandler<RedisCommandInfo> completionHandler, RedisCommand command, Object... params) Submit a Redis Command.
Future<RedisCommandInfo>	submitCommand(DataHandler dataHandler, Object metaData, RedisCommand command, Object... params) Submit a Redis Command.
Future<RedisCommandInfo>	submitCommand(DataHandler dataHandler, RedisCommand command, Object... params) Submit a Redis Command.
Future<RedisCommandInfo>	submitCommand(Object metaData, RedisCommand command, Object... params) Submit a Redis Command.
Future<RedisCommandInfo>	submitCommand(RedisCommandInfo command) Submit a Redis Command.
void	submitCommand(RedisCommandInfo command, AsyncHandler<RedisCommandInfo> completionHandler) Submit a Redis Command.
abstract Future<RedisCommandInfo>	submitCommand(RedisCommandInfo command, AsyncHandler<RedisCommandInfo> completionHandler, boolean requireFutureResult, boolean isSyncCallback) Submit a Redis Command.
Future<RedisCommandInfo>	submitCommand(RedisCommand command, Object... params) Submit a Redis Command.
Future<RedisCommandInfo[]>	submitCommands(RedisCommandInfo[] commands) Submit multiple Redis Commands.
void	submitCommands(RedisCommandInfo[] commands, AsyncHandler<RedisCommandInfo[]> completionHandler) Submit multiple Redis Commands.
abstract Future<RedisCommandInfo[]>	submitCommands(RedisCommandInfo[] commands, AsyncHandler<RedisCommandInfo[]> completionHandler, boolean requireFutureResult, boolean isSyncCallback) Submit multiple Redis Commands.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAsyncRedisClient

public AbstractAsyncRedisClient()

Method Detail

submitCommands

public abstract 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

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 abstract 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

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

submitCommands

public Future<RedisCommandInfo[]> submitCommands(RedisCommandInfo[] commands)

Description copied from interface: AsyncRedisClient

Submit multiple Redis Commands.

Specified by:

submitCommands in interface AsyncRedisClient

Parameters:

commands - commands to run along with their parameters

Returns:

a Future Object to retrieve the submitted commands containing the results

See Also:

AsyncRedisClient.submitCommands(org.aredis.cache.RedisCommandInfo[])

submitCommands

public void submitCommands(RedisCommandInfo[] commands,
                  AsyncHandler<RedisCommandInfo[]> completionHandler)

Description copied from interface: AsyncRedisClient

Submit multiple Redis Commands.

Specified by:

submitCommands in interface AsyncRedisClient

Parameters:

commands - commands to run along with their parameters

completionHandler - Handler to call upon command completion. Can be null if you want to send the commands and forget.

See Also:

AsyncRedisClient.submitCommands(org.aredis.cache.RedisCommandInfo[], org.aredis.cache.AsyncHandler)

submitCommand

public Future<RedisCommandInfo> submitCommand(RedisCommandInfo command)

Description copied from interface: AsyncRedisClient

Submit a Redis Command.

Specified by:

submitCommand in interface AsyncRedisClient

Parameters:

command - command to run along with its parameters

Returns:

a Future Object to retrieve the submitted command containing the result

See Also:

AsyncRedisClient.submitCommand(org.aredis.cache.RedisCommandInfo)

submitCommand

public void submitCommand(RedisCommandInfo command,
                 AsyncHandler<RedisCommandInfo> completionHandler)

Description copied from interface: AsyncRedisClient

Submit a Redis Command.

Specified by:

submitCommand in interface AsyncRedisClient

Parameters:

command - command to run along with its parameters

completionHandler - Handler to call upon command completion. Can be null if you want to send the command and forget.

See Also:

AsyncRedisClient.submitCommand(org.aredis.cache.RedisCommandInfo, org.aredis.cache.AsyncHandler)

submitCommand

public Future<RedisCommandInfo> submitCommand(RedisCommand command,
                                     Object... params)

Description copied from interface: AsyncRedisClient

Submit a Redis Command. The default DataHandler is used.

Specified by:

submitCommand in interface AsyncRedisClient

Parameters:

command - command to run

params - command parameters

Returns:

a Future Object to retrieve the submitted command containing the result

submitCommand

public Future<RedisCommandInfo> submitCommand(Object metaData,
                                     RedisCommand command,
                                     Object... params)

Description copied from interface: AsyncRedisClient

Submit a Redis Command. The default DataHandler is used.

Specified by:

submitCommand in interface AsyncRedisClient

Parameters:

metaData - Metadata to be used if the DataHandler requires metadata like the Object class

command - command to run

params - command parameters

Returns:

a Future Object to retrieve the submitted command containing the result

submitCommand

public Future<RedisCommandInfo> submitCommand(DataHandler dataHandler,
                                     RedisCommand command,
                                     Object... params)

Description copied from interface: AsyncRedisClient

Submit a Redis Command.

Specified by:

submitCommand in interface AsyncRedisClient

Parameters:

dataHandler - Data Handler to be used. Pass null to use the default Data Handler

command - command to run

params - command parameters

Returns:

a Future Object to retrieve the submitted command containing the result

submitCommand

public Future<RedisCommandInfo> submitCommand(DataHandler dataHandler,
                                     Object metaData,
                                     RedisCommand command,
                                     Object... params)

Description copied from interface: AsyncRedisClient

Submit a Redis Command.

Specified by:

submitCommand in interface AsyncRedisClient

Parameters:

dataHandler - Data Handler to be used. Pass null to use the default Data Handler

metaData - Metadata to be used if the DataHandler requires metadata like the Object class

command - command to run

params - command parameters

Returns:

a Future Object to retrieve the submitted command containing the result

sendCommand

public void sendCommand(RedisCommand command,
               Object... params)

Description copied from interface: AsyncRedisClient

Send a command without looking for a return value. The default DataHandler is used.

Specified by:

sendCommand in interface AsyncRedisClient

Parameters:

command - command to run

params - command parameters

sendCommand

public void sendCommand(Object metaData,
               RedisCommand command,
               Object... params)

Description copied from interface: AsyncRedisClient

Send a command without looking for a return value. The default DataHandler is used.

Specified by:

sendCommand in interface AsyncRedisClient

Parameters:

metaData - Metadata to be used if the DataHandler requires metadata like the Object class

command - command to run

params - command parameters

sendCommand

public void sendCommand(DataHandler dataHandler,
               RedisCommand command,
               Object... params)

Description copied from interface: AsyncRedisClient

Send a command without looking for a return value.

Specified by:

sendCommand in interface AsyncRedisClient

Parameters:

dataHandler - Data Handler to be used. Pass null to use the default Data Handler

command - command to run

params - command parameters

sendCommand

public void sendCommand(DataHandler dataHandler,
               Object metaData,
               RedisCommand command,
               Object... params)

Description copied from interface: AsyncRedisClient

Send a command without looking for a return value.

Specified by:

sendCommand in interface AsyncRedisClient

metaData - Metadata to be used if the DataHandler requires metadata like the Object class

command - command to run

params - command parameters

submitCommand

public void submitCommand(AsyncHandler<RedisCommandInfo> completionHandler,
                 RedisCommand command,
                 Object... params)

Description copied from interface: AsyncRedisClient

Submit a Redis Command. The default DataHandler is used.

Specified by:

submitCommand in interface AsyncRedisClient

Parameters:

completionHandler - Handler to call upon command completion.

command - command to run

params - command parameters

submitCommand

public void submitCommand(AsyncHandler<RedisCommandInfo> completionHandler,
                 Object metaData,
                 RedisCommand command,
                 Object... params)

Description copied from interface: AsyncRedisClient

Submit a Redis Command. The default DataHandler is used.

Specified by:

submitCommand in interface AsyncRedisClient

Parameters:

completionHandler - Handler to call upon command completion.

metaData - Metadata to be used if the DataHandler requires metadata like the Object class

command - command to run

params - command parameters

submitCommand

public void submitCommand(AsyncHandler<RedisCommandInfo> completionHandler,
                 DataHandler dataHandler,
                 RedisCommand command,
                 Object... params)

Description copied from interface: AsyncRedisClient

Submit a Redis Command.

Specified by:

submitCommand in interface AsyncRedisClient

Parameters:

completionHandler - Handler to call upon command completion.

dataHandler - Data Handler to be used. Pass null to use the default Data Handler

command - command to run

params - command parameters

submitCommand

public void submitCommand(AsyncHandler<RedisCommandInfo> completionHandler,
                 DataHandler dataHandler,
                 Object metaData,
                 RedisCommand command,
                 Object... params)

Description copied from interface: AsyncRedisClient

Submit a Redis Command.

Specified by:

submitCommand in interface AsyncRedisClient

Parameters:

completionHandler - Handler to call upon command completion.

dataHandler - Data Handler to be used. Pass null to use the default Data Handler

metaData - Metadata to be used if the DataHandler requires metadata like the Object class

command - command to run

params - command parameters