org.apache.sshd.common.io

Interface IoWriteFuture

All Superinterfaces:

SshFuture<IoWriteFuture>

All Known Implementing Classes:

AbstractSession.PendingWriteFuture

public interface IoWriteFuture
extends SshFuture<IoWriteFuture>

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.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	setException(java.lang.Throwable cause) Sets the cause of the write failure, and notifies all threads waiting for this future.
void	setWritten() Sets the message is written, and notifies all threads waiting for this future.

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

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

Method Detail

isWritten

boolean isWritten()

Returns true if the write operation is finished successfully.

getException

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

setWritten

void setWritten()

Sets the message is written, and notifies all threads waiting for this future. This method is invoked by MINA internally. Please do not call this method directly.

setException

void setException(java.lang.Throwable cause)

Sets the cause of the write failure, and notifies all threads waiting for this future. This method is invoked by MINA internally. Please do not call this method directly.