eu.chainfire.libsuperuser

Class StreamGobbler

java.lang.Object

java.lang.Thread

eu.chainfire.libsuperuser.StreamGobbler

All Implemented Interfaces:

java.lang.Runnable

public class StreamGobbler
extends java.lang.Thread

Thread utility class continuously reading from an InputStream

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StreamGobbler.OnLineListener Line callback interface

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
StreamGobbler(java.lang.String shell, java.io.InputStream inputStream, java.util.List<java.lang.String> outputList) StreamGobbler constructor
StreamGobbler(java.lang.String shell, java.io.InputStream inputStream, StreamGobbler.OnLineListener onLineListener) StreamGobbler constructor

Method Summary

Modifier and Type	Method and Description
void	run()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamGobbler

public StreamGobbler(java.lang.String shell,
                     java.io.InputStream inputStream,
                     java.util.List<java.lang.String> outputList)

StreamGobbler constructor

We use this class because shell STDOUT and STDERR should be read as quickly as possible to prevent a deadlock from occurring, or Process.waitFor() never returning (as the buffer is full, pausing the native process)

Parameters:

shell - Name of the shell

inputStream - InputStream to read from

outputList - List<String> to write to, or null

StreamGobbler

public StreamGobbler(java.lang.String shell,
                     java.io.InputStream inputStream,
                     StreamGobbler.OnLineListener onLineListener)

StreamGobbler constructor

We use this class because shell STDOUT and STDERR should be read as quickly as possible to prevent a deadlock from occurring, or Process.waitFor() never returning (as the buffer is full, pausing the native process)

Parameters:

shell - Name of the shell

inputStream - InputStream to read from

onLineListener - OnLineListener callback

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread