Modifier and Type	Class and Description
protected static class	ChannelAsyncOutputStream.BufferedFuture Marker type to avoid repeated buffering in `ChannelAsyncOutputStream#writePacket(IoWriteFutureImpl, boolean)`.
protected static class	ChannelAsyncOutputStream.WriteState Collects state variables; access is always synchronized on the single instance per stream.

Modifier and Type	Field and Description
private final Channel	channelInstance
private final byte	cmd
protected final AtomicReference<IoWriteFuture>	lastWrite The future describing the last executed buffer write `ChannelAsyncOutputStream#writeBuffer(Buffer)`.
private final Object	packetWriteId
private final ChannelStreamWriter	packetWriter
protected final ChannelAsyncOutputStream.WriteState	writeState Encapsulates the state of the current write operation.

Access	Constructor and Description
public	ChannelAsyncOutputStream(Channel The `Channel` through which the stream is communicating channel, byte Either `SSH_MSG_CHANNEL_DATA` or `SSH_MSG_CHANNEL_EXTENDED_DATA` indicating the output stream type cmd)

Method Summary

Modifier and Type	Method and Description
private boolean	abortWrite(AbstractCloseable.State openState)
protected Buffer	createSendBuffer(Buffer buffer, Channel channel, int length)
protected CloseFuture	doCloseGracefully() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseGracefully.
protected void	doCloseImmediately() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseImmediately. doCloseImmediately is called once and only once with state == Immediate Overriding methods should always call the base implementation.
protected void	doWriteIfPossible(boolean resume)
public Channel	getChannel() Implements org.apache.sshd.common.channel.ChannelHolder.getChannel.
public byte	Returns: Either `SSH_MSG_CHANNEL_DATA` or `SSH_MSG_CHANNEL_EXTENDED_DATA` indicating the output stream type getCommandType()
public void	onWindowExpanded()
protected void	onWritten(IoWriteFutureImpl future, int total, int length, IoWriteFuture f)
protected void	preClose() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.preClose. preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.
protected void	shutdown()
protected void	terminateFuture(IoWriteFutureImpl future)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public IoWriteFuture	writeBuffer(Buffer the data to write Note the buffer must not be touched until the returned write future is completed. buffer) Implements org.apache.sshd.common.io.IoOutputStream.writeBuffer. Write the given buffer.
protected IoWriteFutureImpl	Returns: `null` if all written, or if the rest will be written via a future listener. Otherwise a future for the remaining writes. writePacket(IoWriteFutureImpl `IoWriteFutureImpl` for the current write future, boolean whether being called in response to a remote window adjustment resume) Try to write as much of the current buffer as possible.

Inherited from org.apache.sshd.common.util.closeable.AbstractCloseable:: addCloseFutureListener builder close getFutureLock isClosed isClosing removeCloseFutureListener

Field Detail

channelInstance	back to summary
private final Channel channelInstance

cmd	back to summary
private final byte cmd

lastWrite	back to summary
protected final AtomicReference<IoWriteFuture> lastWrite The future describing the last executed buffer write `ChannelAsyncOutputStream#writeBuffer(Buffer)`. Used for graceful closing.

packetWriteId	back to summary
private final Object packetWriteId

packetWriter	back to summary
private final ChannelStreamWriter packetWriter

