com.facebook.buck.util

Interface ListeningProcessExecutor.ProcessListener

All Known Implementing Classes:

ForwardingProcessListener

Enclosing class:

ListeningProcessExecutor

public static interface ListeningProcessExecutor.ProcessListener

Callback API to notify the caller on a background thread when a process starts, exits, has stdout or stderr bytes to read, or is ready to receive bytes on stdin.

Method Summary

Modifier and Type	Method and Description
void	onExit(int exitCode) Called just after the process exits.
void	onStart(ListeningProcessExecutor.LaunchedProcess process) Called just after the process starts.
void	onStderr(ByteBuffer buffer, boolean closed) Called when the process writes bytes to stderr.
boolean	onStdinReady(ByteBuffer buffer) Called when the process is ready to receive bytes on stdin.
void	onStdout(ByteBuffer buffer, boolean closed) Called when the process writes bytes to stdout.

Method Detail

onStart

void onStart(ListeningProcessExecutor.LaunchedProcess process)

Called just after the process starts.

onExit

void onExit(int exitCode)

Called just after the process exits.

onStdout

void onStdout(ByteBuffer buffer,
              boolean closed)

Called when the process writes bytes to stdout.

Before this method returns, you must set buffer.position() to indicate how many bytes you have consumed.

If you do not consume the entire buffer, any remaining bytes will be passed back to you upon the next invocation (for example, when implementing a UTF-8 decoder which might contain a byte sequence spanning multiple reads).

If closed is true, then stdout has been closed and no more bytes will be received.

onStderr

void onStderr(ByteBuffer buffer,
              boolean closed)

Called when the process writes bytes to stderr.

Before this method returns, you must set buffer.position() to indicate how many bytes you have consumed.

If you do not consume the entire buffer, any remaining bytes will be passed back to you upon the next invocation (for example, when implementing a UTF-8 decoder which might contain a byte sequence spanning multiple reads).

If closed is true, then stdout has been closed and no more bytes will be received.

onStdinReady

boolean onStdinReady(ByteBuffer buffer)

Called when the process is ready to receive bytes on stdin.

Before this method returns, you must set the buffer's position and limit (for example, by invoking Buffer.flip()) to indicate how much data is in the buffer before returning from this method.

You must first call ListeningProcessExecutor.LaunchedProcess.wantWrite() at least once before this method will be invoked.

If not all of the data needed to be written will fit in buffer, you can return true to indicate that you would like to write more data.

Otherwise, return false if you have no more data to write to stdin. (You can always invoke ListeningProcessExecutor.LaunchedProcess.wantWrite() any time in the future.