| redi::basic_opstream< CharT, Traits >(3) | Library Functions Manual | redi::basic_opstream< CharT, Traits >(3) |
redi::basic_opstream< CharT, Traits > - Class template for Output PStreams.
#include <pstream.h>
Inherits basic_ostream< CharT, Traits >, redi::pstream_common< CharT, Traits >, 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. typedef int fd_type
Type used for file descriptors.
basic_opstream ()
Default constructor, creates an uninitialised stream. basic_opstream
(const std::string &cmd, 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 (const argv_type &argv, pmode
mode=pstdin)
Constructor that initialises the stream by starting a process.
~basic_opstream ()
Destructor. void open (const std::string &cmd, 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 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.
typedef basic_pstreambuf< CharT, Traits >
streambuf_type
enum { bufsz = 32 }
enum { pbsz = 2 }
enum { bufsz = 32 }
enum { pbsz = 2 }
void do_open (const std::string &cmd, pmode
mode)
Start a process. void do_open (const std::string &file, const
argv_type &argv, pmode mode)
Start a process.
std::string command_
The command used to start the process. streambuf_type buf_
The stream buffer.
(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 redi::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.
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|pstdin)
Parameters:
See also:
References redi::pstreams::pstdin.
Destructor. Closes the stream and waits for the child to exit.
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().
Return the command used to initialise the stream.
Returns:
References redi::pstream_common< CharT, Traits >::command_.
Start a process. Calls rdbuf()->open( command , mode ) and sets failbit on error.
Parameters:
See also:
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().
Start a process. Calls rdbuf()->open( file, argv, mode ) and sets failbit on error.
Parameters:
See also:
References redi::pstream_common< CharT, Traits >::buf_, redi::pstream_common< CharT, Traits >::command_, and redi::basic_pstreambuf< CharT, Traits >::open().
Report whether the stream's buffer has been initialised.
Returns:
See also:
References redi::pstream_common< CharT, Traits >::buf_, and redi::basic_pstreambuf< CharT, Traits >::is_open().
Start a process. Calls do_open( cmd , mode|pstdin ).
Parameters:
See also:
References redi::pstreams::pstdin.
Start a process. Calls do_open( file , argv , mode|pstdin ).
Parameters:
See also:
References redi::pstreams::pstdin.
Return a pointer to the stream buffer.
Returns:
References redi::pstream_common< CharT, Traits >::buf_, redi::pstreams::pstderr, redi::pstreams::pstdin, and redi::pstreams::pstdout.
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.
Parameters:
Returns:
See also:
References redi::basic_pstreambuf< CharT, Traits >::peof().
Generated automatically by Doxygen for PStreams from the source code.
| Sat Jul 21 2018 | PStreams |