Class ChannelAsyncInputStream.IoReadFutureImpl

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.future.AbstractSshFuture<IoReadFuture>

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

org.apache.sshd.common.future.DefaultVerifiableSshFuture<IoReadFuture>

org.apache.sshd.common.channel.ChannelAsyncInputStream.IoReadFutureImpl

All Implemented Interfaces:

SshFuture<IoReadFuture>, VerifiableFuture<IoReadFuture>, WaitableFuture, IoReadFuture

Enclosing class:

ChannelAsyncInputStream

public static class ChannelAsyncInputStream.IoReadFutureImpl
extends DefaultVerifiableSshFuture<IoReadFuture>
implements IoReadFuture

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final Buffer	buffer

Fields inherited from class AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor	Description
IoReadFutureImpl(Object id, Buffer buffer)

Method Summary

Modifier and Type	Method	Description
Buffer	getBuffer()	Retrieves the buffer data was read into.
Throwable	getException()	Returns the cause of the read failure.
int	getRead()	Retrieves the number of bytes read.
IoReadFuture	verify(long timeoutMillis, CancelOption... options)	Wait and verify that the operation was successful

Methods inherited from class DefaultSshFuture

addListener, await0, createCancellation, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, removeListener, setValue, toString

Methods inherited from class AbstractSshFuture

asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResult

Methods inherited from class AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface SshFuture

addListener, removeListener

Methods inherited from interface VerifiableFuture

verify, verify, verify, verify, verify, verify, verify

Methods inherited from interface WaitableFuture

await, await, await, await, await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone

Field Details

buffer

final Buffer buffer

Constructor Details

IoReadFutureImpl

public IoReadFutureImpl(Object id,
 Buffer buffer)

Method Details

getBuffer

public Buffer getBuffer()

Description copied from interface: IoReadFuture

Retrieves the buffer data was read into.

Specified by:

getBuffer in interface IoReadFuture

Returns:

the buffer, null if WaitableFuture.isDone() == false

verify

public IoReadFuture verify(long timeoutMillis,
 CancelOption... options)
                    throws IOException

Description copied from interface: VerifiableFuture

Wait and verify that the operation was successful

Specified by:

verify in interface VerifiableFuture<IoReadFuture>

Parameters:

timeoutMillis - Wait timeout in milliseconds

options - Optional CancelOptions defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.

Returns:

The (same) future instance

Throws:

IOException - If failed to verify successfully on time

getRead

public int getRead()

Description copied from interface: IoReadFuture

Retrieves the number of bytes read.

Specified by:

getRead in interface IoReadFuture

Returns:

The number of bytes read, or -1 if the source of the read has been exhausted (is at EOF), or zero if the read is not done yet (WaitableFuture.isDone() == false)

getException

public Throwable getException()

Description copied from interface: IoReadFuture

Returns the cause of the read failure. An EOFException indicates that nothing was read because the source of the read is exhausted.

Specified by:

getException in interface IoReadFuture

Returns:

null if the read operation is not finished yet, or if the read attempt is successful (use WaitableFuture.isDone() to distinguish between the two).