org.apache.sshd.common.io

Interface IoWriteFuture

All Superinterfaces:

SshFuture<IoWriteFuture>

All Known Implementing Classes:

AbstractSession.PendingWriteFuture, ChannelAsyncOutputStream.IoWriteFutureImpl

public interface IoWriteFuture
extends SshFuture<IoWriteFuture>

Method Summary

Methods

Modifier and Type	Method and Description
Throwable	getException() Returns the cause of the write failure if and only if the write operation has failed due to an Exception.
boolean	isWritten() Returns true if the write operation is finished successfully.
void	verify() Wait and verify that the write succeeded.

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 SshException

Wait and verify that the write succeeded.

Throws:

SshException - if the write failed for any reason

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.