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

Class template for Input PStreams. More...

#include <pstream.h>

Inheritance diagram for redi::basic_ipstream< 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_ipstream ()
	Default constructor, creates an uninitialised stream.
	basic_ipstream (const std::string &command, pmode mode=std::ios_base::in)
	Constructor that initialises the stream by starting a process.
	basic_ipstream (const std::string &file, const std::vector< std::string > &argv, pmode mode=std::ios_base::in)
	Constructor that initialises the stream by starting a process.
	~basic_ipstream ()
	Destructor.
void	open (const std::string &command, pmode mode=std::ios_base::in)
	Start a process.
void	open (const std::string &file, const std::vector< std::string > &argv, pmode mode=std::ios_base::in)
	Start a process.
basic_ipstream &	out ()
	Set streambuf to read from process' stdout.
basic_ipstream &	err ()
	Set streambuf to read from process' stderr.

---

Detailed Description

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

Class template for Input PStreams.

Reading from an ipstream reads the command's standard output and/or standard error (depending on how the ipstream is opened) and the command's standard input is the same as that of the process that created the object, unless altered by the command itself.

---

Constructor & Destructor Documentation

template<typename CharT, typename Traits = std::char_traits<CharT>> redi::basic_ipstream< CharT, Traits >::basic_ipstream (  const std::string &  command, pmode  mode = std::ios_base::in )  [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()

template<typename CharT, typename Traits = std::char_traits<CharT>> redi::basic_ipstream< CharT, Traits >::basic_ipstream (  const std::string &  file, const std::vector< std::string > &  argv, pmode  mode = std::ios_base::in )  [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()

template<typename CharT, typename Traits = std::char_traits<CharT>> redi::basic_ipstream< CharT, Traits >::~basic_ipstream (   )  [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_ipstream& redi::basic_ipstream< 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_ipstream< CharT, Traits >::open (  const std::string &  file, const std::vector< std::string > &  argv, pmode  mode = std::ios_base::in )  [inline, virtual]

Start a process. Starts a new process by executing file with the arguments in argv and opens pipes to the process as given by mode. 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() Reimplemented from redi::pstream_common< CharT, Traits >.

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

Start a process. Starts a new process by passing command to the shell and opens a pipe to the process with the specified mode. Parameters: command  a string containing a shell command. mode  the I/O mode to use when opening the pipe. See also: pstream_common::open() Reimplemented from redi::pstream_common< CharT, Traits >.

template<typename CharT, typename Traits = std::char_traits<CharT>> basic_ipstream& redi::basic_ipstream< 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

---