Package org.apache.sshd.common.io
Class AbstractIoWriteFuture
java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.common.future.AbstractSshFuture<IoWriteFuture>
org.apache.sshd.common.future.DefaultSshFuture<IoWriteFuture>
org.apache.sshd.common.future.DefaultVerifiableSshFuture<IoWriteFuture>
org.apache.sshd.common.io.AbstractIoWriteFuture
- All Implemented Interfaces:
SshFuture<IoWriteFuture>,VerifiableFuture<IoWriteFuture>,WaitableFuture,IoWriteFuture
- Direct Known Subclasses:
IoWriteFutureImpl,Nio2DefaultIoWriteFuture,PendingWriteFuture,SimpleIoOutputStream.DefaultIoWriteFuture
public abstract class AbstractIoWriteFuture
extends DefaultVerifiableSshFuture<IoWriteFuture>
implements IoWriteFuture
-
Field Summary
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic IoWriteFuturebooleanverify(long timeout, CancelOption... options) Wait and verify that the operation was successfulMethods inherited from class org.apache.sshd.common.future.DefaultSshFuture
addListener, await0, createCancellation, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, removeListener, setValue, toStringMethods inherited from class org.apache.sshd.common.future.AbstractSshFuture
asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResultMethods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warnMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.sshd.common.future.SshFuture
addListener, removeListenerMethods inherited from interface org.apache.sshd.common.future.VerifiableFuture
verify, verify, verifyMethods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone
-
Constructor Details
-
AbstractIoWriteFuture
-
-
Method Details
-
verify
Description copied from interface:VerifiableFutureWait and verify that the operation was successful- Specified by:
verifyin interfaceVerifiableFuture<IoWriteFuture>- Parameters:
timeout- Wait timeout in millisecondsoptions- OptionalCancelOptions defining the behavior on time-out or interrupt; ignored if the future is notCancellable.- Returns:
- The (same) future instance
- Throws:
IOException- If failed to verify successfully on time
-
isWritten
public boolean isWritten()- Specified by:
isWrittenin interfaceIoWriteFuture- Returns:
- true if the write operation is finished successfully.
-
getException
- Specified by:
getExceptionin interfaceIoWriteFuture- Returns:
- the cause of the write failure if and only if the write operation has failed due to an
Exception. Otherwise,nullis returned (useWaitableFuture.isDone()to distinguish between the two.
-
fulfilled
-