org.apache.sshd.common.session

Class AbstractSession.PendingWriteFuture

java.lang.Object

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

org.apache.sshd.common.session.AbstractSession.PendingWriteFuture

All Implemented Interfaces:

EventListener, SshFuture<IoWriteFuture>, SshFutureListener<IoWriteFuture>, IoWriteFuture

Enclosing class:

AbstractSession

protected static class AbstractSession.PendingWriteFuture
extends DefaultSshFuture<IoWriteFuture>
implements IoWriteFuture, SshFutureListener<IoWriteFuture>

Future holding a packet pending key exchange termination.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSession.PendingWriteFuture(Buffer buffer)

Method Summary

Methods

Modifier and Type	Method and Description
Buffer	getBuffer()
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	operationComplete(IoWriteFuture future) Invoked when the operation associated with the SshFuture has been completed even if you add the listener after the completion.
void	setException(Throwable cause)
void	setWritten()
void	verify() Wait and verify that the write succeeded.

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

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

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

AbstractSession.PendingWriteFuture

protected AbstractSession.PendingWriteFuture(Buffer buffer)

Method Detail

getBuffer

public Buffer getBuffer()

verify

public void verify()
            throws SshException

Description copied from interface: IoWriteFuture

Wait and verify that the write succeeded.

Specified by:

verify in interface IoWriteFuture

Throws:

SshException - if the write failed for any reason

isWritten

public boolean isWritten()

Description copied from interface: IoWriteFuture

Returns true if the write operation is finished successfully.

Specified by:

isWritten in interface IoWriteFuture

getException

public Throwable getException()

Description copied from 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.

Specified by:

getException in interface IoWriteFuture

setWritten

public void setWritten()

setException

public void setException(Throwable cause)

operationComplete

public void operationComplete(IoWriteFuture future)

Description copied from interface: SshFutureListener

Invoked when the operation associated with the SshFuture has been completed even if you add the listener after the completion.

Specified by:

operationComplete in interface SshFutureListener<IoWriteFuture>

Parameters:

future - The source SshFuture which called this callback.