boost::process::pistream Class Reference

#include <pistream.hpp>

List of all members.

Public Member Functions

 pistream (detail::file_handle &fh)
detail::file_handlehandle ()
void close ()

Detailed Description

Child process' output stream.

The pistream class represents an output communication channel with the child process. The child process writes data to this stream and the parent process can read it through the pistream object. In other words, from the child's point of view, the communication channel is an output one, but from the parent's point of view it is an input one; hence the confusing pistream name.

pistream objects cannot be copied because they own the file handle they use to communicate with the child and because they buffer data that flows through the communication channel.

A pistream object behaves as a std::istream stream in all senses. The class is only provided because it must provide a method to let the caller explicitly close the communication channel.

Blocking remarks: Functions that read data from this stream can block if the associated file handle blocks during the read. As this class is used to communicate with child processes through anonymous pipes, the most typical blocking condition happens when the child has no more data to send to the pipe's system buffer. When this happens, the buffer eventually empties and the system blocks until the writer generates some data.

Constructor & Destructor Documentation

boost::process::pistream::pistream ( detail::file_handle fh  )  [inline, explicit]

Creates a new process' output stream.

Given a file handle, this constructor creates a new pistream object that owns the given file handle fh. Ownership of fh is transferred to the created pistream object.

fh is valid.
fh is invalid.

The new pistream object owns fh.

Member Function Documentation

detail::file_handle& boost::process::pistream::handle (  )  [inline]

Returns the file handle managed by this stream.

The file handle must not be copied. Copying invalidates the source file handle making the pistream unusable.

void boost::process::pistream::close (  )  [inline]

Closes the file handle managed by this stream.

Explicitly closes the file handle managed by this stream. This function can be used by the user to tell the child process it's not willing to receive more data.

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

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