Class template for Output PStreams. More...

#include <PStream.h>

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

Collaboration diagram for Nice::basic_opstream< 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_opstream ()
	Default constructor, creates an uninitialised stream. More...

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

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

	~basic_opstream ()
	Destructor. More...

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

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

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

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

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

	~basic_opstream ()
	Destructor. More...

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

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

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

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

typedef pstream_common< CharT, Traits >	pbase_type

typedef std::basic_ostream< CharT, Traits >	ostream_type

typedef pstream_common< CharT, Traits >	pbase_type

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

streambuf_type	buf_
	The stream buffer. More...

Related Functions
(Note that these are not member functions.)
template<typename C , typename T >
std::basic_ostream< C, T > &	peof (std::basic_ostream< C, T > &s)
	When inserted into an output pstream the manipulator calls basic_pstreambuf<C,T>::peof() to close the output pipe, causing the child process to receive the end-of-file indicator on subsequent reads from its `stdin` stream. More...

template<typename C , typename T >
std::basic_ostream< C, T > &	peof (std::basic_ostream< C, T > &s)
	When inserted into an output pstream the manipulator calls basic_pstreambuf<C,T>::peof() to close the output pipe, causing the child process to receive the end-of-file indicator on subsequent reads from its `stdin` stream. 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::pstream_common< CharT, Traits >
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 inherited from Nice::pstream_common< CharT, Traits >
	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 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...

Detailed Description

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

Class template for Output PStreams.

Writing to an open opstream writes to the standard input of the command; the command's standard output is the same as that of 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_opstream< 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_opstream< CharT, Traits >::argv_type

Type used to hold the arguments for a command.

◆ ostream_type [1/2]

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

typedef std::basic_ostream<CharT, Traits> Nice::basic_opstream< 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_opstream< 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_opstream< 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_opstream< CharT, Traits >::pbase_type

private

◆ pmode [1/2]

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

typedef pbase_type::pmode Nice::basic_opstream< 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_opstream< CharT, Traits >::pmode

Type used to specify how to connect to the process.

Constructor & Destructor Documentation

◆ basic_opstream() [1/6]

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

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

inline

Default constructor, creates an uninitialised stream.

◆ basic_opstream() [2/6]

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

Nice::basic_opstream< CharT, Traits >::basic_opstream	(	const std::string &	command,
		pmode	mode = `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_opstream() [3/6]

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

Nice::basic_opstream< CharT, Traits >::basic_opstream	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode = `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_opstream() [1/2]

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

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

inline

Destructor.

Closes the stream and waits for the child to exit.

◆ basic_opstream() [4/6]

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

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

inline

Default constructor, creates an uninitialised stream.

◆ basic_opstream() [5/6]

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

Nice::basic_opstream< CharT, Traits >::basic_opstream	(	const std::string &	command,
		pmode	mode = `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_opstream() [6/6]

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

Nice::basic_opstream< CharT, Traits >::basic_opstream	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode = `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_opstream() [2/2]

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

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

inline

Destructor.

Closes the stream and waits for the child to exit.

Member Function Documentation

◆ open() [1/4]

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

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

inline

Start a process.

Calls do_open( command , mode|pstdin ).

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_opstream< CharT, Traits >::open	(	const std::string &	command,
		pmode	mode = `pstdin`
	)

inline

Start a process.

Calls do_open( command , mode|pstdin ).

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_opstream< CharT, Traits >::open	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode = `pstdin`
	)

inline

Start a process.

Calls do_open( file , argv , mode|pstdin ).

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_opstream< CharT, Traits >::open	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode = `pstdin`
	)

inline

Start a process.

Calls do_open( file , argv , mode|pstdin ).

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)

Friends And Related Function Documentation

◆ peof() [1/2]

template<typename C , typename T >

std::basic_ostream< C, T > & peof ( std::basic_ostream< C, T > & s )

When inserted into an output pstream the manipulator calls basic_pstreambuf<C,T>::peof() to close the output pipe, causing the child process to receive the end-of-file indicator on subsequent reads from its stdin stream.

Manipulator to close the pipe connected to the process' stdin.

Parameters

s	An output PStream class.

Returns: The stream object the manipulator was invoked on.

See also: basic_pstreambuf<C,T>::peof() basic_pstream basic_rpstream

◆ peof() [2/2]

template<typename C , typename T >

std::basic_ostream< C, T > & peof ( std::basic_ostream< C, T > & s )

When inserted into an output pstream the manipulator calls basic_pstreambuf<C,T>::peof() to close the output pipe, causing the child process to receive the end-of-file indicator on subsequent reads from its stdin stream.

Manipulator to close the pipe connected to the process' stdin.

Parameters

s	An output PStream class.

Returns: The stream object the manipulator was invoked on.

See also: basic_pstreambuf<C,T>::peof() basic_pstream basic_rpstream

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

Related Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ argv_type [1/2]

◆ argv_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_opstream() [1/6]

◆ basic_opstream() [2/6]

◆ basic_opstream() [3/6]

◆ ~basic_opstream() [1/2]

◆ basic_opstream() [4/6]

◆ basic_opstream() [5/6]

◆ basic_opstream() [6/6]

◆ ~basic_opstream() [2/2]

Member Function Documentation

◆ open() [1/4]

◆ open() [2/4]

◆ open() [3/4]

◆ open() [4/4]

Friends And Related Function Documentation

◆ peof() [1/2]

◆ peof() [2/2]

Member Data Documentation

◆ buf_ [1/2]

◆ buf_ [2/2]

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