org.apache.sshd.common.channel

Class BufferedIoOutputStream

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.util.closeable.AbstractInnerCloseable

org.apache.sshd.common.channel.BufferedIoOutputStream

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, IoOutputStream

public class BufferedIoOutputStream
extends AbstractInnerCloseable
implements IoOutputStream

An IoOutputStream capable of queuing write requests

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 and Description
protected AtomicReference<IoWriteFutureImpl>	currentWrite
protected IoOutputStream	out
protected Queue<IoWriteFutureImpl>	writes

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
BufferedIoOutputStream(IoOutputStream out)

Method Summary

Modifier and Type	Method and Description
protected Closeable	getInnerCloseable()
protected void	startWriting()
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.AbstractInnerCloseable

doCloseGracefully, doCloseImmediately

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

addCloseFutureListener, builder, close, 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

Field Detail

out

protected final IoOutputStream out

writes

protected final Queue<IoWriteFutureImpl> writes

currentWrite

protected final AtomicReference<IoWriteFutureImpl> currentWrite

Constructor Detail

BufferedIoOutputStream

public BufferedIoOutputStream(IoOutputStream out)

Method Detail

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

startWriting

protected void startWriting()

getInnerCloseable

protected Closeable getInnerCloseable()

Specified by:

getInnerCloseable in class AbstractInnerCloseable

toString

public String toString()

Overrides:

toString in class Object