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 AbstractLoggingBean

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractIoWriteFuture(Object id, Object lock)

Method Summary

Modifier and Type	Method	Description
static IoWriteFuture	fulfilled(Object id, Object value)
Throwable	getException()
boolean	isWritten()
IoWriteFuture	verify(long timeout, CancelOption... options)	Wait and verify that the operation was successful

Methods inherited from class DefaultSshFuture

addListener, await0, createCancellation, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, removeListener, setValue, toString

Methods inherited from class AbstractSshFuture

asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResult

Methods inherited from class AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface SshFuture

addListener, removeListener

Methods inherited from interface VerifiableFuture

verify, verify, verify

Methods inherited from interface WaitableFuture

await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone

Constructor Details

AbstractIoWriteFuture

protected AbstractIoWriteFuture(Object id,
 Object lock)

Method Details

verify

public IoWriteFuture verify(long timeout,
 CancelOption... options)
                     throws IOException

Description copied from interface: VerifiableFuture

Wait and verify that the operation was successful

Specified by:

verify in interface VerifiableFuture<IoWriteFuture>

Parameters:

timeout - 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:

IOException - If failed to verify successfully on time

isWritten

public boolean isWritten()

Specified by:

isWritten in interface IoWriteFuture

Returns:

true if the write operation is finished successfully.

getException

public Throwable getException()

Specified by:

getException in interface IoWriteFuture

Returns:

the cause of the write failure if and only if the write operation has failed due to an Exception. Otherwise, null is returned (use WaitableFuture.isDone() to distinguish between the two.

fulfilled

public static IoWriteFuture fulfilled(Object id,
 Object value)