Boost C++ Libraries

PrevUpHomeNext

Class children

boost::process::children — Representation of a pipelined group of child processes.

Synopsis

class children {
public:

// public member functions
postream & get_stdin(void) const;
pistream & get_stdout(void) const;
pistream & get_stderr(void) const;
status wait(void) ;
};

Description

Represents a group of child process whose standard data streams are connected to form a pipeline. This higher order structure allows for easy access to the pipeline endpoints and termination synchronization.

children public member functions

  1. postream & get_stdin(void ) const;

    Returns the pipeline's input stream, which is connected to the stdin of the first process in the chain.

    Requires:

    The pipeline launcher (pipeline) must have configured the first process' stdin to the redirect_stream behavior.

  2. pistream & get_stdout(void ) const;

    Returns the pipeline's output stream, which is connected to the stdout of the last process in the chain.

    Requires:

    The pipeline launcher (pipeline) must have configured the last process' stdout to the redirect_stream behavior.

  3. pistream & get_stderr(void ) const;

    Returns the pipeline's error stream, which is connected to the stderr of the last process in the chain.

    Requires:

    The pipeline launcher (pipeline) must have configured the last process' stderr to the redirect_stream behavior.

  4. status wait(void ) ;

    Waits until all the processes in the pipeline have finalized execution.

    Blocking remarks: This call blocks if any of the child processes have not finalized execution and waits until they terminate.

    Returns:

    The exit status of the first failed process or, if all was successful, the exit status of the last process.

Copyright 2006 Julio M. Merino Vidal

PrevUpHomeNext