org.aredis.cache

Interface AsyncRedisClient

All Known Implementing Classes:

AbstractAsyncRedisClient, AsyncRedisConnection, ShardedAsyncRedisClient

public interface AsyncRedisClient

Specifies the different methods to run Redis Commands.

Author:

Suresh

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.
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.
Future<RedisCommandInfo[]>	submitCommands(RedisCommandInfo[] commands, AsyncHandler<RedisCommandInfo[]> completionHandler, boolean requireFutureResult, boolean isSyncCallback) Submit multiple Redis Commands.

Method Detail

submitCommands

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

Submit multiple Redis Commands.

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

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

Submit a Redis Command.

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

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

Submit multiple Redis Commands.

Parameters:

commands - commands to run along with their parameters

Returns:

a Future Object to retrieve the submitted commands containing the results

submitCommands

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

Submit multiple Redis Commands.

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.

submitCommand

Future<RedisCommandInfo> submitCommand(RedisCommandInfo command)

Submit a Redis Command.

Parameters:

command - command to run along with its parameters

Returns:

a Future Object to retrieve the submitted command containing the result

submitCommand

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

Submit a Redis Command.

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.

submitCommand

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

Submit a Redis Command. The default DataHandler is used.

Parameters:

command - command to run

params - command parameters

Returns:

a Future Object to retrieve the submitted command containing the result

submitCommand

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

Submit a Redis Command. The default DataHandler is used.

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

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

Submit a Redis Command.

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

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

Submit a Redis Command.

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

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

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

Parameters:

command - command to run

params - command parameters

sendCommand

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

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

Parameters:

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

command - command to run

params - command parameters

sendCommand

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

Send a command without looking for a return value.

Parameters:

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

command - command to run

params - command parameters

sendCommand

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

Send a command without looking for a return value.

Parameters:

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

command - command to run

params - command parameters

submitCommand

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

Submit a Redis Command. The default DataHandler is used.

Parameters:

completionHandler - Handler to call upon command completion.

command - command to run

params - command parameters

submitCommand

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

Submit a Redis Command. The default DataHandler is used.

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

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

Submit a Redis Command.

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

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

Submit a Redis Command.

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