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

Class template for common base class. More...

#include <pstream.h>

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

List of all members.

Public Types
typedef streambuf_type::pmode	pmode
	Type used to specify how to connect to the process.
Public Member Functions
	pstream_common ()
	Default constructor.
	pstream_common (const std::string &command, pmode mode)
	Constructor that initialises the stream by starting a process.
	pstream_common (const std::string &file, const std::vector< std::string > &argv, pmode mode)
	Constructor that initialises the stream by starting a process.
virtual void	open (const std::string &command, pmode mode)
	Start a process.
virtual void	open (const std::string &file, const std::vector< std::string > &argv, pmode mode)
	Start a process.
void	close ()
	Close the pipe.
bool	is_open () const
	Report whether the stream's buffer has been initialised.
const std::string &	command () const
	Return the command used to initialise the stream.
streambuf_type *	rdbuf () const
	Return a pointer to the stream buffer.
Protected Types
typedef basic_pstreambuf< CharT, Traits >	streambuf_type
Protected Member Functions
virtual	~pstream_common ()=0
	Pure virtual destructor.
Protected Attributes
std::string	command_
	The command used to start the process.
streambuf_type	buf_
	The stream buffer.

---

Detailed Description

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

Class template for common base class.

Abstract Base Class providing common functionality for basic_ipstream, basic_opstream and basic_pstream. pstream_common manages the basic_pstreambuf stream buffer that is used by the derived classes to initialise an IOStream class.

---

Constructor & Destructor Documentation

template<typename C, typename T> redi::pstream_common< C, T >::pstream_common (   )  [inline]

Default constructor. Creates an uninitialised stream.

template<typename C, typename T> redi::pstream_common< C, T >::pstream_common (  const std::string &  command, pmode  mode )  [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 C, typename T> redi::pstream_common< C, T >::pstream_common (  const std::string &  file, const std::vector< std::string > &  argv, pmode  mode )  [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 C, typename T> redi::pstream_common< C, T >::~pstream_common (   )  [inline, protected, pure virtual]

Pure virtual destructor. This is a pure virtual function to make pstream_common abstract. Because it is the destructor it will be called by derived classes and so must be defined. It is also protected, to discourage use of the PStreams classes through pointers or references to the base class. See also: If defining a pure virtual seems odd you should read http://www.gotw.ca/gotw/031.htm (and the rest of the site as well!)

---

Member Function Documentation

template<typename C, typename T> void redi::pstream_common< C, T >::close (   )  [inline]

Close the pipe. Waits for the associated process to finish and closes the pipe.

template<typename C, typename T> const std::string & redi::pstream_common< C, T >::command (   )  const [inline]

Return the command used to initialise the stream. Returns: a string containing the command used to initialise the stream.

template<typename C, typename T> bool redi::pstream_common< C, T >::is_open (   )  const [inline]

Report whether the stream's buffer has been initialised. Returns: true if open() has been successfully called, false otherwise. See also: basic_pstreambuf::open()

template<typename C, typename T> void redi::pstream_common< C, T >::open (  const std::string &  file, const std::vector< std::string > &  argv, pmode  mode )  [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: basic_pstreambuf::open() Reimplemented in redi::basic_ipstream< CharT, Traits >, redi::basic_opstream< CharT, Traits >, redi::basic_pstream< CharT, Traits >, and redi::basic_rpstream< CharT, Traits >.

template<typename C, typename T> void redi::pstream_common< C, T >::open (  const std::string &  command, pmode  mode )  [inline, virtual]

Start a process. Starts a new process by passing command to the shell and opens pipes to the process as given by mode. Parameters: command  a string containing a shell command. mode  the I/O mode to use when opening the pipe. See also: basic_pstreambuf::open() Reimplemented in redi::basic_ipstream< CharT, Traits >, redi::basic_opstream< CharT, Traits >, redi::basic_pstream< CharT, Traits >, and redi::basic_rpstream< CharT, Traits >.

template<typename C, typename T> pstream_common< C, T >::streambuf_type * redi::pstream_common< C, T >::rdbuf (   )  const [inline]

Return a pointer to the stream buffer. Returns: a pointer to the private stream buffer member.

---

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

• pstream.h

---