Package net.schmizz.sshj.connection.channel

Class ChannelOutputStream

java.lang.Object

java.io.OutputStream

net.schmizz.sshj.connection.channel.ChannelOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, ErrorNotifiable

public final class ChannelOutputStream
extends java.io.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/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable

ErrorNotifiable.Util

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelOutputStream

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

Method Detail

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[] data,
                  int off,
                  int len)
           throws java.io.IOException

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

notifyError

public void notifyError(SSHException error)

Description copied from interface: ErrorNotifiable

Notifies this object of an error.

Specified by:

notifyError in interface ErrorNotifiable

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.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 java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object