com.facebook.buck.util

Interface ProcessExecutor

All Known Implementing Classes:

ContextualProcessExecutor, DefaultProcessExecutor

public interface ProcessExecutor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ProcessExecutor.LaunchedProcess Represents a running process returned by launchProcess(ProcessExecutorParams).
static class	ProcessExecutor.LaunchedProcessImpl Wraps a Process and exposes only its I/O streams, so callers have to pass it back to this class.
static class	ProcessExecutor.Option Options for launchAndExecute(ProcessExecutorParams, Set, Optional, Optional, Optional).
static class	ProcessExecutor.Result Values from the result of launchAndExecute(ProcessExecutorParams, Set, Optional, Optional, Optional).

Method Summary

Modifier and Type	Method and Description
ProcessExecutor	cloneWithOutputStreams(PrintStream stdOutStream, PrintStream stdErrStream) Makes a clone of this process executor with the stdout and stderr streams overridden.
void	destroyLaunchedProcess(ProcessExecutor.LaunchedProcess launchedProcess) Terminates a process previously returned by launchProcess(ProcessExecutorParams).
ProcessExecutor.Result	launchAndExecute(ProcessExecutorParams params) Convenience method for launchAndExecute(ProcessExecutorParams, Set, Optional, Optional, Optional) with boolean values set to false and optional values set to absent.
ProcessExecutor.Result	launchAndExecute(ProcessExecutorParams params, com.google.common.collect.ImmutableMap<String,String> context)
ProcessExecutor.Result	launchAndExecute(ProcessExecutorParams params, com.google.common.collect.ImmutableMap<String,String> context, Set<ProcessExecutor.Option> options, Optional<String> stdin, Optional<Long> timeOutMs, Optional<java.util.function.Consumer<Process>> timeOutHandler)
ProcessExecutor.Result	launchAndExecute(ProcessExecutorParams params, Set<ProcessExecutor.Option> options, Optional<String> stdin, Optional<Long> timeOutMs, Optional<java.util.function.Consumer<Process>> timeOutHandler) Launches then executes a process with the specified params.
ProcessExecutor.LaunchedProcess	launchProcess(ProcessExecutorParams params) Launches a Process given ProcessExecutorParams.
ProcessExecutor.LaunchedProcess	launchProcess(ProcessExecutorParams params, com.google.common.collect.ImmutableMap<String,String> context)
ProcessExecutor.Result	waitForLaunchedProcess(ProcessExecutor.LaunchedProcess launchedProcess) Blocks while waiting for a process previously returned by launchProcess(ProcessExecutorParams) to exit, then returns the exit code of the process.
ProcessExecutor.Result	waitForLaunchedProcessWithTimeout(ProcessExecutor.LaunchedProcess launchedProcess, long millis, Optional<java.util.function.Consumer<Process>> timeOutHandler) As waitForLaunchedProcess(LaunchedProcess) but with a timeout in milliseconds.

Method Detail

launchAndExecute

ProcessExecutor.Result launchAndExecute(ProcessExecutorParams params)
                                 throws InterruptedException,
                                        IOException

Convenience method for launchAndExecute(ProcessExecutorParams, Set, Optional, Optional, Optional) with boolean values set to false and optional values set to absent.

Throws:

InterruptedException

IOException

launchAndExecute

ProcessExecutor.Result launchAndExecute(ProcessExecutorParams params,
                                        com.google.common.collect.ImmutableMap<String,String> context)
                                 throws InterruptedException,
                                        IOException

Throws:

InterruptedException

IOException

launchAndExecute

ProcessExecutor.Result launchAndExecute(ProcessExecutorParams params,
                                        Set<ProcessExecutor.Option> options,
                                        Optional<String> stdin,
                                        Optional<Long> timeOutMs,
                                        Optional<java.util.function.Consumer<Process>> timeOutHandler)
                                 throws InterruptedException,
                                        IOException

Launches then executes a process with the specified params.

If options contains ProcessExecutor.Option.PRINT_STD_OUT, then the stdout of the process will be written directly to the stdout passed to the constructor of this executor. Otherwise, the stdout of the process will be made available via ProcessExecutor.Result.getStdout().

If options contains ProcessExecutor.Option.PRINT_STD_ERR, then the stderr of the process will be written directly to the stderr passed to the constructor of this executor. Otherwise, the stderr of the process will be made available via ProcessExecutor.Result.getStderr().

Throws:

InterruptedException

IOException

launchAndExecute

ProcessExecutor.Result launchAndExecute(ProcessExecutorParams params,
                                        com.google.common.collect.ImmutableMap<String,String> context,
                                        Set<ProcessExecutor.Option> options,
                                        Optional<String> stdin,
                                        Optional<Long> timeOutMs,
                                        Optional<java.util.function.Consumer<Process>> timeOutHandler)
                                 throws InterruptedException,
                                        IOException

Throws:

InterruptedException

IOException

launchProcess

ProcessExecutor.LaunchedProcess launchProcess(ProcessExecutorParams params)
                                       throws IOException

Launches a Process given ProcessExecutorParams.

Throws:

IOException

launchProcess

ProcessExecutor.LaunchedProcess launchProcess(ProcessExecutorParams params,
                                              com.google.common.collect.ImmutableMap<String,String> context)
                                       throws IOException

Throws:

IOException

destroyLaunchedProcess

void destroyLaunchedProcess(ProcessExecutor.LaunchedProcess launchedProcess)

Terminates a process previously returned by launchProcess(ProcessExecutorParams).

waitForLaunchedProcess

ProcessExecutor.Result waitForLaunchedProcess(ProcessExecutor.LaunchedProcess launchedProcess)
                                       throws InterruptedException

Blocks while waiting for a process previously returned by launchProcess(ProcessExecutorParams) to exit, then returns the exit code of the process.

After this method returns, the launchedProcess can no longer be passed to any methods of this object.

Throws:

InterruptedException

waitForLaunchedProcessWithTimeout

ProcessExecutor.Result waitForLaunchedProcessWithTimeout(ProcessExecutor.LaunchedProcess launchedProcess,
                                                         long millis,
                                                         Optional<java.util.function.Consumer<Process>> timeOutHandler)
                                                  throws InterruptedException

As waitForLaunchedProcess(LaunchedProcess) but with a timeout in milliseconds.

Throws:

InterruptedException

cloneWithOutputStreams

ProcessExecutor cloneWithOutputStreams(PrintStream stdOutStream,
                                       PrintStream stdErrStream)

Makes a clone of this process executor with the stdout and stderr streams overridden.