redi::basic_pstream< CharT, Traits > Class Template Reference

Class template for Bidirectional PStreams. More...

#include <pstream.h>

Inheritance diagram for redi::basic_pstream< CharT, Traits >:

List of all members.

Public Types
typedef pbase_type::pmode	pmode
	Type used to specify how to connect to the process.
Public Member Functions
	basic_pstream ()
	Default constructor, creates an uninitialised stream.
	basic_pstream (const std::string &command, pmode mode=std::ios_base::in|std::ios_base::out)
	Constructor that initialises the stream by starting a process.
	basic_pstream (const std::string &file, const std::vector< std::string > &argv, pmode mode=std::ios_base::in|std::ios_base::out)
	Constructor that initialises the stream by starting a process.
	~basic_pstream ()
	Destructor.
void	open (const std::string &command, pmode mode=std::ios_base::in|std::ios_base::out)
	Start a process.
void	open (const std::string &file, const std::vector< std::string > &argv, pmode mode=std::ios_base::in|std::ios_base::out)
	Start a process.
basic_pstream &	out ()
	Set streambuf to read from process' stdout.
basic_pstream &	err ()
	Set streambuf to read from process' stderr.

---

Detailed Description

template<typename CharT, typename Traits = std::char_traits<CharT>>
class redi::basic_pstream< CharT, Traits >

Class template for Bidirectional PStreams.

Writing to a pstream opened with pmode pstdin writes to the standard input of the command. Reading from a pstream opened with pmode pstdout and/or pstderr reads the command's standard output and/or standard error. Any of the process' stdin, stdout or stderr that is not connected to the pstream (as specified by the pmode) will be the same as the process that created the pstream object, unless altered by the command itself.

---

Constructor & Destructor Documentation

template<typename CharT, typename Traits = std::char_traits<CharT>> redi::basic_pstream< CharT, Traits >::basic_pstream (  const std::string &  command, pmode  mode = std::ios_base::in|std::ios_base::out )  [inline]

Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling open() with the supplied arguments. Parameters: command  a string containing a shell command. mode  the I/O mode to use when opening the pipe. See also: open(const std::string&, pmode)

template<typename CharT, typename Traits = std::char_traits<CharT>> redi::basic_pstream< CharT, Traits >::basic_pstream (  const std::string &  file, const std::vector< std::string > &  argv, pmode  mode = std::ios_base::in|std::ios_base::out )  [inline]

Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling open() with the supplied arguments. Parameters: file  a string containing the pathname of a program to execute. argv  a vector of argument strings passed to the new program. mode  the I/O mode to use when opening the pipe. See also: open(const std::string&, const std::vector<std::string>&, pmode)

template<typename CharT, typename Traits = std::char_traits<CharT>> redi::basic_pstream< CharT, Traits >::~basic_pstream (   )  [inline]

Destructor. Closes the stream and waits for the child to exit.

---

Member Function Documentation

template<typename CharT, typename Traits = std::char_traits<CharT>> basic_pstream& redi::basic_pstream< CharT, Traits >::err (   )  [inline]

Set streambuf to read from process' stderr. Returns: *this

template<typename CharT, typename Traits = std::char_traits<CharT>> void redi::basic_pstream< CharT, Traits >::open (  const std::string &  file, const std::vector< std::string > &  argv, pmode  mode = std::ios_base::in|std::ios_base::out )  [inline, virtual]

Start a process. Parameters: file  a string containing the pathname of a program to execute. argv  a vector of argument strings passed to the new program. mode  the I/O mode to use when opening the pipe. See also: pstream_common::open(const std::string&, const std::vector<std::string>&, pmode) Reimplemented from redi::pstream_common< CharT, Traits >.

template<typename CharT, typename Traits = std::char_traits<CharT>> void redi::basic_pstream< CharT, Traits >::open (  const std::string &  command, pmode  mode = std::ios_base::in|std::ios_base::out )  [inline, virtual]

Start a process. Parameters: command  a string containing a shell command. mode  the I/O mode to use when opening the pipe. See also: pstream_common::open(const std::string&, pmode) Reimplemented from redi::pstream_common< CharT, Traits >.

template<typename CharT, typename Traits = std::char_traits<CharT>> basic_pstream& redi::basic_pstream< CharT, Traits >::out (   )  [inline]

Set streambuf to read from process' stdout. Returns: *this

---

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

• pstream.h

---