io.lettuce.core.cluster

Class PipelinedRedisFuture<V>

java.lang.Object

java.util.concurrent.CompletableFuture<V>

io.lettuce.core.cluster.PipelinedRedisFuture<V>

All Implemented Interfaces:

RedisFuture<V>, CompletionStage<V>, Future<V>

public class PipelinedRedisFuture<V>
extends CompletableFuture<V>
implements RedisFuture<V>

Pipelining for commands that are executed on multiple cluster nodes. Merges results and emits one composite result.

Author:

Mark Paluch

Nested Class Summary

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

CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Constructor and Description
PipelinedRedisFuture(CompletionStage<V> completionStage)
PipelinedRedisFuture(CompletionStage<V> completionStage, Function<V,V> converter)
PipelinedRedisFuture(Map<?,? extends CompletionStage<?>> executions, Function<PipelinedRedisFuture<V>,V> converter)

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.
boolean	complete(V value)
boolean	completeExceptionally(Throwable ex)
String	getError()

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, cancel, 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, toString, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class java.lang.Object

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

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

cancel, get, get, isCancelled, isDone

Constructor Detail

PipelinedRedisFuture

public PipelinedRedisFuture(CompletionStage<V> completionStage)

PipelinedRedisFuture

public PipelinedRedisFuture(CompletionStage<V> completionStage,
                            Function<V,V> converter)

PipelinedRedisFuture

public PipelinedRedisFuture(Map<?,? extends CompletionStage<?>> executions,
                            Function<PipelinedRedisFuture<V>,V> converter)

Method Detail

complete

public boolean complete(V value)

Overrides:

complete in class CompletableFuture<V>

completeExceptionally

public boolean completeExceptionally(Throwable ex)

Overrides:

completeExceptionally in class CompletableFuture<V>

getError

public String getError()

Specified by:

getError in interface RedisFuture<V>

Returns:

error text, if any error occurred.

await

public boolean await(long timeout,
                     TimeUnit unit)
              throws InterruptedException

Description copied from interface: RedisFuture

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

Specified by:

await in interface RedisFuture<V>

Parameters:

timeout - Maximum time to wait for a result.

unit - Unit of time for the timeout.

Returns:

true if the output became available.

Throws:

InterruptedException - if the current thread is interrupted while waiting