IXE::io::pstream_common< CharT, Traits > Class Template Reference

Class template for common base class. More...

#include <pstream.h>

Inheritance diagram for IXE::io::pstream_common< CharT, Traits >:

List of all members.

Public Member Functions
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
	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 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 &command, 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.

---

Detailed Description

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

Class template for common base class.

---

Constructor & Destructor Documentation

template<typename C , typename T >

IXE::io::pstream_common< C, T >::pstream_common

(

)

[inline, protected]

Default constructor.

Creates an uninitialised stream.

References IXE::io::pstream_common< CharT, Traits >::buf_.

template<typename C , typename T >

IXE::io::pstream_common< C, T >::pstream_common	(	const std::string &	command,
		pmode	mode
	)			[inline, protected]

Constructor that initialises the stream by starting a process.

Initialises the stream buffer by calling do_open( command , mode ).

Parameters:

	command	a string containing a shell command.
	mode	the I/O mode to use when opening the pipe.

See also:

do_open(const std::string&, pmode)

References IXE::io::pstream_common< CharT, Traits >::buf_, and IXE::io::pstream_common< CharT, Traits >::do_open().

template<typename C , typename T >

IXE::io::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:

	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:

do_open(const std::string&, const argv_type&, pmode)

References IXE::io::pstream_common< CharT, Traits >::buf_, and IXE::io::pstream_common< CharT, Traits >::do_open().

template<typename C , typename T >

IXE::io::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 IXE::io::pstream_common< C, T >::close

(

)

[inline]

Close the pipe.

Calls rdbuf->close() and sets failbit on error.

References IXE::io::pstream_common< CharT, Traits >::buf_, and IXE::io::basic_pstreambuf< CharT, Traits >::close().

template<typename C , typename T >

const std::string & IXE::io::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.

References IXE::io::pstream_common< CharT, Traits >::command_.

template<typename C , typename T >

void IXE::io::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:

	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(const std::string&, const argv_type&, pmode)

References IXE::io::pstream_common< CharT, Traits >::buf_, IXE::io::pstream_common< CharT, Traits >::command_, and IXE::io::basic_pstreambuf< CharT, Traits >::open().

template<typename C , typename T >

void IXE::io::pstream_common< C, T >::do_open	(	const std::string &	command,
		pmode	mode
	)			[inline, protected]

Start a process.

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

Parameters:

	command	a string containing a shell command.
	mode	the I/O mode to use when opening the pipe.

See also:

basic_pstreambuf::open(const std::string&, pmode)

References IXE::io::pstream_common< CharT, Traits >::buf_, IXE::io::pstream_common< CharT, Traits >::command_, and IXE::io::basic_pstreambuf< CharT, Traits >::open().

Referenced by IXE::io::basic_rpstream< CharT, Traits >::open(), IXE::io::basic_pstream< CharT, Traits >::open(), IXE::io::basic_opstream< CharT, Traits >::open(), IXE::io::basic_ipstream< CharT, Traits >::open(), and IXE::io::pstream_common< CharT, Traits >::pstream_common().

template<typename C , typename T >

bool IXE::io::pstream_common< C, T >::is_open

(

)

const [inline]

Report whether the stream's buffer has been initialised.

Returns:

rdbuf()->is_open().

See also:

basic_pstreambuf::is_open()

References IXE::io::pstream_common< CharT, Traits >::buf_, and IXE::io::basic_pstreambuf< CharT, Traits >::is_open().

template<typename C , typename T >

pstream_common< C, T >::streambuf_type * IXE::io::pstream_common< C, T >::rdbuf

(

)

const [inline]

Return a pointer to the stream buffer.

Returns:

a pointer to the private stream buffer member.

References IXE::io::pstream_common< CharT, Traits >::buf_.

---

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

• search/ixe/io/pstream.h