Public Types¶

typedef int fd_type
Type used for file descriptors.

Public Member Functions¶

int close ()
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.

Static Public Attributes¶

static const pmode pstdin = std::ios_base::out
Write to stdin. static const pmode pstdout = std::ios_base::in
Read from stdout. static const pmode pstderr = std::ios_base::app
Read from stderr. static const pmode newpg = std::ios_base::trunc
Create a new process group for the child process.

Protected Types¶

typedef basic_pstreambuf< CharT, Traits > streambuf_type
typedef std::basic_ios< CharT, Traits > ios_type
typedef pstreams::pmode pmode
typedef pstreams::argv_type argv_type
enum { bufsz = 32, pbsz = 2 }

Protected Member Functions¶

pstream_common ()
Default constructor. pstream_common (const std::string &cmd, pmode mode)
Constructor that initialises the stream by starting a process. pstream_common (const std::string &file, const argv_type &argv, pmode mode)
Constructor that initialises the stream by starting a process. virtual ~pstream_common ()=0
Pure virtual destructor. void do_open (const std::string &cmd, pmode mode)
Start a process. void do_open (const std::string &file, const argv_type &argv, pmode mode)
Start a process.

Protected Attributes¶

std::string command_
The command used to start the process. streambuf_type buf_
The stream buffer.

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.

anonymous enum [protected], [inherited]¶

Enumerator

bufsz

Size of pstreambuf buffers.

pbsz

Number of putback characters kept.

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

Default constructor. Creates an uninitialised stream.

References buf_, and command_.

template<typename C, typename T> redi::pstream_common< C, T >::pstream_common (const std::string & cmd, pmode mode) [inline], [protected]¶

Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open( command , mode )

Parameters

See also

References buf_, command_, and do_open().

template<typename C, typename T> redi::pstream_common< C, T >::pstream_common (const std::string & file, const argv_type & argv, pmode mode) [inline], [protected]¶

Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open( file , argv , mode )

Parameters

See also

References buf_, command_, and do_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

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

Close the pipe, returning the program's exit status, as pclose(3) does.

Calls rdbuf->close() and sets failbit on error. Returns process's exit status, as pclose(3) does.

References buf_.

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

References command_.

template<typename C, typename T> void redi::pstream_common< C, T >::do_open (const std::string & cmd, pmode mode) [inline], [protected]¶

Start a process. Calls rdbuf()->open( command , mode ) and sets failbit on error.

Parameters

See also

References buf_, and command_.

Referenced by redi::basic_ipstream< char >::open(), redi::basic_ipstream< char >::open(), redi::basic_opstream< char >::open(), redi::basic_opstream< char >::open(), redi::basic_pstream< char >::open(), redi::basic_pstream< char >::open(), redi::basic_rpstream< char >::open(), redi::basic_rpstream< char >::open(), pstream_common(), and pstream_common().

template<typename C, typename T> void redi::pstream_common< C, T >::do_open (const std::string & file, const argv_type & argv, pmode mode) [inline], [protected]¶

Start a process. Calls rdbuf()->open( file, argv, mode ) and sets failbit on error.

Parameters

See also

References buf_, and command_.

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

See also

References buf_.

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

References buf_.