writeState	back to summary
protected final ChannelAsyncOutputStream.WriteState writeState Encapsulates the state of the current write operation. Access is always under lock (on writeState's monitor), the lock is held only shortly and never while writing.

Constructor Detail

ChannelAsyncOutputStream	back to summary
public ChannelAsyncOutputStream(Channel channel, byte cmd) Parameters channel:Channel The `Channel` through which the stream is communicating cmd:byte Either `SSH_MSG_CHANNEL_DATA` or `SSH_MSG_CHANNEL_EXTENDED_DATA` indicating the output stream type

Method Detail

abortWrite	back to summary
private boolean abortWrite(AbstractCloseable.State openState)

createSendBuffer	back to summary
protected Buffer createSendBuffer(Buffer buffer, Channel channel, int length)

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

doCloseGracefully

back to summary

protected CloseFuture doCloseGracefully()

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

Annotations

@Override

doCloseImmediately	back to summary
protected void doCloseImmediately() Overrides org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseImmediately. Doc from org.apache.sshd.common.util.closeable.AbstractCloseable.doCloseImmediately. doCloseImmediately is called once and only once with state == Immediate Overriding methods should always call the base implementation. It may be called concurrently while preClose() or doCloseGracefully is executing Annotations @Override

doCloseImmediately

back to summary

protected void doCloseImmediately()

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

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

doCloseImmediately is called once and only once with state == Immediate Overriding methods should always call the base implementation. It may be called concurrently while preClose() or doCloseGracefully is executing

Annotations

@Override

doWriteIfPossible	back to summary
protected void doWriteIfPossible(boolean resume)

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

getCommandType	back to summary
public byte getCommandType() Returns:byte Either `SSH_MSG_CHANNEL_DATA` or `SSH_MSG_CHANNEL_EXTENDED_DATA` indicating the output stream type

onWindowExpanded	back to summary
public void onWindowExpanded() throws IOException

onWritten	back to summary
protected void onWritten(IoWriteFutureImpl future, int total, int length, IoWriteFuture f)

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

shutdown	back to summary
protected void shutdown()

terminateFuture	back to summary
protected void terminateFuture(IoWriteFutureImpl future)

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

writeBuffer back to summary

writeBuffer	back to summary
public IoWriteFuture writeBuffer(Buffer buffer) throws IOException Implements org.apache.sshd.common.io.IoOutputStream.writeBuffer. Doc from org.apache.sshd.common.io.IoOutputStream.writeBuffer. Write the given buffer. This write operation is asynchronous: if there is not enough window space, it may keep the write pending or write only part of the buffer and keep the rest pending. Concurrent writes are not allowed and will throw a `WritePendingException`. Any subsequent write must occur only once the returned future is fulfilled; for instance triggered via a listener on the returned future. Try to avoid doing a subsequent write directly in a future listener, though; doing so may lead to deep chains of nested listener calls with deep stack traces, and may ultimately lead to a stack overflow. Parameters buffer:Buffer the data to write Note the buffer must not be touched until the returned write future is completed. Returns:IoWriteFuture An `IoWriteFuture` that can be used to check when the data has actually been written. Annotations @Override Exceptions IOException: if an error occurred when writing the data WritePendingException: if a concurrent write is attempted

public IoWriteFuture writeBuffer(Buffer buffer) throws IOException

Implements org.apache.sshd.common.io.IoOutputStream.writeBuffer.

Doc from org.apache.sshd.common.io.IoOutputStream.writeBuffer.

Write the given buffer. This write operation is asynchronous: if there is not enough window space, it may keep the write pending or write only part of the buffer and keep the rest pending. Concurrent writes are not allowed and will throw a WritePendingException. Any subsequent write must occur only once the returned future is fulfilled; for instance triggered via a listener on the returned future. Try to avoid doing a subsequent write directly in a future listener, though; doing so may lead to deep chains of nested listener calls with deep stack traces, and may ultimately lead to a stack overflow.

Parameters

buffer:Buffer: the data to write
Note
the buffer must not be touched until the returned write future is completed.

Returns:IoWriteFuture

An IoWriteFuture that can be used to check when the data has actually been written.

Annotations

@Override

Exceptions

IOException:: if an error occurred when writing the data
WritePendingException:: if a concurrent write is attempted

writePacket back to summary

writePacket	back to summary
protected IoWriteFutureImpl writePacket(IoWriteFutureImpl future, boolean resume) Try to write as much of the current buffer as possible. If the buffer is larger than the packet size split it in packets, writing one after the other by chaining futures. If there is not enough window space, stop writing. Writing will be resumed once the window has been enlarged again. Parameters future:IoWriteFutureImpl `IoWriteFutureImpl` for the current write resume:boolean whether being called in response to a remote window adjustment Returns:IoWriteFutureImpl `null` if all written, or if the rest will be written via a future listener. Otherwise a future for the remaining writes.

protected IoWriteFutureImpl writePacket(IoWriteFutureImpl future, boolean resume)

Try to write as much of the current buffer as possible. If the buffer is larger than the packet size split it in packets, writing one after the other by chaining futures. If there is not enough window space, stop writing. Writing will be resumed once the window has been enlarged again.

Parameters

future:IoWriteFutureImpl: IoWriteFutureImpl for the current write
resume:boolean: whether being called in response to a remote window adjustment

Returns:IoWriteFutureImpl

null if all written, or if the rest will be written via a future listener. Otherwise a future for the remaining writes.

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

protected Class ChannelAsyncOutputStream.BufferedFuture

Class Inheritance

extends IoWriteFutureImpl

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.io.AbstractIoWriteFuture
org.apache.sshd.common.channel.IoWriteFutureImpl
org.apache.sshd.common.channel.ChannelAsyncOutputStream.BufferedFuture

Marker type to avoid repeated buffering in ChannelAsyncOutputStream#writePacket(IoWriteFutureImpl, boolean).

Field Summary

Modifier and Type	Field and Description
protected boolean	waitOnWindow

Constructor Summary

Access	Constructor and Description
pack-priv	BufferedFuture(Object id, Buffer buffer)

Method Summary

Inherited from org.apache.sshd.common.channel.IoWriteFutureImpl:: getBuffer

Field Detail

waitOnWindow	back to summary
protected boolean waitOnWindow

Constructor Detail

BufferedFuture	back to summary
pack-priv BufferedFuture(Object id, Buffer buffer)

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

protected Class ChannelAsyncOutputStream.WriteState

Class Inheritance

extends Object

java.lang.Object
org.apache.sshd.common.channel.ChannelAsyncOutputStream.WriteState

Collects state variables; access is always synchronized on the single instance per stream.

Field Summary

Modifier and Type	Field and Description
protected AbstractCloseable.State	openState A copy of this stream's state as set by the superclass.
protected IoWriteFutureImpl	pendingWrite The future describing the current packet write; if `null`, there is nothing to write or `ChannelAsyncOutputStream#writePacket(IoWriteFutureImpl, boolean)` is running.
protected int	toSend Number of bytes still to send.
protected int	totalLength Number of bytes to send in total.
protected boolean	windowExpanded Set to true when there was a remote window expansion while `ChannelAsyncOutputStream#writePacket(IoWriteFutureImpl, boolean)` was in progress.
protected boolean	writeInProgress Flag to throw an exception if non-sequential `ChannelAsyncOutputStream#writeBuffer(Buffer)` calls should occur.

Constructor Summary

Access	Constructor and Description
protected	WriteState()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

openState	back to summary
protected AbstractCloseable.State openState A copy of this stream's state as set by the superclass.

pendingWrite	back to summary
protected IoWriteFutureImpl pendingWrite The future describing the current packet write; if `null`, there is nothing to write or `ChannelAsyncOutputStream#writePacket(IoWriteFutureImpl, boolean)` is running.

toSend	back to summary
protected int toSend Number of bytes still to send.

totalLength	back to summary
protected int totalLength Number of bytes to send in total.

windowExpanded	back to summary
protected boolean windowExpanded Set to true when there was a remote window expansion while `ChannelAsyncOutputStream#writePacket(IoWriteFutureImpl, boolean)` was in progress. If set, `ChannelAsyncOutputStream#doWriteIfPossible(boolean)` will run a `ChannelAsyncOutputStream#writePacket(IoWriteFutureImpl, boolean)` again.

writeInProgress	back to summary
protected boolean writeInProgress Flag to throw an exception if non-sequential `ChannelAsyncOutputStream#writeBuffer(Buffer)` calls should occur.

Constructor Detail

WriteState	back to summary
protected WriteState()

public Class ChannelAsyncOutputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class ChannelAsyncOutputStream.BufferedFuture

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

protected Class ChannelAsyncOutputStream.WriteState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail