Module lettuce.core

Package io.lettuce.core

Class LettuceFutures

java.lang.Object

io.lettuce.core.LettuceFutures

public class LettuceFutures
extends Object

Utility to awaitAll(long, TimeUnit, Future[]) futures until they are done and to synchronize future execution using awaitOrCancel(RedisFuture, long, TimeUnit).

Since:

3.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method	Description
static boolean	awaitAll(long timeout, TimeUnit unit, Future<?>... futures)	Wait until futures are complete or the supplied timeout is reached.
static boolean	awaitAll(Duration timeout, Future<?>... futures)	Wait until futures are complete or the supplied timeout is reached.
static <T> T	awaitOrCancel(RedisFuture<T> cmd, long timeout, TimeUnit unit)	Wait until futures are complete or the supplied timeout is reached.

Methods inherited from class java.lang.Object

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

Method Details

awaitAll

public static boolean awaitAll(Duration timeout,
Future<?>... futures)

Wait until futures are complete or the supplied timeout is reached. Commands are not canceled (in contrast to awaitOrCancel(RedisFuture, long, TimeUnit)) when the timeout expires.

Parameters:

timeout - Maximum time to wait for futures to complete.

futures - Futures to wait for.

Returns:

true if all futures complete in time, otherwise false

Since:

5.0

awaitAll

public static boolean awaitAll(long timeout,
TimeUnit unit,
Future<?>... futures)

Wait until futures are complete or the supplied timeout is reached. Commands are not canceled (in contrast to awaitOrCancel(RedisFuture, long, TimeUnit)) when the timeout expires.

Parameters:

timeout - Maximum time to wait for futures to complete.

unit - Unit of time for the timeout.

futures - Futures to wait for.

Returns:

true if all futures complete in time, otherwise false

awaitOrCancel

public static <T> T awaitOrCancel(RedisFuture<T> cmd,
long timeout,
TimeUnit unit)

Wait until futures are complete or the supplied timeout is reached. Commands are canceled if the timeout is reached but the command is not finished.

Type Parameters:

T - Result type

Parameters:

cmd - Command to wait for

timeout - Maximum time to wait for futures to complete

unit - Unit of time for the timeout

Returns:

Result of the command.