org.mmbase.util.externalprocess

Class StreamCopyThread

java.lang.Object

java.lang.Thread

org.mmbase.util.externalprocess.StreamCopyThread

All Implemented Interfaces:

Runnable

class StreamCopyThread
extends Thread

Thread which continuously reads from a input stream and pushes the read data to an output stream which is immediately flushed afterwards.

Since:

MMBase-1.6

Version:

$Id$

Author:

Nico Klasens (Finalist IT Group)

Nested Class Summary

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

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE Default buffer size.
protected static long	WAIT_DELAY The number of milliseconds to wait before writing

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
StreamCopyThread(String name, InputStream in, OutputStream out, boolean pInput) Create a thread to copy bytes fro one strea to the other
StreamCopyThread(ThreadGroup group, String name, InputStream in, OutputStream out, boolean pInput) Create a thread to copy bytes fro one stream to the other

Method Summary

Modifier and Type	Method and Description
protected void	complete() This method is called when the copying of bytes is done and notifies a waiting thread
boolean	finished() Returns whether this thread has finished copying bytes
long	getCount()
void	run()
void	waitFor() By calling this method the calling thread will wait until this thread is finished copying bytes

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

Field Detail

WAIT_DELAY

protected static final long WAIT_DELAY

The number of milliseconds to wait before writing

See Also:

Constant Field Values

BUFFER_SIZE

public static final int BUFFER_SIZE

Default buffer size.

See Also:

Constant Field Values

Constructor Detail

StreamCopyThread

public StreamCopyThread(String name,
                        InputStream in,
                        OutputStream out,
                        boolean pInput)

Create a thread to copy bytes fro one strea to the other

Parameters:

name - the name of the new thread

in - the stream from which to pipe the data

out - the stream to pipe the data to

pInput - This thread writes to the external process

StreamCopyThread

public StreamCopyThread(ThreadGroup group,
                        String name,
                        InputStream in,
                        OutputStream out,
                        boolean pInput)

Create a thread to copy bytes fro one stream to the other

Parameters:

group - ThreadGroup where this thread belongs to

name - the name of the new thread

in - the stream from which to pipe the data

out - the stream to pipe the data to

bSize - the size of the buffer in which data is piped

pInput - This thread writes to the external process

Method Detail

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

See Also:

Runnable.run()

finished

public boolean finished()

Returns whether this thread has finished copying bytes

Returns:

true if finished and false otherwise

getCount

public long getCount()

waitFor

public void waitFor()

By calling this method the calling thread will wait until this thread is finished copying bytes

complete

protected void complete()

This method is called when the copying of bytes is done and notifies a waiting thread