template for Restricted PStreams. More...

#include <PStream.h>

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

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

Public Types
typedef pbase_type::pmode	pmode
	Type used to specify how to connect to the process. More...

typedef pbase_type::argv_type	argv_type
	Type used to hold the arguments for a command. More...

typedef pbase_type::pmode	pmode
	Type used to specify how to connect to the process. More...

typedef pbase_type::argv_type	argv_type
	Type used to hold the arguments for a command. More...

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...

Public Member Functions
	basic_rpstream ()
	Default constructor, creates an uninitialised stream. More...

	basic_rpstream (const std::string &command, pmode mode=pstdout\|pstdin)
	Constructor that initialises the stream by starting a process. More...

	basic_rpstream (const std::string &file, const argv_type &argv, pmode mode=pstdout\|pstdin)
	Constructor that initialises the stream by starting a process. More...

	~basic_rpstream ()
	Destructor. More...

void	open (const std::string &command, pmode mode=pstdout\|pstdin)
	Start a process. More...

void	open (const std::string &file, const argv_type &argv, pmode mode=pstdout\|pstdin)
	Start a process. More...

istream_type &	out ()
	Obtain a reference to the istream that reads the process' `stdout`. More...

istream_type &	err ()
	Obtain a reference to the istream that reads the process' `stderr`. More...

	basic_rpstream ()
	Default constructor, creates an uninitialised stream. More...

	basic_rpstream (const std::string &command, pmode mode=pstdout\|pstdin)
	Constructor that initialises the stream by starting a process. More...

	basic_rpstream (const std::string &file, const argv_type &argv, pmode mode=pstdout\|pstdin)
	Constructor that initialises the stream by starting a process. More...

	~basic_rpstream ()
	Destructor. More...

void	open (const std::string &command, pmode mode=pstdout\|pstdin)
	Start a process. More...

void	open (const std::string &file, const argv_type &argv, pmode mode=pstdout\|pstdin)
	Start a process. More...

istream_type &	out ()
	Obtain a reference to the istream that reads the process' `stdout`. More...

istream_type &	err ()
	Obtain a reference to the istream that reads the process' `stderr`. More...

Private Types
typedef std::basic_ostream< CharT, Traits >	ostream_type

typedef std::basic_istream< CharT, Traits >	istream_type

typedef pstream_common< CharT, Traits >	pbase_type

typedef std::basic_ostream< CharT, Traits >	ostream_type

typedef std::basic_istream< CharT, Traits >	istream_type

typedef pstream_common< CharT, Traits >	pbase_type

Private Types inherited from Nice::pstream_common< CharT, Traits >
typedef basic_pstreambuf< CharT, Traits >	streambuf_type

typedef basic_pstreambuf< CharT, Traits >	streambuf_type

Private 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...

enum	{ bufsz = 32 }

enum	{ pbsz = 2 }

enum	{ bufsz = 32 }

enum	{ pbsz = 2 }

Private Attributes
streambuf_type	buf_
	The stream buffer. More...

streambuf_type	buf_
	The stream buffer. More...

Private Attributes inherited from Nice::pstream_common< CharT, Traits >
std::string	command_
	The command used to start the process. More...

streambuf_type	buf_
	The stream buffer. More...

Additional Inherited Members
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...

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

enum	{ pbsz = 2 }

enum	{ bufsz = 32 }

enum	{ pbsz = 2 }

Private Member Functions inherited from Nice::pstream_common< CharT, Traits >
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...

	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...

Static Private 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::basic_rpstream< CharT, Traits >

template for Restricted PStreams.

Writing to an rpstream opened with pmode pstdin writes to the standard input of the command. It is not possible to read directly from an rpstream object, to use an rpstream as in istream you must call either basic_rpstream::out() or basic_rpstream::err(). This is to prevent accidental reads from the wrong input source. If the rpstream was not opened with pmode pstderr then the class cannot read the process' stderr, and basic_rpstream::err() will return an istream that reads from the process' stdout, and vice versa. Reading from an rpstream opened with pmode pstdout and/or pstderr reads the command's standard output and/or standard error. Any of the process' stdin, stdout or stderr that is not connected to the pstream (as specified by the pmode) will be the same as the process that created the pstream object, unless altered by the command itself.

Member Typedef Documentation

◆ argv_type [1/2]

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

typedef pbase_type::argv_type Nice::basic_rpstream< CharT, Traits >::argv_type

Type used to hold the arguments for a command.

◆ argv_type [2/2]

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

typedef pbase_type::argv_type Nice::basic_rpstream< CharT, Traits >::argv_type

Type used to hold the arguments for a command.

◆ istream_type [1/2]

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

typedef std::basic_istream<CharT, Traits> Nice::basic_rpstream< CharT, Traits >::istream_type

private

◆ istream_type [2/2]

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

typedef std::basic_istream<CharT, Traits> Nice::basic_rpstream< CharT, Traits >::istream_type

private

◆ ostream_type [1/2]

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

typedef std::basic_ostream<CharT, Traits> Nice::basic_rpstream< CharT, Traits >::ostream_type

private

◆ ostream_type [2/2]

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

typedef std::basic_ostream<CharT, Traits> Nice::basic_rpstream< CharT, Traits >::ostream_type

private

◆ pbase_type [1/2]

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

