org.apache.sshd.common.io

Interface IoWriteFuture

All Superinterfaces:

SshFuture<IoWriteFuture>, VerifiableFuture<IoWriteFuture>, WaitableFuture

All Known Implementing Classes:

AbstractIoWriteFuture, IoWriteFutureImpl, Nio2DefaultIoWriteFuture, PendingWriteFuture

public interface IoWriteFuture
extends SshFuture<IoWriteFuture>, VerifiableFuture<IoWriteFuture>

Method Summary

Modifier and Type	Method and Description
java.lang.Throwable	getException()
boolean	isWritten()

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, verify

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 (use WaitableFuture.isDone() to distinguish between the two.