Package 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, Closeable, 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	Description
protected final int	channelId
protected final AtomicReference<IoWriteFutureImpl>	currentWrite
protected final Object	id
protected final int	maxPendingBytesCount
protected final Duration	maxWaitForPendingWrites
protected final IoOutputStream	out
protected final AtomicInteger	pendingBytesCount
protected final AtomicReference<SshChannelBufferedOutputException>	pendingException
protected final Queue<IoWriteFutureImpl>	writes
protected final AtomicLong	writtenBytesCount

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
BufferedIoOutputStream(Object id, int channelId, IoOutputStream out, int maxPendingBytesCount, Duration maxWaitForPendingWrites)
BufferedIoOutputStream(Object id, int channelId, IoOutputStream out, PropertyResolver resolver)

Method Summary

Modifier and Type	Method	Description
protected void	finishWrite(IoWriteFutureImpl future, int bufferSize)
Object	getId()
protected Closeable	getInnerCloseable()
protected void	startWriting()
String	toString()
protected void	waitForAvailableWriteSpace(int requiredSize)
IoWriteFuture	writeBuffer(Buffer buffer)	Write the given buffer.

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, getFutureLock, isClosed, isClosing, preClose, 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

id

protected final Object id

channelId

protected final int channelId

maxPendingBytesCount

protected final int maxPendingBytesCount

maxWaitForPendingWrites

protected final Duration maxWaitForPendingWrites

out

protected final IoOutputStream out

pendingBytesCount

protected final AtomicInteger pendingBytesCount

writtenBytesCount

protected final AtomicLong writtenBytesCount

writes

protected final Queue<IoWriteFutureImpl> writes

currentWrite

protected final AtomicReference<IoWriteFutureImpl> currentWrite

pendingException

protected final AtomicReference<SshChannelBufferedOutputException> pendingException

Constructor Details

BufferedIoOutputStream

public BufferedIoOutputStream(Object id,
 int channelId,
 IoOutputStream out,
 PropertyResolver resolver)

BufferedIoOutputStream

public BufferedIoOutputStream(Object id,
 int channelId,
 IoOutputStream out,
 int maxPendingBytesCount,
 Duration maxWaitForPendingWrites)

Method Details

getId

public Object getId()

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

waitForAvailableWriteSpace

protected void waitForAvailableWriteSpace(int requiredSize)
                                   throws IOException

Throws:

IOException

startWriting

protected void startWriting()
                     throws IOException

Throws:

IOException

finishWrite

protected void finishWrite(IoWriteFutureImpl future,
 int bufferSize)

getInnerCloseable

protected Closeable getInnerCloseable()

Specified by:

getInnerCloseable in class AbstractInnerCloseable

toString

public String toString()

Overrides:

toString in class Object