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, lock, state

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

log

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

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ChannelAsyncOutputStream(Channel channel, byte cmd)

Method Summary

Modifier and Type	Method and Description
protected CloseFuture	doCloseGracefully()
protected void	doWriteIfPossible(boolean resume)
Channel	getChannel()
void	onWindowExpanded()
String	toString()
IoWriteFuture	write(Buffer buffer) NOTE: the buffer must not be touched until the returned write future is completed.

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

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

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

getSimplifiedLogger

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)

Method Detail

getChannel

public Channel getChannel()

Specified by:

getChannel in interface ChannelHolder

Returns:

The associated Channel instance

onWindowExpanded

public void onWindowExpanded()
                      throws IOException

Throws:

IOException

write

public IoWriteFuture write(Buffer buffer)

Description copied from interface: IoOutputStream

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

Specified by:

write in interface IoOutputStream

Parameters:

buffer - the Buffer to use

Returns:

The IoWriteFuture for the operation

doCloseGracefully

protected CloseFuture doCloseGracefully()

Overrides:

doCloseGracefully in class AbstractCloseable

doWriteIfPossible

protected void doWriteIfPossible(boolean resume)

toString

public String toString()

Overrides:

toString in class Object