Package org.apache.sshd.common.channel

Class ChannelAsyncOutputStream

java.lang.Object

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

org.apache.sshd.common.util.closeable.IoBaseCloseable

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

org.apache.sshd.common.channel.ChannelAsyncOutputStream

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ChannelHolder, Closeable, IoOutputStream

public class ChannelAsyncOutputStream
extends AbstractCloseable
implements IoOutputStream, ChannelHolder

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

AbstractCloseable.State

Field Summary

Fields

Modifier and Type	Field	Description
private final Channel	channelInstance
private final byte	cmd
private final Object	packetWriteId
private final ChannelStreamWriter	packetWriter
private final AtomicReference<IoWriteFutureImpl>	pendingWrite
private boolean	sendChunkIfRemoteWindowIsSmallerThanPacketSize

Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

closeFuture, futureLock, state

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor	Description
ChannelAsyncOutputStream(Channel channel, byte cmd)
ChannelAsyncOutputStream(Channel channel, byte cmd, boolean sendChunkIfRemoteWindowIsSmallerThanPacketSize)

Method Summary

Modifier and Type	Method	Description
protected Buffer	createSendBuffer(Buffer buffer, Channel channel, long length)
protected CloseFuture	doCloseGracefully()
protected void	doWriteIfPossible(boolean resume)
Channel	getChannel()
byte	getCommandType()
boolean	isSendChunkIfRemoteWindowIsSmallerThanPacketSize()
void	onWindowExpanded()
protected void	onWritten(IoWriteFutureImpl future, int total, long length, IoWriteFuture f)
protected void	preClose()	preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.
void	setSendChunkIfRemoteWindowIsSmallerThanPacketSize(boolean sendChunkIfRemoteWindowIsSmallerThanPacketSize)
String	toString()
IoWriteFuture	writeBuffer(Buffer buffer)	Write the given buffer.

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

addCloseFutureListener, builder, close, doCloseImmediately, getFutureLock, isClosed, isClosing, removeCloseFutureListener

Methods inherited from class org.apache.sshd.common.util.logging.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 java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.Closeable

addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListener

Field Details

channelInstance

private final Channel channelInstance

packetWriter

private final ChannelStreamWriter packetWriter

cmd

private final byte cmd

pendingWrite

private final AtomicReference<IoWriteFutureImpl> pendingWrite

packetWriteId

private final Object packetWriteId

sendChunkIfRemoteWindowIsSmallerThanPacketSize

private boolean sendChunkIfRemoteWindowIsSmallerThanPacketSize

Constructor Details

ChannelAsyncOutputStream

public ChannelAsyncOutputStream(Channel channel,
 byte cmd)

Parameters:

channel - The Channel through which the stream is communicating

cmd - Either SSH_MSG_CHANNEL_DATA or SSH_MSG_CHANNEL_EXTENDED_DATA indicating the output stream type

ChannelAsyncOutputStream

public ChannelAsyncOutputStream(Channel channel,
 byte cmd,
 boolean sendChunkIfRemoteWindowIsSmallerThanPacketSize)

Parameters:

channel - The Channel through which the stream is communicating

cmd - Either SSH_MSG_CHANNEL_DATA or SSH_MSG_CHANNEL_EXTENDED_DATA indicating the output stream type

sendChunkIfRemoteWindowIsSmallerThanPacketSize - Determines the chunking behaviour, if the remote window size is smaller than the packet size. Can be used to establish compatibility with certain clients, that wait until the window size is 0 before adjusting it.

See Also:

• SSHD-1123

Method Details

getChannel

public Channel getChannel()

Specified by:

getChannel in interface ChannelHolder

Returns:

The associated Channel instance

getCommandType

public byte getCommandType()

Returns:

Either SSH_MSG_CHANNEL_DATA or SSH_MSG_CHANNEL_EXTENDED_DATA indicating the output stream type

onWindowExpanded

public void onWindowExpanded()
                      throws IOException

Throws:

IOException

writeBuffer

public IoWriteFuture writeBuffer(Buffer buffer)
                          throws IOException

Description copied from interface: IoOutputStream

Write the given buffer.

Specified by:

writeBuffer in interface IoOutputStream

Parameters:

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

Returns:

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

Throws:

IOException - if an error occurred when writing the data

preClose

protected void preClose()

Description copied from class: AbstractCloseable

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

Overrides:

preClose in class AbstractCloseable

doCloseGracefully

protected CloseFuture doCloseGracefully()

Overrides:

doCloseGracefully in class AbstractCloseable

doWriteIfPossible

protected void doWriteIfPossible(boolean resume)

onWritten

protected void onWritten(IoWriteFutureImpl future,
 int total,
 long length,
 IoWriteFuture f)

createSendBuffer

protected Buffer createSendBuffer(Buffer buffer,
 Channel channel,
 long length)

toString

public String toString()

Overrides:

toString in class Object

isSendChunkIfRemoteWindowIsSmallerThanPacketSize

public boolean isSendChunkIfRemoteWindowIsSmallerThanPacketSize()

setSendChunkIfRemoteWindowIsSmallerThanPacketSize

public void setSendChunkIfRemoteWindowIsSmallerThanPacketSize(boolean sendChunkIfRemoteWindowIsSmallerThanPacketSize)