Apache Mina SSHD 2.15.0 · org.apache.sshd.common.io.IoReadFuture

Method Summary

Modifier and Type	Method and Description
public Buffer	Returns: the buffer, `null` if `isDone()` `== false` getBuffer() Retrieves the buffer data was read into.
public Throwable	Returns: `null` if the read operation is not finished yet, or if the read attempt is successful (use `isDone()` to distinguish between the two). getException() Returns the cause of the read failure.
public int	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 (`isDone()` `== false`) getRead() Retrieves the number of bytes read.

Inherited from org.apache.sshd.common.future.SshFuture:: addListener removeListener
Inherited from org.apache.sshd.common.future.VerifiableFuture:: verify verify verify verify verify verify verify verify

getBuffer back to summary

getBuffer	back to summary
public Buffer getBuffer() Retrieves the buffer data was read into. Returns:Buffer the buffer, `null` if `isDone()` `== false`

public Buffer getBuffer()

Retrieves the buffer data was read into.

getException back to summary

getException	back to summary
public Throwable getException() Returns the cause of the read failure. An `java.io.EOFException` indicates that nothing was read because the source of the read is exhausted. Returns:Throwable `null` if the read operation is not finished yet, or if the read attempt is successful (use `isDone()` to distinguish between the two).

public Throwable getException()

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

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

getRead back to summary

getRead	back to summary
public int getRead() Retrieves the number of bytes read. Returns:int 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 (`isDone()` `== false`)

public int getRead()

Retrieves the number of bytes read.

Returns:int: 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 (isDone() == false)