Class template for common base class. More...

#include <PStream.h>

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

Collaboration diagram for Nice::pstream_common< CharT, Traits >:

Public Member Functions
void	close ()
	Close the pipe. More...

bool	is_open () const
	Report whether the stream's buffer has been initialised. More...

const std::string &	command () const
	Return the command used to initialise the stream. More...

streambuf_type *	rdbuf () const
	Return a pointer to the stream buffer. More...

void	close ()
	Close the pipe. More...

bool	is_open () const
	Report whether the stream's buffer has been initialised. More...

const std::string &	command () const
	Return the command used to initialise the stream. More...

streambuf_type *	rdbuf () const
	Return a pointer to the stream buffer. More...

Protected Types
typedef basic_pstreambuf< CharT, Traits >	streambuf_type

typedef basic_pstreambuf< CharT, Traits >	streambuf_type

Protected Types inherited from Nice::pstreams
enum	{ bufsz = 32 }

enum	{ pbsz = 2 }

enum	{ bufsz = 32 }

enum	{ pbsz = 2 }

Protected Member Functions
	pstream_common ()
	Default constructor. More...

	pstream_common (const std::string &command, pmode mode)
	Constructor that initialises the stream by starting a process. More...

	pstream_common (const std::string &file, const argv_type &argv, pmode mode)
	Constructor that initialises the stream by starting a process. More...

virtual	~pstream_common ()=0
	Pure virtual destructor. More...

void	do_open (const std::string &command, pmode mode)
	Start a process. More...

void	do_open (const std::string &file, const argv_type &argv, pmode mode)
	Start a process. More...

	pstream_common ()
	Default constructor. More...

	pstream_common (const std::string &command, pmode mode)
	Constructor that initialises the stream by starting a process. More...

	pstream_common (const std::string &file, const argv_type &argv, pmode mode)
	Constructor that initialises the stream by starting a process. More...

virtual	~pstream_common ()=0
	Pure virtual destructor. More...

void	do_open (const std::string &command, pmode mode)
	Start a process. More...

void	do_open (const std::string &file, const argv_type &argv, pmode mode)
	Start a process. More...

Protected Attributes
std::string	command_
	The command used to start the process. More...

streambuf_type	buf_
	The stream buffer. More...

Additional Inherited Members
Public Types inherited from Nice::pstreams
typedef std::ios_base::openmode	pmode
	Type used to specify how to connect to the process. More...

typedef std::vector< std::string >	argv_type
	Type used to hold the arguments for a command. More...

typedef int	fd_type
	Type used for file descriptors. More...

typedef std::ios_base::openmode	pmode
	Type used to specify how to connect to the process. More...

typedef std::vector< std::string >	argv_type
	Type used to hold the arguments for a command. More...

typedef int	fd_type
	Type used for file descriptors. More...

Static Public Attributes inherited from Nice::pstreams
static const pmode	pstdin = std::ios_base::out
	Write to stdin. More...

static const pmode	pstdout = std::ios_base::in
	Read from stdout. More...

static const pmode	pstderr = std::ios_base::app
	Read from stderr. More...

Detailed Description

template<typename CharT, typename Traits = std::char_traits<CharT>>
class Nice::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.

Member Typedef Documentation

◆ streambuf_type [1/2]

template<typename CharT , typename Traits = std::char_traits<CharT>>

typedef basic_pstreambuf<CharT, Traits> Nice::pstream_common< CharT, Traits >::streambuf_type

protected

◆ streambuf_type [2/2]

template<typename CharT , typename Traits = std::char_traits<CharT>>

typedef basic_pstreambuf<CharT, Traits> Nice::pstream_common< CharT, Traits >::streambuf_type

protected

Constructor & Destructor Documentation

◆ pstream_common() [1/6]

template<typename C , typename T >

Nice::pstream_common< C, T >::pstream_common ( )

inlineprotected

Default constructor.

Creates an uninitialised stream.

◆ pstream_common() [2/6]

template<typename C , typename T >

Nice::pstream_common< C, T >::pstream_common	(	const std::string &	command,
		pmode	mode
	)

inlineprotected

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)

◆ pstream_common() [3/6]

template<typename C , typename T >

Nice::pstream_common< C, T >::pstream_common	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode
	)

inlineprotected

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)

◆ ~pstream_common() [1/2]

template<typename C , typename T >

Nice::pstream_common< C, T >::~pstream_common ( )

inlineprotectedpure 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!)

◆ pstream_common() [4/6]

