Class template for Output PStreams. More...
#include <pstream.h>
Public Types | |
typedef pbase_type::pmode | pmode |
Type used to specify how to connect to the process. | |
typedef pbase_type::argv_type | argv_type |
Type used to hold the arguments for a command. | |
typedef int | fd_type |
Type used for file descriptors. | |
typedef int | fd_type |
Type used for file descriptors. | |
Public Member Functions | |
basic_opstream () | |
Default constructor, creates an uninitialised stream. | |
basic_opstream (const std::string &command, pmode mode=pstdin) | |
Constructor that initialises the stream by starting a process. | |
basic_opstream (const std::string &file, const argv_type &argv, pmode mode=pstdin) | |
Constructor that initialises the stream by starting a process. | |
~basic_opstream () | |
Destructor. | |
void | open (const std::string &command, pmode mode=pstdin) |
Start a process. | |
void | open (const std::string &file, const argv_type &argv, pmode mode=pstdin) |
Start a process. | |
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. | |
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 | 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. | |
Protected Types | |
typedef basic_pstreambuf < CharT, Traits > | streambuf_type |
enum | { bufsz = 32 } |
enum | { pbsz = 2 } |
enum | { bufsz = 32 } |
enum | { pbsz = 2 } |
Protected Member Functions | |
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. | |
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) |
Manipulator to close the pipe connected to the process' stdin. |
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.
redi::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.
command | a string containing a shell command. | |
mode | the I/O mode to use when opening the pipe. |
redi::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.
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. |
redi::basic_opstream< CharT, Traits >::~basic_opstream | ( | ) | [inline] |
Destructor.
Closes the stream and waits for the child to exit.
void redi::pstream_common< C, T >::close | ( | ) | [inline, inherited] |
Close the pipe.
Calls rdbuf->close() and sets failbit
on error.
References redi::pstream_common< CharT, Traits >::buf_, and redi::basic_pstreambuf< CharT, Traits >::close().
const std::string & redi::pstream_common< C, T >::command | ( | ) | const [inline, inherited] |
Return the command used to initialise the stream.
References redi::pstream_common< CharT, Traits >::command_.
void redi::pstream_common< C, T >::do_open | ( | const std::string & | file, | |
const argv_type & | argv, | |||
pmode | mode | |||
) | [inline, protected, inherited] |
Start a process.
Calls rdbuf()->open( file, argv, mode ) and sets failbit
on error.
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. |
References redi::pstream_common< CharT, Traits >::buf_, redi::pstream_common< CharT, Traits >::command_, and redi::basic_pstreambuf< CharT, Traits >::open().
void redi::pstream_common< C, T >::do_open | ( | const std::string & | command, | |
pmode | mode | |||
) | [inline, protected, inherited] |
Start a process.
Calls rdbuf()->open( command , mode ) and sets failbit
on error.
command | a string containing a shell command. | |
mode | the I/O mode to use when opening the pipe. |
References redi::pstream_common< CharT, Traits >::buf_, redi::pstream_common< CharT, Traits >::command_, and redi::basic_pstreambuf< CharT, Traits >::open().
Referenced by redi::basic_rpstream< CharT, Traits >::open(), redi::basic_pstream< CharT, Traits >::open(), redi::basic_opstream< CharT, Traits >::open(), redi::basic_ipstream< CharT, Traits >::open(), and redi::pstream_common< CharT, Traits >::pstream_common().
bool redi::pstream_common< C, T >::is_open | ( | ) | const [inline, inherited] |
Report whether the stream's buffer has been initialised.
References redi::pstream_common< CharT, Traits >::buf_, and redi::basic_pstreambuf< CharT, Traits >::is_open().
void redi::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 ).
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. |
References redi::pstream_common< CharT, Traits >::do_open(), and redi::pstreams::pstdin.
void redi::basic_opstream< CharT, Traits >::open | ( | const std::string & | command, | |
pmode | mode = pstdin | |||
) | [inline] |
Start a process.
Calls do_open( command , mode|pstdin ).
command | a string containing a shell command. | |
mode | the I/O mode to use when opening the pipe. |
References redi::pstream_common< CharT, Traits >::do_open(), and redi::pstreams::pstdin.
pstream_common< C, T >::streambuf_type * redi::pstream_common< C, T >::rdbuf | ( | ) | const [inline, inherited] |
Return a pointer to the stream buffer.
References redi::pstream_common< CharT, Traits >::buf_.
std::basic_ostream< C, T > & peof | ( | std::basic_ostream< C, T > & | s | ) | [related] |
Manipulator to close the pipe connected to the process' stdin.
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.
s | An output PStream class. |