boost::process::postream Class Reference

#include <postream.hpp>

List of all members.

Public Member Functions

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

Detailed Description

Child process' input stream.

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

postream 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 postream object behaves as a std::ostream 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 write data to this stream can block if the associated file handle blocks during the write. As this class is used to communicate with child processes through anonymous pipes, the most typical blocking condition happens when the child is not processing the data in the pipe's system buffer. When this happens, the buffer eventually fills up and the system blocks until the reader consumes some data, leaving some new room.

Constructor & Destructor Documentation

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

Creates a new process' input stream.

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

fh is valid.
fh is invalid.

The new postream object owns fh.

Member Function Documentation

detail::file_handle& boost::process::postream::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 postream unusable.

void boost::process::postream::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 there is no more data to send.

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