Class ChannelOutputStream

java.lang.Object

java.io.OutputStream

net.schmizz.sshj.connection.channel.ChannelOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, ErrorNotifiable

public final class ChannelOutputStream
extends OutputStream
implements ErrorNotifiable

OutputStream for channels. Buffers data upto the remote window's maximum packet size. Data can also be flushed via flush() and is also flushed on close().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	ChannelOutputStream.DataBuffer

Nested classes/interfaces inherited from interface ErrorNotifiable

ErrorNotifiable.Util

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	b
private final ChannelOutputStream.DataBuffer	buffer
private final AbstractChannel	chan
private final AtomicBoolean	closed
private SSHException	error
private final Transport	trans
private final Window.Remote	win

Constructor Summary

Constructors

Constructor	Description
ChannelOutputStream(AbstractChannel chan, Transport trans, Window.Remote win)

Method Summary

Modifier and Type	Method	Description
private void	checkClose()
void	close()
void	flush()	Send all data currently buffered.
void	notifyError(SSHException error)	Notifies this object of an error.
private static void	throwStreamClosed()
String	toString()
void	write(byte[] data, int off, int len)
void	write(int w)

Methods inherited from class OutputStream

nullOutputStream, write

Methods inherited from class Object

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

Field Details

chan

private final AbstractChannel chan

trans

private final Transport trans

win

private final Window.Remote win

buffer

private final ChannelOutputStream.DataBuffer buffer

b

private final byte[] b

closed

private final AtomicBoolean closed

error

private SSHException error

Constructor Details

ChannelOutputStream

public ChannelOutputStream(AbstractChannel chan,
 Transport trans,
 Window.Remote win)

Method Details

write

public void write(int w)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] data,
 int off,
 int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

notifyError

public void notifyError(SSHException error)

Description copied from interface: ErrorNotifiable

Notifies this object of an error.

Specified by:

notifyError in interface ErrorNotifiable

checkClose

private void checkClose()
                 throws SSHException

Throws:

SSHException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Send all data currently buffered. If window space is exhausted in the process, this will block until it is expanded by the server.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

throwStreamClosed

private static void throwStreamClosed()
                               throws ConnectionException

Throws:

ConnectionException