PStreams
|
Class template for Input 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_ipstream () | |
Default constructor, creates an uninitialised stream. | |
basic_ipstream (const std::string &cmd, pmode mode=pstdout) | |
Constructor that initialises the stream by starting a process. More... | |
basic_ipstream (const std::string &file, const argv_type &argv, pmode mode=pstdout) | |
Constructor that initialises the stream by starting a process. More... | |
basic_ipstream (const argv_type &argv, pmode mode=pstdout) | |
Constructor that initialises the stream by starting a process. More... | |
~basic_ipstream () | |
Destructor. More... | |
void | open (const std::string &cmd, pmode mode=pstdout) |
Start a process. More... | |
void | open (const std::string &file, const argv_type &argv, pmode mode=pstdout) |
Start a process. More... | |
basic_ipstream & | out () |
Set streambuf to read from process' stdout . More... | |
basic_ipstream & | err () |
Set streambuf to read from process' stderr . 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... | |
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 | newpg = std::ios_base::trunc |
Create a new process group for the child process. | |
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 | newpg = std::ios_base::trunc |
Create a new process group for the child process. | |
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 &cmd, 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. | |
streambuf_type | buf_ |
The stream buffer. | |
Class template for Input PStreams.
Reading from an ipstream reads the command's standard output and/or standard error (depending on how the ipstream is opened) and the command's standard input is the same as that of the process that created the object, unless altered by the command itself.
|
inlineexplicit |
Constructor that initialises the stream by starting a process.
Initialises the stream buffer by calling do_open() with the supplied arguments.
cmd | a string containing a shell command. |
mode | the I/O mode to use when opening the pipe. |
|
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. |
|
inlineexplicit |
Constructor that initialises the stream by starting a process.
Initialises the stream buffer by calling do_open
(argv[0],argv,mode|pstdout)
argv | a vector of argument strings passed to the new program. |
mode | the I/O mode to use when opening the pipe. |
References redi::pstreams::pstdout.
|
inline |
Destructor.
Closes the stream and waits for the child to exit.
|
inlineinherited |
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().
|
inlineinherited |
Return the command used to initialise the stream.
References redi::pstream_common< CharT, Traits >::command_.
|
inlineprotectedinherited |
Start a process.
Calls rdbuf()->open( command , mode ) and sets failbit
on error.
cmd | 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::pstream_common< CharT, Traits >::pstream_common().
|
inlineprotectedinherited |
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().
|
inline |
Set streambuf to read from process' stderr
.
*this
|
inlineinherited |
Report whether the stream's buffer has been initialised.
References redi::pstream_common< CharT, Traits >::buf_, and redi::basic_pstreambuf< CharT, Traits >::is_open().
|
inline |
Start a process.
Calls do_open( cmd , mode|pstdout ).
cmd | a string containing a shell command. |
mode | the I/O mode to use when opening the pipe. |
|
inline |
Start a process.
Calls do_open( file , argv , mode|pstdout ).
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. |
|
inline |
Set streambuf to read from process' stdout
.
*this
|
inlineinherited |
Return a pointer to the stream buffer.
References redi::pstream_common< CharT, Traits >::buf_, redi::pstreams::pstderr, redi::pstreams::pstdin, and redi::pstreams::pstdout.