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 Details

    • verify

      default T verify(CancelOption... options) throws IOException
      Wait Long.MAX_VALUE msec. and verify that the operation was successful
      Parameters:
      options - Optional
      invalid reference
      CancelOptions
      defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.
      Returns:
      The (same) future instance
      Throws:
      IOException - If failed to verify successfully on time
      See Also:
      • invalid reference
        #verify(long)
    • verify

      default T verify(long timeout, TimeUnit unit, CancelOption... options) throws IOException
      Wait and verify that the operation was successful
      Parameters:
      timeout - The number of time units to wait
      unit - The wait TimeUnit
      options - Optional
      invalid reference
      CancelOptions
      defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.
      Returns:
      The (same) future instance
      Throws:
      IOException - If failed to verify successfully on time
      See Also:
      • invalid reference
        #verify(long)
    • verify

      default T verify(Duration timeout, CancelOption... options) throws IOException
      Wait and verify that the operation was successful
      Parameters:
      timeout - The maximum duration to wait, null to wait forever
      options - Optional
      invalid reference
      CancelOptions
      defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.
      Returns:
      The (same) future instance
      Throws:
      IOException - If failed to verify successfully on time
      See Also:
      • invalid reference
        #verify(long)
    • verify

      T verify(long timeoutMillis, CancelOption... options) throws IOException
      Wait and verify that the operation was successful
      Parameters:
      timeoutMillis - Wait timeout in milliseconds
      options - Optional
      invalid reference
      CancelOptions
      defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.
      Returns:
      The (same) future instance
      Throws:
      IOException - If failed to verify successfully on time