org.apache.sshd.common.channel.throttle

Interface ChannelStreamWriter

All Superinterfaces:

java.lang.AutoCloseable, java.nio.channels.Channel, java.io.Closeable

All Known Implementing Classes:

DefaultChannelStreamWriter

public interface ChannelStreamWriter
extends java.nio.channels.Channel

The ChannelStreamWriter is used when writing to the channel data stream. This data is encoded and sent with the SshConstants.SSH_MSG_CHANNEL_DATA and SshConstants.SSH_MSG_CHANNEL_EXTENDED_DATA commands.

Method Summary

Modifier and Type	Method and Description
IoWriteFuture	writeData(Buffer buffer) Encode and send the given data packet buffer.

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Method Detail

writeData

IoWriteFuture writeData(Buffer buffer)
                 throws java.io.IOException

Encode and send the given data packet buffer. Note: the buffer has to have 5 bytes free at the beginning to allow the encoding to take place. Also, the write position of the buffer has to be set to the position of the last byte to write.

Parameters:

buffer - the buffer to encode and send. 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 packet has actually been sent

Throws:

java.io.IOException - if an error occurred when encoding or sending the packet