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, 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 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 and Description
ChannelAsyncOutputStream(Channel channel, byte cmd)
ChannelAsyncOutputStream(Channel channel, byte cmd, boolean sendChunkIfRemoteWindowIsSmallerThanPacketSize)

Method Summary

Modifier and Type	Method and 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()
void	setSendChunkIfRemoteWindowIsSmallerThanPacketSize(boolean sendChunkIfRemoteWindowIsSmallerThanPacketSize)
String	toString()
IoWriteFuture	writeBuffer(Buffer 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, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListener

Constructor Detail

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 use to establish compatibility with certain clients, that wait until the window size is 0 before adjusting it.

See Also:

SSHD-1123

Method Detail

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

Specified by:

writeBuffer in interface IoOutputStream

Throws:

IOException

preClose

protected void preClose()

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)