Package org.apache.sshd.common.future

Interface VerifiableFuture<T>

Type Parameters:

T - Type of verification result

All Known Subinterfaces:

AuthFuture, CancelFuture, ConnectFuture, IoReadFuture, IoWriteFuture, KeyExchangeFuture, OpenFuture

All Known Implementing Classes:

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

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface VerifiableFuture<T>

Represents an asynchronous operation whose successful result can be verified somehow. The contract guarantees that if the verifyXXX method returns without an exception then the operation was completed successfully

Method Summary

Modifier and Type	Method	Description
default T	verify()	Wait Long.MAX_VALUE msec.
default T	verify(long timeoutMillis)	Wait and verify that the operation was successful
default T	verify(long timeout, java.util.concurrent.TimeUnit unit)	Wait and verify that the operation was successful
default T	verify(long timeout, java.util.concurrent.TimeUnit unit, CancelOption... options)	Wait and verify that the operation was successful
T	verify(long timeoutMillis, CancelOption... options)	Wait and verify that the operation was successful
default T	verify(java.time.Duration timeout)	Wait and verify that the operation was successful
default T	verify(java.time.Duration timeout, CancelOption... options)	Wait and verify that the operation was successful
default T	verify(CancelOption... options)	Wait Long.MAX_VALUE msec.

Method Detail

verify

default T verify()
          throws java.io.IOException

Wait Long.MAX_VALUE msec. and verify that the operation was successful

Returns:

The (same) future instance

Throws:

java.io.IOException - If failed to verify successfully on time

See Also:

verify(long, CancelOption[])

verify

default T verify(CancelOption... options)
          throws java.io.IOException

Wait Long.MAX_VALUE msec. and verify that the operation was successful

Parameters:

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

Returns:

The (same) future instance

Throws:

java.io.IOException - If failed to verify successfully on time

See Also:

verify(long, CancelOption[])

verify

default T verify(long timeout,
                 java.util.concurrent.TimeUnit unit)
          throws java.io.IOException

Wait and verify that the operation was successful

Parameters:

timeout - The number of time units to wait

unit - The wait TimeUnit

Returns:

The (same) future instance

Throws:

java.io.IOException - If failed to verify successfully on time

See Also:

verify(long, CancelOption[])

verify

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

Wait and verify that the operation was successful

Parameters:

timeout - The number of time units to wait

unit - The wait TimeUnit

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

Returns:

The (same) future instance

Throws:

java.io.IOException - If failed to verify successfully on time

See Also:

verify(long, CancelOption[])

verify

default T verify(java.time.Duration timeout)
          throws java.io.IOException

Wait and verify that the operation was successful

Parameters:

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

Returns:

The (same) future instance

Throws:

java.io.IOException - If failed to verify successfully on time

See Also:

verify(long, CancelOption[])

verify

default T verify(java.time.Duration timeout,
                 CancelOption... options)
          throws java.io.IOException

Wait and verify that the operation was successful

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:

The (same) future instance

Throws:

java.io.IOException - If failed to verify successfully on time

See Also:

verify(long, CancelOption[])

verify

default T verify(long timeoutMillis)
          throws java.io.IOException

Wait and verify that the operation was successful

Parameters:

timeoutMillis - Wait timeout in milliseconds

Returns:

The (same) future instance

Throws:

java.io.IOException - If failed to verify successfully on time

verify

T verify(long timeoutMillis,
         CancelOption... options)
  throws java.io.IOException

Wait and verify that the operation was successful

Parameters:

timeoutMillis - Wait timeout in milliseconds

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

Returns:

The (same) future instance

Throws:

java.io.IOException - If failed to verify successfully on time