Modifier and Type	Class and Description
public static class	ChannelAsyncInputStream.IoReadFutureImpl

Modifier and Type	Field and Description
private final Buffer	buffer
private final Channel	channelInstance
private ChannelAsyncInputStream.IoReadFutureImpl	pending
private final Object	readFutureId

Access	Constructor and Description
public	ChannelAsyncInputStream(Channel channel)

Modifier and Type	Method and Description
protected CloseFuture	doCloseGracefully() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseGracefully.
private void	doRead(boolean resume)
public Channel	getChannel() Implements org.apache.sshd.common.channel.ChannelHolder.getChannel.
protected void	preClose() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.preClose. preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.
public IoReadFuture	read(Buffer the `Buffer` to use buf) Implements org.apache.sshd.common.io.IoInputStream.read. Note the buffer must not be touched until the returned read future is completed.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	write(Readable src)

buffer	back to summary
private final Buffer buffer

channelInstance	back to summary
private final Channel channelInstance

pending	back to summary
private ChannelAsyncInputStream.IoReadFutureImpl pending

readFutureId	back to summary
private final Object readFutureId

ChannelAsyncInputStream	back to summary
public ChannelAsyncInputStream(Channel channel)

Method Detail

doCloseGracefully	back to summary
protected CloseFuture doCloseGracefully() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseGracefully. Annotations @Override

doCloseGracefully

protected CloseFuture doCloseGracefully()

Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseGracefully.

Annotations

@Override

doRead	back to summary
private void doRead(boolean resume) Annotations @SuppressWarnings:synthetic-access

getChannel back to summary

getChannel	back to summary
public Channel getChannel() Implements org.apache.sshd.common.channel.ChannelHolder.getChannel. Returns:Channel Doc from org.apache.sshd.common.channel.ChannelHolder.getChannel. The associated `Channel` instance Annotations @Override

public Channel getChannel()

Implements org.apache.sshd.common.channel.ChannelHolder.getChannel.

Returns:Channel

Doc from org.apache.sshd.common.channel.ChannelHolder.getChannel.

The associated Channel instance

Annotations

@Override

preClose	back to summary
protected void preClose() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.preClose. Doc from org.apache.sshd.common.util.closeable.AbstractCloseable.preClose. preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately. When preClose() is called, isClosing() == true Annotations @Override

preClose

back to summary

protected void preClose()

Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.preClose.

Doc from org.apache.sshd.common.util.closeable.AbstractCloseable.preClose.

preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately. When preClose() is called, isClosing() == true

Annotations

@Override

read back to summary

read	back to summary
public IoReadFuture read(Buffer buf) Implements org.apache.sshd.common.io.IoInputStream.read. Doc from org.apache.sshd.common.io.IoInputStream.read. Note the buffer must not be touched until the returned read future is completed. Parameters buf:Buffer the `Buffer` to use Returns:IoReadFuture The `IoReadFuture` for the operation Annotations @Override

public IoReadFuture read(Buffer buf)

Implements org.apache.sshd.common.io.IoInputStream.read.

Doc from org.apache.sshd.common.io.IoInputStream.read.

Note

the buffer must not be touched until the returned read future is completed.

Parameters

buf:Buffer: the Buffer to use

Returns:IoReadFuture

The IoReadFuture for the operation

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

write	back to summary
public void write(Readable src) throws IOException

org.apache.sshd.common.channel back to summary

public Class ChannelAsyncInputStream.IoReadFutureImpl

Class Inheritance

extends DefaultVerifiableSshFuture<IoReadFuture>
implements IoReadFuture

java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.common.future.AbstractSshFuture
org.apache.sshd.common.future.DefaultSshFuture
org.apache.sshd.common.future.DefaultVerifiableSshFuture
org.apache.sshd.common.channel.ChannelAsyncInputStream.IoReadFutureImpl

All Implemented Interfaces

