Package org.apache.sshd.common.io

Interface IoReadFuture

All Superinterfaces:

SshFuture<IoReadFuture>, VerifiableFuture<IoReadFuture>, WaitableFuture

All Known Implementing Classes:

ChannelAsyncInputStream.IoReadFutureImpl

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

Method Summary

Modifier and Type	Method	Description
Buffer	getBuffer()
Throwable	getException()	Returns the cause of the read failure.
int	getRead()

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

addListener, removeListener

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

verify, verify, verify, verify

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

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

Method Details

getBuffer

Buffer getBuffer()

getRead

int getRead()

getException

Throwable getException()

Returns the cause of the read failure.

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).