io.lettuce.core

Interface ConnectionFuture<T>

All Superinterfaces:

CompletionStage<T>, Future<T>

public interface ConnectionFuture<T>
extends CompletionStage<T>, Future<T>

A ConnectionFuture represents the result of an asynchronous connection initialization. The future provides a StatefulConnection on successful completion. It also provides the remote SocketAddress.

Since:

4.4

Method Summary

Modifier and Type	Method and Description
ConnectionFuture<Void>	acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
ConnectionFuture<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
ConnectionFuture<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
<U> ConnectionFuture<U>	applyToEither(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> ConnectionFuture<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> ConnectionFuture<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)
static <T> ConnectionFuture<T>	completed(SocketAddress remoteAddress, T value) Create a completed ConnectionFuture given SocketAddress and value holding the value.
ConnectionFuture<T>	exceptionally(Function<Throwable,? extends T> fn)
static <T> ConnectionFuture<T>	from(SocketAddress remoteAddress, CompletableFuture<T> delegate) Create a ConnectionFuture given SocketAddress and CompletableFuture holding the connection progress.
T	get() Waits if necessary for the computation to complete, and then retrieves its result.
SocketAddress	getRemoteAddress() Return the remote SocketAddress.
<U> ConnectionFuture<U>	handle(BiFunction<? super T,Throwable,? extends U> fn)
<U> ConnectionFuture<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn)
<U> ConnectionFuture<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn, Executor executor)
T	join() Returns the result value when complete, or throws an (unchecked) exception if completed exceptionally.
ConnectionFuture<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
ConnectionFuture<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
ConnectionFuture<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
ConnectionFuture<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
ConnectionFuture<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
ConnectionFuture<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
ConnectionFuture<Void>	thenAccept(Consumer<? super T> action)
ConnectionFuture<Void>	thenAcceptAsync(Consumer<? super T> action)
ConnectionFuture<Void>	thenAcceptAsync(Consumer<? super T> action, Executor executor)
<U> ConnectionFuture<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> ConnectionFuture<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> ConnectionFuture<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)
<U> ConnectionFuture<U>	thenApply(Function<? super T,? extends U> fn)
<U> ConnectionFuture<U>	thenApplyAsync(Function<? super T,? extends U> fn)
<U> ConnectionFuture<U>	thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)
<U,V> ConnectionFuture<V>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> ConnectionFuture<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> ConnectionFuture<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)
<U> ConnectionFuture<U>	thenCompose(BiFunction<? super T,? super Throwable,? extends CompletionStage<U>> fn)
<U> ConnectionFuture<U>	thenCompose(Function<? super T,? extends CompletionStage<U>> fn)
<U> ConnectionFuture<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)
<U> ConnectionFuture<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn, Executor executor)
ConnectionFuture<Void>	thenRun(Runnable action)
ConnectionFuture<Void>	thenRunAsync(Runnable action)
ConnectionFuture<Void>	thenRunAsync(Runnable action, Executor executor)
ConnectionFuture<T>	whenComplete(BiConsumer<? super T,? super Throwable> action)
ConnectionFuture<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)
ConnectionFuture<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)

Methods inherited from interface java.util.concurrent.CompletionStage

toCompletableFuture

Methods inherited from interface java.util.concurrent.Future

cancel, get, isCancelled, isDone

Method Detail

from

static <T> ConnectionFuture<T> from(SocketAddress remoteAddress,
                                    CompletableFuture<T> delegate)

Create a ConnectionFuture given SocketAddress and CompletableFuture holding the connection progress.

Parameters:

remoteAddress - initial connection endpoint, must not be null.

delegate - must not be null.

Returns:

the ConnectionFuture for SocketAddress and CompletableFuture.

Since:

5.0

completed

static <T> ConnectionFuture<T> completed(SocketAddress remoteAddress,
                                         T value)

Create a completed ConnectionFuture given SocketAddress and value holding the value.

Parameters:

remoteAddress - initial connection endpoint, must not be null.

value - must not be null.

Returns:

the ConnectionFuture for SocketAddress and value.

Since:

5.1

get

T get()
throws InterruptedException,
      ExecutionException

Waits if necessary for the computation to complete, and then retrieves its result.

Specified by:

get in interface Future<T>

Returns:

the computed result.

Throws:

CancellationException - if the computation was cancelled

ExecutionException - if the computation threw an exception

InterruptedException - if the current thread was interrupted while waiting

getRemoteAddress

SocketAddress getRemoteAddress()

Return the remote SocketAddress.

Returns:

the remote SocketAddress. May be null until the socket address is resolved.

join

T 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, this method throws an (unchecked) CompletionException with the underlying exception as its cause.

Returns:

the result value.

Throws:

CancellationException - if the computation was cancelled

CompletionException - if this future completed exceptionally or a completion computation threw an exception

thenApply

<U> ConnectionFuture<U> thenApply(Function<? super T,? extends U> fn)

Specified by:

thenApply in interface CompletionStage<T>

thenApplyAsync

<U> ConnectionFuture<U> thenApplyAsync(Function<? super T,? extends U> fn)

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenApplyAsync

<U> ConnectionFuture<U> thenApplyAsync(Function<? super T,? extends U> fn,
                                       Executor executor)

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenAccept

ConnectionFuture<Void> thenAccept(Consumer<? super T> action)

Specified by:

thenAccept in interface CompletionStage<T>

thenAcceptAsync

ConnectionFuture<Void> thenAcceptAsync(Consumer<? super T> action)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenAcceptAsync

ConnectionFuture<Void> thenAcceptAsync(Consumer<? super T> action,
                                       Executor executor)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenRun

ConnectionFuture<Void> thenRun(Runnable action)

Specified by:

thenRun in interface CompletionStage<T>

thenRunAsync

ConnectionFuture<Void> thenRunAsync(Runnable action)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenRunAsync

ConnectionFuture<Void> thenRunAsync(Runnable action,
                                    Executor executor)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenCombine

<U,V> ConnectionFuture<V> thenCombine(CompletionStage<? extends U> other,
                                      BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombine in interface CompletionStage<T>

thenCombineAsync

<U,V> ConnectionFuture<V> thenCombineAsync(CompletionStage<? extends U> other,
                                           BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenCombineAsync

<U,V> ConnectionFuture<V> thenCombineAsync(CompletionStage<? extends U> other,
                                           BiFunction<? super T,? super U,? extends V> fn,
                                           Executor executor)

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenAcceptBoth

<U> ConnectionFuture<Void> thenAcceptBoth(CompletionStage<? extends U> other,
                                          BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBoth in interface CompletionStage<T>

thenAcceptBothAsync

<U> ConnectionFuture<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                               BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

thenAcceptBothAsync

<U> ConnectionFuture<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                               BiConsumer<? super T,? super U> action,
                                               Executor executor)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

runAfterBoth

ConnectionFuture<Void> runAfterBoth(CompletionStage<?> other,
                                    Runnable action)

Specified by:

runAfterBoth in interface CompletionStage<T>

runAfterBothAsync

ConnectionFuture<Void> runAfterBothAsync(CompletionStage<?> other,
                                         Runnable action)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

runAfterBothAsync

ConnectionFuture<Void> runAfterBothAsync(CompletionStage<?> other,
                                         Runnable action,
                                         Executor executor)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

applyToEither

<U> ConnectionFuture<U> applyToEither(CompletionStage<? extends T> other,
                                      Function<? super T,U> fn)

Specified by:

applyToEither in interface CompletionStage<T>

applyToEitherAsync

<U> ConnectionFuture<U> applyToEitherAsync(CompletionStage<? extends T> other,
                                           Function<? super T,U> fn)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

applyToEitherAsync

<U> ConnectionFuture<U> applyToEitherAsync(CompletionStage<? extends T> other,
                                           Function<? super T,U> fn,
                                           Executor executor)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

acceptEither

ConnectionFuture<Void> acceptEither(CompletionStage<? extends T> other,
                                    Consumer<? super T> action)

Specified by:

acceptEither in interface CompletionStage<T>

acceptEitherAsync

ConnectionFuture<Void> acceptEitherAsync(CompletionStage<? extends T> other,
                                         Consumer<? super T> action)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

acceptEitherAsync

ConnectionFuture<Void> acceptEitherAsync(CompletionStage<? extends T> other,
                                         Consumer<? super T> action,
                                         Executor executor)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

runAfterEither

ConnectionFuture<Void> runAfterEither(CompletionStage<?> other,
                                      Runnable action)

Specified by:

runAfterEither in interface CompletionStage<T>

runAfterEitherAsync

ConnectionFuture<Void> runAfterEitherAsync(CompletionStage<?> other,
                                           Runnable action)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

runAfterEitherAsync

ConnectionFuture<Void> runAfterEitherAsync(CompletionStage<?> other,
                                           Runnable action,
                                           Executor executor)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

thenCompose

<U> ConnectionFuture<U> thenCompose(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenCompose in interface CompletionStage<T>

thenCompose

<U> ConnectionFuture<U> thenCompose(BiFunction<? super T,? super Throwable,? extends CompletionStage<U>> fn)

thenComposeAsync

<U> ConnectionFuture<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenComposeAsync in interface CompletionStage<T>

thenComposeAsync

<U> ConnectionFuture<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn,
                                         Executor executor)

Specified by:

thenComposeAsync in interface CompletionStage<T>

exceptionally

ConnectionFuture<T> exceptionally(Function<Throwable,? extends T> fn)

Specified by:

exceptionally in interface CompletionStage<T>

whenComplete

ConnectionFuture<T> whenComplete(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenComplete in interface CompletionStage<T>

whenCompleteAsync

ConnectionFuture<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

whenCompleteAsync

ConnectionFuture<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action,
                                      Executor executor)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

handle

<U> ConnectionFuture<U> handle(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handle in interface CompletionStage<T>

handleAsync

<U> ConnectionFuture<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handleAsync in interface CompletionStage<T>

handleAsync

<U> ConnectionFuture<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn,
                                    Executor executor)

Specified by:

handleAsync in interface CompletionStage<T>