org.apache.sshd.common.io.IoReadFuture, org.apache.sshd.common.future.VerifiableFuture, org.apache.sshd.common.future.SshFuture, org.apache.sshd.common.future.WaitableFuture

Field Summary

Modifier and Type	Field and Description
pack-priv final Buffer	buffer

Constructor Summary

Access	Constructor and Description
public	IoReadFutureImpl(Object id, Buffer buffer)

Method Summary

Modifier and Type	Method and Description
public Buffer	getBuffer() Implements org.apache.sshd.common.io.IoReadFuture.getBuffer. Retrieves the buffer data was read into.
public Throwable	getException() Implements org.apache.sshd.common.io.IoReadFuture.getException. Returns the cause of the read failure.
public int	getRead() Implements org.apache.sshd.common.io.IoReadFuture.getRead. Retrieves the number of bytes read.
public IoReadFuture	verify(long Wait timeout in milliseconds timeoutMillis, CancelOption... Optional `CancelOption`s defining the behavior on time-out or interrupt; ignored if the future is not `Cancellable`. options) Implements org.apache.sshd.common.future.VerifiableFuture.verify. Wait and verify that the operation was successful

Field Detail

buffer	back to summary
pack-priv final Buffer buffer

Constructor Detail

IoReadFutureImpl	back to summary
public IoReadFutureImpl(Object id, Buffer buffer)

Method Detail

getBuffer back to summary

getBuffer	back to summary
public Buffer getBuffer() Implements org.apache.sshd.common.io.IoReadFuture.getBuffer. Doc from org.apache.sshd.common.io.IoReadFuture.getBuffer. Retrieves the buffer data was read into. Returns:Buffer the buffer, `null` if `isDone()` `== false` Annotations @Override

public Buffer getBuffer()

Implements org.apache.sshd.common.io.IoReadFuture.getBuffer.

Doc from org.apache.sshd.common.io.IoReadFuture.getBuffer.

Retrieves the buffer data was read into.

Returns:Buffer

the buffer, null if isDone() == false

Annotations

@Override

getException back to summary

getException	back to summary
public Throwable getException() Implements org.apache.sshd.common.io.IoReadFuture.getException. Doc from org.apache.sshd.common.io.IoReadFuture.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). Annotations @Override

public Throwable getException()

Implements org.apache.sshd.common.io.IoReadFuture.getException.

Doc from org.apache.sshd.common.io.IoReadFuture.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).

Annotations

@Override

getRead back to summary

getRead	back to summary
public int getRead() Implements org.apache.sshd.common.io.IoReadFuture.getRead. Doc from org.apache.sshd.common.io.IoReadFuture.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`) Annotations @Override

public int getRead()

Implements org.apache.sshd.common.io.IoReadFuture.getRead.

Doc from org.apache.sshd.common.io.IoReadFuture.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)

Annotations

@Override

verify back to summary

verify	back to summary
public IoReadFuture verify(long timeoutMillis, CancelOption... options) throws IOException Implements org.apache.sshd.common.future.VerifiableFuture.verify. Doc from org.apache.sshd.common.future.VerifiableFuture.verify. Wait and verify that the operation was successful Parameters timeoutMillis:long Wait timeout in milliseconds options:CancelOption[] Optional `CancelOption`s defining the behavior on time-out or interrupt; ignored if the future is not `Cancellable`. Returns:IoReadFuture The (same) future instance Annotations @Override Exceptions IOException: If failed to verify successfully on time

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

Implements org.apache.sshd.common.future.VerifiableFuture.verify.

Doc from org.apache.sshd.common.future.VerifiableFuture.verify.

Wait and verify that the operation was successful

Parameters

timeoutMillis:long: Wait timeout in milliseconds
options:CancelOption[]: Optional CancelOptions defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.

Returns:IoReadFuture

The (same) future instance

Annotations

@Override

Exceptions

IOException:: If failed to verify successfully on time

public Class ChannelAsyncInputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ChannelAsyncInputStream.IoReadFutureImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail