org.apache.sshd.common.io

Interface IoWriteFuture

All Superinterfaces:

SshFuture<IoWriteFuture>

All Known Implementing Classes:

AbstractIoWriteFuture, IoWriteFutureImpl, Nio2DefaultIoWriteFuture, PendingWriteFuture

public interface IoWriteFuture
extends SshFuture<IoWriteFuture>

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 interface org.apache.sshd.common.future.SshFuture

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

Method Detail

verify

void verify()
     throws IOException

Wait and verify that the write succeeded.

Throws:

IOException - if the write failed for any reason

verify

void verify(long count,
            TimeUnit unit)
     throws IOException

Throws:

IOException

verify

void verify(long timeout)
     throws IOException

Throws:

IOException

isWritten

boolean isWritten()

Returns:

true if the write operation is finished successfully.

getException

Throwable getException()

Returns:

the cause of the write failure if and only if the write operation has failed due to an Exception. Otherwise, null is returned.