typedef pstream_common<CharT, Traits> Nice::basic_rpstream< CharT, Traits >::pbase_type

private

◆ pbase_type [2/2]

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

typedef pstream_common<CharT, Traits> Nice::basic_rpstream< CharT, Traits >::pbase_type

private

◆ pmode [1/2]

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

typedef pbase_type::pmode Nice::basic_rpstream< CharT, Traits >::pmode

Type used to specify how to connect to the process.

◆ pmode [2/2]

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

typedef pbase_type::pmode Nice::basic_rpstream< CharT, Traits >::pmode

Type used to specify how to connect to the process.

Constructor & Destructor Documentation

◆ basic_rpstream() [1/6]

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

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

inline

Default constructor, creates an uninitialised stream.

◆ basic_rpstream() [2/6]

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

Nice::basic_rpstream< CharT, Traits >::basic_rpstream	(	const std::string &	command,
		pmode	mode = `pstdout\|pstdin`
	)

inline

Constructor that initialises the stream by starting a process.

Initialises the stream buffer by calling do_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: do_open(const std::string&, pmode)

◆ basic_rpstream() [3/6]

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

Nice::basic_rpstream< CharT, Traits >::basic_rpstream	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode = `pstdout\|pstdin`
	)

inline

Constructor that initialises the stream by starting a process.

Initialises the stream buffer by calling do_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: do_open(const std::string&, const argv_type&, pmode)

◆ ~basic_rpstream() [1/2]

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

Nice::basic_rpstream< CharT, Traits >::~basic_rpstream ( )

inline

Destructor.

◆ basic_rpstream() [4/6]

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

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

inline

Default constructor, creates an uninitialised stream.

◆ basic_rpstream() [5/6]

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

Nice::basic_rpstream< CharT, Traits >::basic_rpstream	(	const std::string &	command,
		pmode	mode = `pstdout\|pstdin`
	)

inline

Constructor that initialises the stream by starting a process.

Initialises the stream buffer by calling do_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: do_open(const std::string&, pmode)

◆ basic_rpstream() [6/6]

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

Nice::basic_rpstream< CharT, Traits >::basic_rpstream	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode = `pstdout\|pstdin`
	)

inline

Constructor that initialises the stream by starting a process.

Initialises the stream buffer by calling do_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: do_open(const std::string&, const argv_type&, pmode)

◆ ~basic_rpstream() [2/2]

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

Nice::basic_rpstream< CharT, Traits >::~basic_rpstream ( )

inline

Destructor.

Member Function Documentation

◆ err() [1/2]

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

istream_type& Nice::basic_rpstream< CharT, Traits >::err ( )

inline

Obtain a reference to the istream that reads the process' stderr.

Returns: *this

◆ err() [2/2]

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

istream_type& Nice::basic_rpstream< CharT, Traits >::err ( )

inline

Obtain a reference to the istream that reads the process' stderr.

Returns: *this

◆ open() [1/4]

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

void Nice::basic_rpstream< CharT, Traits >::open	(	const std::string &	command,
		pmode	mode = `pstdout\|pstdin`
	)

inline

Start a process.

Calls 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)

◆ open() [2/4]

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

void Nice::basic_rpstream< CharT, Traits >::open	(	const std::string &	command,
		pmode	mode = `pstdout\|pstdin`
	)

inline

Start a process.

Calls 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)

◆ open() [3/4]

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

void Nice::basic_rpstream< CharT, Traits >::open	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode = `pstdout\|pstdin`
	)

inline

Start a process.

Calls 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)

◆ open() [4/4]

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

void Nice::basic_rpstream< CharT, Traits >::open	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode = `pstdout\|pstdin`
	)

inline

Start a process.

Calls 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)

◆ out() [1/2]

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

istream_type& Nice::basic_rpstream< CharT, Traits >::out ( )

inline

Obtain a reference to the istream that reads the process' stdout.

Returns: *this

◆ out() [2/2]

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

istream_type& Nice::basic_rpstream< CharT, Traits >::out ( )

inline

Obtain a reference to the istream that reads the process' stdout.

Returns: *this

Member Data Documentation

◆ buf_ [1/2]

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

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

private

The stream buffer.

◆ buf_ [2/2]

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

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

private

The stream buffer.

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

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

Public Types

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ argv_type [1/2]

◆ argv_type [2/2]

◆ istream_type [1/2]

◆ istream_type [2/2]

◆ ostream_type [1/2]

◆ ostream_type [2/2]

◆ pbase_type [1/2]

◆ pbase_type [2/2]

◆ pmode [1/2]

◆ pmode [2/2]

Constructor & Destructor Documentation

◆ basic_rpstream() [1/6]

◆ basic_rpstream() [2/6]

◆ basic_rpstream() [3/6]

◆ ~basic_rpstream() [1/2]

◆ basic_rpstream() [4/6]

◆ basic_rpstream() [5/6]

◆ basic_rpstream() [6/6]

◆ ~basic_rpstream() [2/2]

Member Function Documentation

◆ err() [1/2]

◆ err() [2/2]

◆ open() [1/4]

◆ open() [2/4]

◆ open() [3/4]

◆ open() [4/4]

◆ out() [1/2]

◆ out() [2/2]

Member Data Documentation

◆ buf_ [1/2]

◆ buf_ [2/2]

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