org.apache.sshd.common.io

Class AbstractIoWriteFuture

java.lang.Object

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

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

org.apache.sshd.common.io.AbstractIoWriteFuture

All Implemented Interfaces:

SshFuture<IoWriteFuture>, IoWriteFuture

Direct Known Subclasses:

IoWriteFutureImpl, Nio2DefaultIoWriteFuture, PendingWriteFuture

public abstract class AbstractIoWriteFuture
extends DefaultSshFuture<IoWriteFuture>
implements IoWriteFuture

Author:

Apache MINA SSHD Project

Field Summary

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

log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIoWriteFuture(Object lock)

Method Summary

Modifier and Type	Method and Description
Throwable	getException()
boolean	isWritten()
void	verify() Wait and verify that the write succeeded.
void	verify(long timeout)
void	verify(long count, TimeUnit unit)

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

addListener, await, await, await, await0, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cancel, getValue, isCanceled, isDone, removeListener, setValue, verifyResult

Methods inherited from class java.lang.Object

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

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

addListener, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, isDone, removeListener

Constructor Detail

AbstractIoWriteFuture

protected AbstractIoWriteFuture(Object lock)

Method Detail

verify

public void verify()
            throws IOException

Description copied from interface: IoWriteFuture

Wait and verify that the write succeeded.

Specified by:

verify in interface IoWriteFuture

Throws:

IOException - if the write failed for any reason

verify

public void verify(long count,
                   TimeUnit unit)
            throws IOException

Specified by:

verify in interface IoWriteFuture

Throws:

IOException

verify

public void verify(long timeout)
            throws IOException

Specified by:

verify in interface IoWriteFuture

Throws:

IOException

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.