Package 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
,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 theverifyXXX
method returns without an exception then the operation was completed successfully
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default T
verify()
WaitLong.MAX_VALUE
msec.T
verify(long timeoutMillis)
Wait and verify that the operation was successfuldefault T
verify(long timeout, java.util.concurrent.TimeUnit unit)
Wait and verify that the operation was successfuldefault T
verify(java.time.Duration timeout)
Wait and verify that the operation was successful
-
-
-
Method Detail
-
verify
default T verify() throws java.io.IOException
WaitLong.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)
-
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 waitunit
- The waitTimeUnit
- Returns:
- The (same) future instance
- Throws:
java.io.IOException
- If failed to verify successfully on time- See Also:
verify(long)
-
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)
-
verify
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
-
-