boost::process::child Class Reference

#include <child.hpp>

Inheritance diagram for boost::process::child:

boost::process::process boost::process::posix_child boost::process::win32_child

List of all members.

Public Member Functions

postreamget_stdin () const
pistreamget_stdout () const
pistreamget_stderr () const
status wait ()
 child (id_type id, detail::file_handle fhstdin, detail::file_handle fhstdout, detail::file_handle fhstderr, detail::file_handle fhprocess=detail::file_handle())


Detailed Description

Generic implementation of the Child concept.

The child class implements the Child concept in an operating system agnostic way.


Constructor & Destructor Documentation

boost::process::child::child ( id_type  id,
detail::file_handle  fhstdin,
detail::file_handle  fhstdout,
detail::file_handle  fhstderr,
detail::file_handle  fhprocess = detail::file_handle() 
) [inline]

Creates a new child object that represents the just spawned child process id.

The fhstdin, fhstdout and fhstderr file handles represent the parent's handles used to communicate with the corresponding data streams. They needn't be valid but their availability must match the redirections configured by the launcher that spawned this process.

The fhprocess handle represents a handle to the child process. It is only used on Windows as the implementation of wait() needs a process handle.


Member Function Documentation

postream& boost::process::child::get_stdin (  )  const [inline]

Gets a reference to the child's standard input stream.

Returns a reference to a postream object that represents the standard input communication channel with the child process.

pistream& boost::process::child::get_stdout (  )  const [inline]

Gets a reference to the child's standard output stream.

Returns a reference to a pistream object that represents the standard output communication channel with the child process.

pistream& boost::process::child::get_stderr (  )  const [inline]

Gets a reference to the child's standard error stream.

Returns a reference to a pistream object that represents the standard error communication channel with the child process.

status boost::process::child::wait (  )  [inline]

Blocks and waits for the child process to terminate.

Returns a status object that represents the child process' finalization condition. The child process object ceases to be valid after this call.

Remarks:
Blocking remarks: This call blocks if the child process has not finalized execution and waits until it terminates.


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

Generated on Mon Sep 22 01:00:42 2008 by  doxygen 1.5.5