Package org.apache.sshd.common.future

Interface WaitableFuture

All Known Subinterfaces:

AuthFuture, CancelFuture, CloseFuture, ConnectFuture, IoConnectFuture, IoReadFuture, IoWriteFuture, KeyExchangeFuture, OpenFuture, SshFuture<T>

All Known Implementing Classes:

AbstractIoWriteFuture, AbstractSshFuture, ChannelAsyncInputStream.IoReadFutureImpl, ChannelAsyncOutputStream.BufferedFuture, DefaultAuthFuture, DefaultCancelFuture, DefaultCancellableSshFuture, DefaultCloseFuture, DefaultConnectFuture, DefaultIoConnectFuture, DefaultKeyExchangeFuture, DefaultOpenFuture, DefaultSshFuture, DefaultVerifiableSshFuture, GlobalRequestFuture, IoWriteFutureImpl, Nio2DefaultIoWriteFuture, PendingWriteFuture, SimpleIoOutputStream.DefaultIoWriteFuture

public interface WaitableFuture

Represents an asynchronous operation which one can wait for its completion. Note: the only thing guaranteed is that if true is returned from one of the awaitXXX methods then the operation has completed. However, the caller has to determine whether it was a successful or failed completion.

Method Summary

Modifier and Type	Method	Description
default boolean	await()	Wait Long.MAX_VALUE msec.
default boolean	await(long timeoutMillis)	Wait for the asynchronous operation to complete with the specified timeout.
default boolean	await(long timeout, java.util.concurrent.TimeUnit unit)	Wait for the asynchronous operation to complete with the specified timeout.
default boolean	await(long timeout, java.util.concurrent.TimeUnit unit, CancelOption... options)	Wait for the asynchronous operation to complete with the specified timeout.
boolean	await(long timeoutMillis, CancelOption... options)	Wait for the asynchronous operation to complete with the specified timeout.
default boolean	await(java.time.Duration timeout)	Wait for the asynchronous operation to complete with the specified timeout.
default boolean	await(java.time.Duration timeout, CancelOption... options)	Wait for the asynchronous operation to complete with the specified timeout.
default boolean	await(CancelOption... options)	Wait Long.MAX_VALUE msec.
default boolean	awaitUninterruptibly()	Wait Long.MAX_VALUE msec.
default boolean	awaitUninterruptibly(long timeoutMillis)	Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
default boolean	awaitUninterruptibly(long timeout, java.util.concurrent.TimeUnit unit)	Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
default boolean	awaitUninterruptibly(long timeout, java.util.concurrent.TimeUnit unit, CancelOption... options)	Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
boolean	awaitUninterruptibly(long timeoutMillis, CancelOption... options)	Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
default boolean	awaitUninterruptibly(java.time.Duration timeoutMillis)	Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
default boolean	awaitUninterruptibly(java.time.Duration timeoutMillis, CancelOption... options)	Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
default boolean	awaitUninterruptibly(CancelOption... options)	Wait Long.MAX_VALUE msec.
java.lang.Object	getId()
boolean	isDone()

Method Detail

getId

java.lang.Object getId()

Returns:

Some identifier useful as toString() value

await

default boolean await()
               throws java.io.IOException

Wait Long.MAX_VALUE msec. for the asynchronous operation to complete. The attached listeners will be notified when the operation is completed.

Returns:

true if the operation is completed.

Throws:

java.io.IOException - if failed - specifically InterruptedIOException if waiting was interrupted

See Also:

await(long, CancelOption[])

await

default boolean await(CancelOption... options)
               throws java.io.IOException

Wait Long.MAX_VALUE msec. for the asynchronous operation to complete. The attached listeners will be notified when the operation is completed.

Parameters:

options - Optional CancelOptions defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.

Returns:

true if the operation is completed.

Throws:

java.io.IOException - if failed - specifically InterruptedIOException if waiting was interrupted

See Also:

await(long, CancelOption[])

await

default boolean await(long timeout,
                      java.util.concurrent.TimeUnit unit)
               throws java.io.IOException

Wait for the asynchronous operation to complete with the specified timeout.

Parameters:

timeout - The number of time units to wait

unit - The TimeUnit for waiting

Returns:

true if the operation is completed.

Throws:

java.io.IOException - if failed - specifically InterruptedIOException if waiting was interrupted

See Also:

await(long, CancelOption[])

await

default boolean await(long timeout,
                      java.util.concurrent.TimeUnit unit,
                      CancelOption... options)
               throws java.io.IOException

Wait for the asynchronous operation to complete with the specified timeout.

Parameters:

timeout - The number of time units to wait

unit - The TimeUnit for waiting

options - Optional CancelOptions defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.

Returns:

true if the operation is completed.

Throws:

java.io.IOException - if failed - specifically InterruptedIOException if waiting was interrupted

See Also:

await(long, CancelOption[])

await

default boolean await(java.time.Duration timeout)
               throws java.io.IOException

Wait for the asynchronous operation to complete with the specified timeout.

Parameters:

timeout - The maximum duration to wait, null to wait forever

Returns:

true if the operation is completed.

Throws:

java.io.IOException - if failed - specifically InterruptedIOException if waiting was interrupted

See Also:

await(long, CancelOption[])

await

default boolean await(java.time.Duration timeout,
                      CancelOption... options)
               throws java.io.IOException

Wait for the asynchronous operation to complete with the specified timeout.

Parameters:

timeout - The maximum duration to wait, null to wait forever

options - Optional CancelOptions defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.

Returns:

true if the operation is completed.

Throws:

java.io.IOException - if failed - specifically InterruptedIOException if waiting was interrupted

See Also:

await(long, CancelOption[])

await

default boolean await(long timeoutMillis)
               throws java.io.IOException

Wait for the asynchronous operation to complete with the specified timeout.

Parameters:

timeoutMillis - Wait time in milliseconds

Returns:

true if the operation is completed.

Throws:

java.io.IOException - if failed - specifically InterruptedIOException if waiting was interrupted

await

boolean await(long timeoutMillis,
              CancelOption... options)
       throws java.io.IOException

Wait for the asynchronous operation to complete with the specified timeout.

Parameters:

timeoutMillis - Wait time in milliseconds

options - Optional CancelOptions defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.

Returns:

true if the operation is completed.

Throws:

java.io.IOException - if failed - specifically InterruptedIOException if waiting was interrupted

awaitUninterruptibly

default boolean awaitUninterruptibly()

Wait Long.MAX_VALUE msec. for the asynchronous operation to complete uninterruptibly. The attached listeners will be notified when the operation is completed.

Returns:

true if the operation is completed.

See Also:

awaitUninterruptibly(long, CancelOption[])

awaitUninterruptibly

default boolean awaitUninterruptibly(CancelOption... options)

Wait Long.MAX_VALUE msec. for the asynchronous operation to complete uninterruptibly. The attached listeners will be notified when the operation is completed.

Parameters:

options - Optional CancelOptions defining the behavior on time-out; ignored if the future is not Cancellable.

Returns:

true if the operation is completed.

See Also:

awaitUninterruptibly(long, CancelOption[])

awaitUninterruptibly

default boolean awaitUninterruptibly(long timeout,
                                     java.util.concurrent.TimeUnit unit)

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

Parameters:

timeout - The number of time units to wait

unit - The TimeUnit for waiting

Returns:

true if the operation is completed.

See Also:

awaitUninterruptibly(long, CancelOption[])

awaitUninterruptibly

default boolean awaitUninterruptibly(long timeout,
                                     java.util.concurrent.TimeUnit unit,
                                     CancelOption... options)

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

Parameters:

timeout - The number of time units to wait

unit - The TimeUnit for waiting

options - Optional CancelOptions defining the behavior on time-out; ignored if the future is not Cancellable.

Returns:

true if the operation is completed.

See Also:

awaitUninterruptibly(long, CancelOption[])

awaitUninterruptibly

default boolean awaitUninterruptibly(java.time.Duration timeoutMillis)

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

Parameters:

timeoutMillis - Wait time, null to wait forever

Returns:

true if the operation is finished.

awaitUninterruptibly

default boolean awaitUninterruptibly(java.time.Duration timeoutMillis,
                                     CancelOption... options)

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

Parameters:

timeoutMillis - Wait time, null to wait forever

options - Optional CancelOptions defining the behavior on time-out; ignored if the future is not Cancellable.

Returns:

true if the operation is finished.

awaitUninterruptibly

default boolean awaitUninterruptibly(long timeoutMillis)

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

Parameters:

timeoutMillis - Wait time in milliseconds

Returns:

true if the operation is finished.

awaitUninterruptibly

boolean awaitUninterruptibly(long timeoutMillis,
                             CancelOption... options)

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

Parameters:

timeoutMillis - Wait time in milliseconds

options - Optional CancelOptions defining the behavior on time-out; ignored if the future is not Cancellable.

Returns:

true if the operation is finished.

isDone

boolean isDone()

Returns:

true if the asynchronous operation is completed. Note: it is up to the caller to determine whether it was a successful or failed completion.