| redi::basic_rpstream< CharT, Traits >(3) | Library Functions Manual | redi::basic_rpstream< CharT, Traits >(3) |
redi::basic_rpstream - Class template for Restricted PStreams
#include <pstream.h>
Inherits basic_ostream< CharT, std::char_traits< CharT > >, basic_istream< CharT, std::char_traits< CharT > >, redi::pstream_common< CharT, std::char_traits< CharT > >, and redi::pstreams.
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.
basic_rpstream ()
Default constructor, creates an uninitialised stream. basic_rpstream
(const std::string &cmd, pmode mode=pstdout|pstdin)
Constructor that initialises the stream by starting a process.
basic_rpstream (const std::string &file, const argv_type
&argv, pmode mode=pstdout|pstdin)
Constructor that initialises the stream by starting a process.
basic_rpstream (const argv_type &argv, pmode
mode=pstdout|pstdin)
Constructor that initialises the stream by starting a process.
~basic_rpstream ()
Destructor. void open (const std::string &cmd, pmode
mode=pstdout|pstdin)
Start a process. void open (const std::string &file, const
argv_type &argv, pmode mode=pstdout|pstdin)
Start a process. istream_type & out ()
Obtain a reference to the istream that reads the process' stdout.
istream_type & err ()
Obtain a reference to the istream that reads the process' 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. static const pmode newpg =
std::ios_base::trunc
Create a new process group for the child process.
enum { bufsz = 32 }
enum { pbsz = 2 }
class redi::basic_rpstream< CharT, Traits >" Class 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.
Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open() with the supplied arguments.
Parameters
See also
Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open() with the supplied arguments.
Parameters
See also
Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open(argv[0],argv,mode)
Parameters
See also
Obtain a reference to the istream that reads the process' stderr.
Returns
References redi::basic_pstreambuf< CharT, Traits >::read_err().
Start a process. Calls do_open( cmd , mode ).
Parameters
See also
References redi::pstream_common< CharT, std::char_traits< CharT > >::do_open().
Start a process. Calls do_open( file , argv , mode ).
Parameters
See also
References redi::pstream_common< CharT, std::char_traits< CharT > >::do_open().
Obtain a reference to the istream that reads the process' stdout.
Returns
References redi::basic_pstreambuf< CharT, Traits >::read_err().
Generated automatically by Doxygen for PStreams from the source code.
| Sun Dec 13 2020 | PStreams |