template<typename CharT , typename Traits = std::char_traits<CharT>>

Nice::pstream_common< CharT, Traits >::pstream_common ( )

protected

Default constructor.

◆ pstream_common() [5/6]

template<typename CharT , typename Traits = std::char_traits<CharT>>

Nice::pstream_common< CharT, Traits >::pstream_common	(	const std::string &	command,
		pmode	mode
	)

protected

Constructor that initialises the stream by starting a process.

◆ pstream_common() [6/6]

template<typename CharT , typename Traits = std::char_traits<CharT>>

Nice::pstream_common< CharT, Traits >::pstream_common	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode
	)

protected

Constructor that initialises the stream by starting a process.

◆ ~pstream_common() [2/2]

template<typename CharT , typename Traits = std::char_traits<CharT>>

virtual Nice::pstream_common< CharT, Traits >::~pstream_common ( )

protectedpure virtual

Pure virtual destructor.

Member Function Documentation

◆ close() [1/2]

template<typename C , typename T >

void Nice::pstream_common< C, T >::close ( void )

inline

Close the pipe.

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

◆ close() [2/2]

template<typename CharT , typename Traits = std::char_traits<CharT>>

void Nice::pstream_common< CharT, Traits >::close ( )

Close the pipe.

◆ command() [1/2]

template<typename C , typename T >

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

◆ command() [2/2]

template<typename CharT , typename Traits = std::char_traits<CharT>>

const std::string& Nice::pstream_common< CharT, Traits >::command ( ) const

Return the command used to initialise the stream.

◆ do_open() [1/4]

template<typename C , typename T >

void Nice::pstream_common< C, T >::do_open	(	const std::string &	command,
		pmode	mode
	)

inlineprotected

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)

◆ do_open() [2/4]

template<typename CharT , typename Traits = std::char_traits<CharT>>

void Nice::pstream_common< CharT, Traits >::do_open	(	const std::string &	command,
		pmode	mode
	)

protected

Start a process.

◆ do_open() [3/4]

template<typename CharT , typename Traits = std::char_traits<CharT>>

void Nice::pstream_common< CharT, Traits >::do_open	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode
	)

protected

Start a process.

◆ do_open() [4/4]

template<typename C , typename T >

void Nice::pstream_common< C, T >::do_open	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode
	)

inlineprotected

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)

◆ is_open() [1/2]

template<typename CharT , typename Traits = std::char_traits<CharT>>

bool Nice::pstream_common< CharT, Traits >::is_open ( ) const

Report whether the stream's buffer has been initialised.

◆ is_open() [2/2]

template<typename C , typename T >

bool Nice::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()

◆ rdbuf() [1/2]

template<typename C , typename T >

pstream_common< C, T >::streambuf_type * Nice::pstream_common< C, T >::rdbuf ( ) const

inline

Return a pointer to the stream buffer.

Returns: a pointer to the private stream buffer member.

◆ rdbuf() [2/2]

template<typename CharT , typename Traits = std::char_traits<CharT>>

streambuf_type* Nice::pstream_common< CharT, Traits >::rdbuf ( ) const

Return a pointer to the stream buffer.

Member Data Documentation

◆ buf_

template<typename CharT , typename Traits = std::char_traits<CharT>>

streambuf_type Nice::pstream_common< CharT, Traits >::buf_

protected

The stream buffer.

◆ command_

template<typename CharT , typename Traits = std::char_traits<CharT>>

std::string Nice::pstream_common< CharT, Traits >::command_

protected

The command used to start the process.

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

/home/nirva/insroot/include/Nice/Chat/PStream.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ streambuf_type [1/2]

◆ streambuf_type [2/2]

Constructor & Destructor Documentation

◆ pstream_common() [1/6]

◆ pstream_common() [2/6]

◆ pstream_common() [3/6]

◆ ~pstream_common() [1/2]

◆ pstream_common() [4/6]

◆ pstream_common() [5/6]

◆ pstream_common() [6/6]

◆ ~pstream_common() [2/2]

Member Function Documentation

◆ close() [1/2]

◆ close() [2/2]

◆ command() [1/2]

◆ command() [2/2]

◆ do_open() [1/4]

◆ do_open() [2/4]

◆ do_open() [3/4]

◆ do_open() [4/4]

◆ is_open() [1/2]

◆ is_open() [2/2]

◆ rdbuf() [1/2]

◆ rdbuf() [2/2]

Member Data Documentation

◆ buf_

◆ command_

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