org.apache.sshd.common.channel

Class ChannelOutputStream

java.lang.Object

java.io.OutputStream

org.apache.sshd.common.channel.ChannelOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Channel, ChannelHolder

public class ChannelOutputStream
extends OutputStream
implements Channel, ChannelHolder

Author:

Apache MINA SSHD Project

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
protected org.slf4j.Logger	log
protected AtomicReference<ChannelOutputStream.OpenState>	openState

Constructor Summary

Constructors

Constructor and Description
ChannelOutputStream(AbstractChannel channel, RemoteWindow remoteWindow, 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)
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 AtomicReference<ChannelOutputStream.OpenState> openState

log

protected final org.slf4j.Logger log

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,
                           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 Channel

write

public void write(int w)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Overrides:

close in class OutputStream

Throws:

IOException

newBuffer

protected Buffer newBuffer(int size)

toString

public String toString()

Overrides:

toString in class Object