ch.ethz.ssh2
Class StreamGobbler
java.lang.Object
java.io.InputStream
ch.ethz.ssh2.StreamGobbler
- public class StreamGobbler
- extends java.io.InputStream
A StreamGobbler
is an InputStream that uses an internal worker
thread to constantly consume input from another InputStream. It uses a buffer
to store the consumed data. The buffer size is automatically adjusted, if needed.
This class is sometimes very convenient - if you wrap a session's STDOUT and STDERR
InputStreams with instances of this class, then you don't have to bother about
the shared window of STDOUT and STDERR in the low level SSH-2 protocol,
since all arriving data will be immediatelly consumed by the worker threads.
Also, as a side effect, the streams will be buffered (e.g., single byte
read() operations are faster).
Other SSH for Java libraries include this functionality by default in
their STDOUT and STDERR InputStream implementations, however, please be aware
that this approach has also a downside:
If you do not call the StreamGobbler's read()
method often enough
and the peer is constantly sending huge amounts of data, then you will sooner or later
encounter a low memory situation due to the aggregated data (well, it also depends on the Java heap size).
Joe Average will like this class anyway - a paranoid programmer would never use such an approach.
The term "StreamGobbler" was taken from an article called "When Runtime.exec() won't",
see http://www.javaworld.com/javaworld/jw-12-2000/jw-1229-traps.html.
- Version:
- $Id: StreamGobbler.java,v 1.4 2006/02/14 19:43:16 cplattne Exp $
- Author:
- Christian Plattner, plattner@inf.ethz.ch
Methods inherited from class java.io.InputStream |
mark, markSupported, reset, skip |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
StreamGobbler
public StreamGobbler(java.io.InputStream is)
read
public int read()
throws java.io.IOException
- Throws:
java.io.IOException
available
public int available()
throws java.io.IOException
- Throws:
java.io.IOException
read
public int read(byte[] b)
throws java.io.IOException
- Throws:
java.io.IOException
close
public void close()
throws java.io.IOException
- Throws:
java.io.IOException
read
public int read(byte[] b,
int off,
int len)
throws java.io.IOException
- Throws:
java.io.IOException
!!! Dieses Dokument stammt aus dem
ETH Web-Archiv und wird nicht mehr gepflegt !!!
!!! This document is stored in the
ETH Web archive and is no longer maintained !!!