org.redisson.api

Interface RFuture<V>

Type Parameters:

V - type of value

All Superinterfaces:

CompletionStage<V>, Future<V>

All Known Subinterfaces:

RExecutorBatchFuture, RExecutorFuture<V>, RPromise<T>, RScheduledFuture<V>

All Known Implementing Classes:

BatchPromise, PromiseDelegator, RedissonExecutorBatchFuture, RedissonExecutorFuture, RedissonPromise, RedissonScheduledFuture, RemotePromise

public interface RFuture<V>
extends Future<V>, CompletionStage<V>

Represents the result of an asynchronous computation

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
RFuture<V>	await() Waits for this future to be completed.
boolean	await(long timeoutMillis) Waits for this future to be completed within the specified time limit.
boolean	await(long timeout, TimeUnit unit) Waits for this future to be completed within the specified time limit.
RFuture<V>	awaitUninterruptibly() Waits for this future to be completed without interruption.
boolean	awaitUninterruptibly(long timeoutMillis) Waits for this future to be completed within the specified time limit without interruption.
boolean	awaitUninterruptibly(long timeout, TimeUnit unit) Waits for this future to be completed within the specified time limit without interruption.
Throwable	cause() Returns the cause of the failed I/O operation if the I/O operation has failed.
V	getNow() Return the result without blocking.
boolean	isSuccess() Returns true if and only if the I/O operation was completed successfully.
V	join() Returns the result value when complete, or throws an (unchecked) exception if completed exceptionally.
void	onComplete(BiConsumer<? super V,? super Throwable> action)
RFuture<V>	sync() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
RFuture<V>	syncUninterruptibly() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, 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

Method Detail

isSuccess

boolean isSuccess()

Returns true if and only if the I/O operation was completed successfully.

Returns:

true if future was completed successfully

cause

Throwable cause()

Returns the cause of the failed I/O operation if the I/O operation has failed.

Returns:

the cause of the failure. null if succeeded or this future is not completed yet.

getNow

V getNow()

Return the result without blocking. If the future is not done yet this will return null. As it is possible that a null value is used to mark the future as successful you also need to check if the future is really done with Future.isDone() and not relay on the returned null value.

Returns:

object

join

V join()

Returns the result value when complete, or throws an (unchecked) exception if completed exceptionally. To better conform with the use of common functional forms, if a computation involved in the completion of this CompletableFuture threw an exception.

Returns:

the result value

await

boolean await(long timeout,
              TimeUnit unit)
       throws InterruptedException

Waits for this future to be completed within the specified time limit.

Parameters:

timeout - - wait timeout

unit - - time unit

Returns:

true if and only if the future was completed within the specified time limit

Throws:

InterruptedException - if the current thread was interrupted

await

boolean await(long timeoutMillis)
       throws InterruptedException

Waits for this future to be completed within the specified time limit.

Parameters:

timeoutMillis - - timeout value

Returns:

true if and only if the future was completed within the specified time limit

Throws:

InterruptedException - if the current thread was interrupted

sync

RFuture<V> sync()
         throws InterruptedException

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Returns:

Future object

Throws:

InterruptedException - if the current thread was interrupted

syncUninterruptibly

RFuture<V> syncUninterruptibly()

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Returns:

Future object

await

RFuture<V> await()
          throws InterruptedException

Waits for this future to be completed.

Returns:

Future object

Throws:

InterruptedException - if the current thread was interrupted

awaitUninterruptibly

RFuture<V> awaitUninterruptibly()

Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.

Returns:

Future object

awaitUninterruptibly

boolean awaitUninterruptibly(long timeout,
                             TimeUnit unit)

Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.

Parameters:

timeout - - timeout value

unit - - timeout unit value

Returns:

true if and only if the future was completed within the specified time limit

awaitUninterruptibly

boolean awaitUninterruptibly(long timeoutMillis)

Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.

Parameters:

timeoutMillis - - timeout value

Returns:

true if and only if the future was completed within the specified time limit

onComplete

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