io.lettuce.core.protocol

Interface RedisCommand<K,V,T>

Type Parameters:

K - Key type.

V - Value type.

T - Output type.

All Known Implementing Classes:

AsyncCommand, Command, CommandWrapper, TracedCommand, TransactionalCommand

public interface RedisCommand<K,V,T>

A redis command that holds an output, arguments and a state, whether it is completed or not. Commands can be wrapped. Outer commands have to notify inner commands but inner commands do not communicate with outer commands.

Since:

3.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel a command.
void	complete() Complete a command.
boolean	completeExceptionally(Throwable throwable)
void	encode(ByteBuf buf) Encode the command.
CommandArgs<K,V>	getArgs()
CommandOutput<K,V,T>	getOutput() The command output.
ProtocolKeyword	getType()
boolean	isCancelled()
boolean	isDone()
void	setOutput(CommandOutput<K,V,T> output) Set a new output.

Method Detail

getOutput

CommandOutput<K,V,T> getOutput()

The command output. Can be null.

Returns:

the command output.

complete

void complete()

Complete a command.

cancel

void cancel()

Cancel a command.

getArgs

CommandArgs<K,V> getArgs()

Returns:

the current command args

completeExceptionally

boolean completeExceptionally(Throwable throwable)

Parameters:

throwable - the exception

Returns:

true if this invocation caused this CompletableFuture to transition to a completed state, else false

getType

ProtocolKeyword getType()

Returns:

the Redis command type like SADD, HMSET, QUIT.

encode

void encode(ByteBuf buf)

Encode the command.

Parameters:

buf - byte buffer to operate on.

isCancelled

boolean isCancelled()

Returns:

true if the command is cancelled.

isDone

boolean isDone()

Returns:

true if the command is completed.

setOutput

void setOutput(CommandOutput<K,V,T> output)

Set a new output. Only possible as long as the command is not completed/cancelled.

Parameters:

output - the new command output

Throws:

IllegalStateException - if the command is cancelled/completed