io.lettuce.core.protocol

Class AsyncCommand<K,V,T>

java.lang.Object

java.util.concurrent.CompletableFuture<T>

io.lettuce.core.protocol.AsyncCommand<K,V,T>

Type Parameters:

K - Key type.

V - Value type.

T - Command output type.

All Implemented Interfaces:

CompleteableCommand<T>, DecoratedCommand<K,V,T>, RedisCommand<K,V,T>, RedisFuture<T>, CompletionStage<T>, Future<T>

Direct Known Subclasses:

TransactionalCommand

public class AsyncCommand<K,V,T>
extends CompletableFuture<T>
implements RedisCommand<K,V,T>, RedisFuture<T>, CompleteableCommand<T>, DecoratedCommand<K,V,T>

An asynchronous redis command and its result. All successfully executed commands will eventually return a CommandOutput object.

Author:

Mark Paluch

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Modifier	Constructor and Description
	AsyncCommand(RedisCommand<K,V,T> command)
protected	AsyncCommand(RedisCommand<K,V,T> command, int count)

Method Summary

Modifier and Type	Method and Description
boolean	await(long timeout, TimeUnit unit) Wait up to the specified time for the command output to become available.
void	cancel() Cancel a command.
boolean	cancel(boolean mayInterruptIfRunning)
void	complete() Mark this command complete and notify all waiting threads.
boolean	completeExceptionally(Throwable ex)
protected void	completeResult()
void	encode(ByteBuf buf) Encode the command.
boolean	equals(Object o)
CommandArgs<K,V>	getArgs()
RedisCommand<K,V,T>	getDelegate() The underlying command.
String	getError()
CommandOutput<K,V,T>	getOutput() Get the object that holds this command's output.
ProtocolKeyword	getType()
int	hashCode()
void	onComplete(BiConsumer<? super T,Throwable> action) Register a command callback for command completion that notifies the callback with the command result or the failure resulting from command completion.
void	onComplete(Consumer<? super T> action) Register a command callback for successive command completion that notifies the callback with the command result.
void	setOutput(CommandOutput<K,V,T> output) Set a new output.
String	toString()

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, complete, completedFuture, exceptionally, get, get, getNow, getNumberOfDependents, handle, handleAsync, handleAsync, isCancelled, isCompletedExceptionally, isDone, join, obtrudeException, obtrudeValue, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, supplyAsync, supplyAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.lettuce.core.protocol.RedisCommand

isCancelled, isDone

Methods inherited from interface java.util.concurrent.CompletionStage

acceptEither, acceptEitherAsync, acceptEitherAsync, applyToEither, applyToEitherAsync, applyToEitherAsync, exceptionally, handle, handleAsync, handleAsync, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from interface java.util.concurrent.Future

get, get, isCancelled, isDone

Constructor Detail

AsyncCommand

public AsyncCommand(RedisCommand<K,V,T> command)

Parameters:

command - the command, must not be null.

AsyncCommand

protected AsyncCommand(RedisCommand<K,V,T> command,
                       int count)

Parameters:

command - the command, must not be null.

Method Detail

await

public boolean await(long timeout,
                     TimeUnit unit)

Wait up to the specified time for the command output to become available.

Specified by:

await in interface RedisFuture<T>

Parameters:

timeout - Maximum time to wait for a result.

unit - Unit of time for the timeout.

Returns:

true if the output became available.

getOutput

public CommandOutput<K,V,T> getOutput()

Get the object that holds this command's output.

Specified by:

getOutput in interface RedisCommand<K,V,T>

Returns:

The command output object.

complete

public void complete()

Mark this command complete and notify all waiting threads.

Specified by:

complete in interface RedisCommand<K,V,T>

completeResult

protected void completeResult()

completeExceptionally

public boolean completeExceptionally(Throwable ex)

Specified by:

completeExceptionally in interface RedisCommand<K,V,T>

Overrides:

completeExceptionally in class CompletableFuture<T>

Parameters:

ex - the exception

Returns:

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

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<T>

Overrides:

cancel in class CompletableFuture<T>

getError

public String getError()

Specified by:

getError in interface RedisFuture<T>

Returns:

error text, if any error occured.

getArgs

public CommandArgs<K,V> getArgs()

Specified by:

getArgs in interface RedisCommand<K,V,T>

Returns:

the current command args

toString

public String toString()

Overrides:

toString in class CompletableFuture<T>

getType

public ProtocolKeyword getType()

Specified by:

getType in interface RedisCommand<K,V,T>

Returns:

the Redis command type like SADD, HMSET, QUIT.

cancel

public void cancel()

Description copied from interface: RedisCommand

Cancel a command.

Specified by:

cancel in interface RedisCommand<K,V,T>

encode

public void encode(ByteBuf buf)

Description copied from interface: RedisCommand

Encode the command.

Specified by:

encode in interface RedisCommand<K,V,T>

Parameters:

buf - byte buffer to operate on.

setOutput

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

Description copied from interface: RedisCommand

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

Specified by:

setOutput in interface RedisCommand<K,V,T>

Parameters:

output - the new command output

onComplete

public void onComplete(Consumer<? super T> action)

Description copied from interface: CompleteableCommand

Register a command callback for successive command completion that notifies the callback with the command result.

Specified by:

onComplete in interface CompleteableCommand<T>

Parameters:

action - must not be null.

onComplete

public void onComplete(BiConsumer<? super T,Throwable> action)

Description copied from interface: CompleteableCommand

Register a command callback for command completion that notifies the callback with the command result or the failure resulting from command completion.

Specified by:

onComplete in interface CompleteableCommand<T>

Parameters:

action - must not be null.

getDelegate

public RedisCommand<K,V,T> getDelegate()

Description copied from interface: DecoratedCommand

The underlying command.

Specified by:

getDelegate in interface DecoratedCommand<K,V,T>

Returns:

never null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object