org.apache.sshd.common.io

Class AbstractIoWriteFuture

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.future.AbstractSshFuture<T>

org.apache.sshd.common.future.DefaultSshFuture<T>

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

public abstract class AbstractIoWriteFuture
extends DefaultVerifiableSshFuture<IoWriteFuture>
implements IoWriteFuture

Field Summary

Fields inherited from class org.apache.sshd.common.future.AbstractSshFuture

CANCELED, debugEnabled, traceEnabled

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIoWriteFuture(java.lang.Object id, java.lang.Object lock)

Method Summary

Modifier and Type	Method and Description
java.lang.Throwable	getException()
boolean	isWritten()
IoWriteFuture	verify(long timeout) Wait and verify that the operation was successful

Methods inherited from class org.apache.sshd.common.future.DefaultSshFuture

addListener, await0, cancel, getNumRegisteredListeners, getValue, isCanceled, isDone, notifyListeners, removeListener, setValue, toString

Methods inherited from class org.apache.sshd.common.future.AbstractSshFuture

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

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.future.SshFuture

addListener, removeListener

Methods inherited from interface org.apache.sshd.common.future.WaitableFuture

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

Methods inherited from interface org.apache.sshd.common.future.VerifiableFuture

verify, verify

Constructor Detail

AbstractIoWriteFuture

protected AbstractIoWriteFuture(java.lang.Object id,
                                java.lang.Object lock)

Method Detail

verify

public IoWriteFuture verify(long timeout)
                     throws java.io.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

Returns:

The (same) future instance

Throws:

java.io.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 java.lang.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.