org.apache.sshd.common.future

Interface VerifiableFuture<T>

Type Parameters:

T - Type of verification result

All Known Subinterfaces:

AuthFuture, ConnectFuture, IoReadFuture, IoWriteFuture, KeyExchangeFuture, OpenFuture

All Known Implementing Classes:

AbstractIoWriteFuture, ChannelAsyncInputStream.IoReadFutureImpl, DefaultAuthFuture, DefaultConnectFuture, DefaultKeyExchangeFuture, DefaultOpenFuture, DefaultVerifiableSshFuture, IoWriteFutureImpl, MinaSession.Future, Nio2DefaultIoWriteFuture, PendingWriteFuture

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

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
default T	verify() Wait Long.MAX_VALUE msec. and verify that the operation was successful
T	verify(long timeoutMillis) Wait and verify that the operation was successful
default T	verify(long timeout, TimeUnit unit) Wait and verify that the operation was successful

Method Detail

verify

default T verify()
          throws IOException

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

Returns:

The (same) future instance

Throws:

IOException - If failed to verify successfully on time

See Also:

verify(long)

verify

default T verify(long timeout,
                 TimeUnit unit)
          throws 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:

IOException - If failed to verify successfully on time

See Also:

verify(long)

verify

T verify(long timeoutMillis)
  throws IOException

Wait and verify that the operation was successful

Parameters:

timeoutMillis - Wait timeout in milliseconds

Returns:

The (same) future instance

Throws:

IOException - If failed to verify successfully on time