org.apache.sshd.common.channel

Class ChannelOutputStream

java.lang.Object

java.io.OutputStream

org.apache.sshd.common.channel.ChannelOutputStream

All Implemented Interfaces:

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

public class ChannelOutputStream
extends java.io.OutputStream
implements java.nio.channels.Channel, ChannelHolder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ChannelOutputStream.OpenState
protected static class	ChannelOutputStream.WriteState

Field Summary

Fields

Modifier and Type	Field and Description
private Buffer	buffer
private int	bufferLength
private java.lang.Object	bufferLock
private AbstractChannel	channelInstance
private byte	cmd
private boolean	eofOnClose
private boolean	isFlushing
private int	lastSize
protected org.slf4j.Logger	log
private java.time.Duration	maxWaitTimeout
private java.util.concurrent.atomic.AtomicBoolean	noDelay
protected java.util.concurrent.atomic.AtomicReference<ChannelOutputStream.OpenState>	openState
private ChannelStreamWriter	packetWriter
private RemoteWindow	remoteWindow

Constructor Summary

Constructors

Constructor and Description
ChannelOutputStream(AbstractChannel channel, RemoteWindow remoteWindow, java.time.Duration maxWaitTimeout, org.slf4j.Logger log, byte cmd, boolean eofOnClose)
ChannelOutputStream(AbstractChannel channel, RemoteWindow remoteWindow, org.slf4j.Logger log, byte cmd, boolean eofOnClose)
ChannelOutputStream(AbstractChannel channel, RemoteWindow remoteWindow, long maxWaitTimeout, org.slf4j.Logger log, byte cmd, boolean eofOnClose)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
AbstractChannel	getChannel()
byte	getCommandType()
boolean	isEofOnClose()
boolean	isNoDelay()
boolean	isOpen()
protected Buffer	newBuffer(int size)
void	setNoDelay(boolean noDelay)
java.lang.String	toString()
void	write(byte[] buf, int s, int l)
void	write(int w)

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

openState

protected final java.util.concurrent.atomic.AtomicReference<ChannelOutputStream.OpenState> openState

log

protected final org.slf4j.Logger log

channelInstance

private final AbstractChannel channelInstance

packetWriter

private final ChannelStreamWriter packetWriter

remoteWindow

private final RemoteWindow remoteWindow

maxWaitTimeout

private final java.time.Duration maxWaitTimeout

cmd

private final byte cmd

eofOnClose

private final boolean eofOnClose

noDelay

private final java.util.concurrent.atomic.AtomicBoolean noDelay

bufferLock

private final java.lang.Object bufferLock

buffer

private Buffer buffer

bufferLength

private int bufferLength

lastSize

private int lastSize

isFlushing

private boolean isFlushing

Constructor Detail

ChannelOutputStream

public ChannelOutputStream(AbstractChannel channel,
                           RemoteWindow remoteWindow,
                           org.slf4j.Logger log,
                           byte cmd,
                           boolean eofOnClose)

ChannelOutputStream

public ChannelOutputStream(AbstractChannel channel,
                           RemoteWindow remoteWindow,
                           long maxWaitTimeout,
                           org.slf4j.Logger log,
                           byte cmd,
                           boolean eofOnClose)

ChannelOutputStream

public ChannelOutputStream(AbstractChannel channel,
                           RemoteWindow remoteWindow,
                           java.time.Duration maxWaitTimeout,
                           org.slf4j.Logger log,
                           byte cmd,
                           boolean eofOnClose)

Method Detail

getChannel

public AbstractChannel 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

isEofOnClose

public boolean isEofOnClose()

isNoDelay

public boolean isNoDelay()

setNoDelay

public void setNoDelay(boolean noDelay)

isOpen

public boolean isOpen()

Specified by:

isOpen in interface java.nio.channels.Channel

write

public void write(int w)
           throws java.io.IOException

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(byte[] buf,
                  int s,
                  int l)
           throws java.io.IOException

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.nio.channels.Channel

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException

newBuffer

protected Buffer newBuffer(int size)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object