plume

Class TimeLimitProcess

java.lang.Object

java.lang.Process

plume.TimeLimitProcess

Deprecated.

use Apache Commons Exec

@Deprecated
public class TimeLimitProcess
extends java.lang.Process

TimeLimitProcess is a subclass of Process such that the process is killed if it runs for more than the specified number of milliseconds. Wall clock seconds, not CPU seconds, are measured. The process should already be started when TimeLimitProcess is invoked. Typical use:

   ProcessBuilder pb = ...;
   TimeLimitProcess p = new TimeLimitProcess(pb.start(), TIMEOUT_SEC * 1000);

Note: If a Java process is destroyed (e.g., because it times out), then its output is unreadable: Java code trying to read its output stream fails. Here are two ways to get around this problem:

• The client of TimeLimitProcess can send the process output to a file (or ByteArrayOutputStream, etc.), which can be read after the process terminates. This is easy to do in Java 7, for example via ProcessBuilder.redirectOutput(tempFile). There does not appear to be an easy way to do it in Java 6.
• This class provides a workaround, in which it busy-waits reading the standard and error outputs and stores them away. Use ...

Constructor Summary

Constructors

Constructor and Description
TimeLimitProcess(java.lang.Process p, long timeLimit) Deprecated. Creates a TimeLimitProcess with the given time limit, in wall clock milliseconds.
TimeLimitProcess(java.lang.Process p, long timeLimit, boolean cacheStdout) Deprecated. Creates a TimeLimitProcess with the given time limit, in wall clock milliseconds.

Method Summary

Modifier and Type	Method and Description
void	destroy() Deprecated. Kills the subprocess.
int	exitValue() Deprecated. Return the exit value for the subprocess.
boolean	finished() Deprecated.
java.io.InputStream	getErrorStream() Deprecated. Gets the error stream connected to the error output of the subprocess.
java.io.InputStream	getInputStream() Deprecated. Gets an input stream connected to the output of the subprocess.
java.io.OutputStream	getOutputStream() Deprecated. Gets the output stream connected to the input of the subprocess.
boolean	timed_out() Deprecated. Returns true if the process has timed out (has run for more than the timeLimit msecs specified in the constructor).
long	timeout_msecs() Deprecated. Return the timeout time in msecs.
int	waitFor() Deprecated. Causes the current thread to wait, if necessary, until the process represented by this Process object has terminated.

Methods inherited from class java.lang.Process

destroyForcibly, isAlive, waitFor

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeLimitProcess

public TimeLimitProcess(java.lang.Process p,
                        long timeLimit)

Deprecated.

Creates a TimeLimitProcess with the given time limit, in wall clock milliseconds.

Parameters:

p - non-null Process to limit the execution of

timeLimit - in milliseconds

TimeLimitProcess

public TimeLimitProcess(java.lang.Process p,
                        long timeLimit,
                        boolean cacheStdout)

Deprecated.

Creates a TimeLimitProcess with the given time limit, in wall clock milliseconds.

Parameters:

p - non-null Process to limit the execution of

timeLimit - in milliseconds

cacheStdout - if true, causes the TimeLimitProcess to consume the standard output of the underlying process, and to cache it. After the process terminates (on its own or by being timed out), the output is available via the cached_stdout method. This is necessary because when a Java process is terminated, its standard output is no longer available.

Method Detail

timed_out

public boolean timed_out()

Deprecated.

Returns true if the process has timed out (has run for more than the timeLimit msecs specified in the constructor).

Returns:

true iff the process has timed out

timeout_msecs

public long timeout_msecs()

Deprecated.

Return the timeout time in msecs.

Returns:

the timeout time in msecs

destroy

public void destroy()

Deprecated.

Kills the subprocess.

Specified by:

destroy in class java.lang.Process

See Also:

Process.destroy()

exitValue

public int exitValue()

Deprecated.

Return the exit value for the subprocess.

Specified by:

exitValue in class java.lang.Process

Returns:

the exit value for the subprocess

See Also:

Process.getErrorStream()

getErrorStream

public java.io.InputStream getErrorStream()

Deprecated.

Gets the error stream connected to the error output of the subprocess.

Specified by:

getErrorStream in class java.lang.Process

Returns:

the error stream

See Also:

Process.getErrorStream()

getInputStream

public java.io.InputStream getInputStream()

Deprecated.

Gets an input stream connected to the output of the subprocess.

Specified by:

getInputStream in class java.lang.Process

Returns:

the input stream

See Also:

Process.getInputStream()

getOutputStream

public java.io.OutputStream getOutputStream()

Deprecated.

Gets the output stream connected to the input of the subprocess.

Specified by:

getOutputStream in class java.lang.Process

Returns:

the output stream

See Also:

Process.getOutputStream()

waitFor

public int waitFor()
            throws java.lang.InterruptedException

Deprecated.

Causes the current thread to wait, if necessary, until the process represented by this Process object has terminated.

Specified by:

waitFor in class java.lang.Process

Returns:

the exit value of the subprocess

Throws:

java.lang.InterruptedException

See Also:

Process.waitFor()

finished

public boolean finished()

Deprecated.

Returns:

true if the process if finished, false otherwise