Public Types | Public Member Functions | List of all members
ChildProcess Class Reference

Launches and monitors a child process. More...

Public Types

enum  StreamFlags { wantStdOut = 1, wantStdErr = 2 }
 These flags are used by the start() methods. More...
 

Public Member Functions

 ChildProcess ()
 Creates a process object. More...
 
 ~ChildProcess ()
 Destructor. More...
 
bool start (const String &command, int streamFlags=wantStdOut|wantStdErr)
 Attempts to launch a child process command. More...
 
bool start (const StringArray &arguments, int streamFlags=wantStdOut|wantStdErr)
 Attempts to launch a child process command. More...
 
bool isRunning () const
 Returns true if the child process is alive. More...
 
int readProcessOutput (void *destBuffer, int numBytesToRead)
 Attempts to read some output from the child process. More...
 
String readAllProcessOutput ()
 Blocks until the process has finished, and then returns its complete output as a string. More...
 
bool waitForProcessToFinish (int timeoutMs) const
 Blocks until the process is no longer running. More...
 
uint32 getExitCode () const
 If the process has finished, this returns its exit code. More...
 
bool kill ()
 Attempts to kill the child process. More...
 

Detailed Description

Launches and monitors a child process.

This class lets you launch an executable, and read its output. You can also use it to check whether the child process has finished.

Member Enumeration Documentation

◆ StreamFlags

These flags are used by the start() methods.

Enumerator
wantStdOut 
wantStdErr 

Constructor & Destructor Documentation

◆ ChildProcess()

ChildProcess::ChildProcess ( )

Creates a process object.

To actually launch the process, use start().

◆ ~ChildProcess()

ChildProcess::~ChildProcess ( )

Destructor.

Note that deleting this object won't terminate the child process.

Member Function Documentation

◆ start() [1/2]

bool ChildProcess::start ( const String command,
int  streamFlags = wantStdOut|wantStdErr 
)

Attempts to launch a child process command.

The command should be the name of the executable file, followed by any arguments that are required. If the process has already been launched, this will launch it again. If a problem occurs, the method will return false. The streamFlags is a combinations of values to indicate which of the child's output streams should be read and returned by readProcessOutput().

◆ start() [2/2]

bool ChildProcess::start ( const StringArray arguments,
int  streamFlags = wantStdOut|wantStdErr 
)

Attempts to launch a child process command.

The first argument should be the name of the executable file, followed by any other arguments that are needed. If the process has already been launched, this will launch it again. If a problem occurs, the method will return false. The streamFlags is a combinations of values to indicate which of the child's output streams should be read and returned by readProcessOutput().

◆ isRunning()

bool ChildProcess::isRunning ( ) const

Returns true if the child process is alive.

◆ readProcessOutput()

int ChildProcess::readProcessOutput ( void *  destBuffer,
int  numBytesToRead 
)

Attempts to read some output from the child process.

This will attempt to read up to the given number of bytes of data from the process. It returns the number of bytes that were actually read.

◆ readAllProcessOutput()

String ChildProcess::readAllProcessOutput ( )

Blocks until the process has finished, and then returns its complete output as a string.

◆ waitForProcessToFinish()

bool ChildProcess::waitForProcessToFinish ( int  timeoutMs) const

Blocks until the process is no longer running.

◆ getExitCode()

uint32 ChildProcess::getExitCode ( ) const

If the process has finished, this returns its exit code.

◆ kill()

bool ChildProcess::kill ( )

Attempts to kill the child process.

Returns true if it succeeded. Trying to read from the process after calling this may result in undefined behaviour.


The documentation for this class was generated from the following file: