redi::basic_opstream< CharT, Traits >(3) | Library Functions Manual | redi::basic_opstream< CharT, Traits >(3) |
NAME¶
redi::basic_opstream< CharT, Traits > - Class template for Output PStreams.SYNOPSIS¶
#include <pstream.h>
Inherits basic_ostream< CharT, Traits >, redi::pstream_common< CharT, Traits >, and redi::pstreams.
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 &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 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. 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.
Detailed Description¶
template<typename CharT, typename Traits = std::char_traits<CharT>>¶
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 & Destructor Documentation¶
template<typename CharT , typename Traits = std::char_traits<CharT>> redi::basic_opstream< CharT, Traits >::basic_opstream (const std::string & cmd, pmode mode = pstdin) [inline], [explicit]¶
Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open() with the supplied arguments.Parameters:
mode the I/O mode to use when opening the pipe.
See also:
template<typename CharT , typename Traits = std::char_traits<CharT>> 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.Parameters:
argv a vector of argument strings passed to the new program.
mode the I/O mode to use when opening the pipe.
See also:
template<typename CharT , typename Traits = std::char_traits<CharT>> redi::basic_opstream< CharT, Traits >::basic_opstream (const argv_type & argv, pmode mode = pstdin) [inline], [explicit]¶
Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open(argv[0],argv,mode|pstdin)Parameters:
mode the I/O mode to use when opening the pipe.
See also:
References redi::pstreams::pstdin.
template<typename CharT , typename Traits = std::char_traits<CharT>> redi::basic_opstream< CharT, Traits >::~basic_opstream () [inline]¶
Destructor. Closes the stream and waits for the child to exit.Member Function Documentation¶
template<typename C , typename T > 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().
template<typename C , typename T > const std::string & redi::pstream_common< C, T >::command () const [inline], [inherited]¶
Return the command used to initialise the stream.Returns:
References redi::pstream_common< CharT, Traits >::command_.
template<typename C , typename T > void redi::pstream_common< C, T >::do_open (const std::string & cmd, pmode mode) [inline], [protected], [inherited]¶
Start a process. Calls rdbuf()->open( command , mode ) and sets failbit on error.Parameters:
mode the I/O mode to use when opening the pipe.
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().
template<typename C , typename T > 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.Parameters:
argv a vector of argument strings passed to the new program.
mode the I/O mode to use when opening the pipe.
See also:
References redi::pstream_common< CharT, Traits >::buf_, redi::pstream_common< CharT, Traits >::command_, and redi::basic_pstreambuf< CharT, Traits >::open().
template<typename C , typename T > bool redi::pstream_common< C, T >::is_open () const [inline], [inherited]¶
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().
template<typename CharT , typename Traits = std::char_traits<CharT>> void redi::basic_opstream< CharT, Traits >::open (const std::string & cmd, pmode mode = pstdin) [inline]¶
Start a process. Calls do_open( cmd , mode|pstdin ).Parameters:
mode the I/O mode to use when opening the pipe.
See also:
References redi::pstreams::pstdin.
template<typename CharT , typename Traits = std::char_traits<CharT>> 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 ).Parameters:
argv a vector of argument strings passed to the new program.
mode the I/O mode to use when opening the pipe.
See also:
References redi::pstreams::pstdin.
template<typename C , typename T > pstream_common< C, T >::streambuf_type * redi::pstream_common< C, T >::rdbuf () const [inline], [inherited]¶
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.
Friends And Related Function Documentation¶
template<typename C , typename T > 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.Parameters:
Returns:
See also:
References redi::basic_pstreambuf< CharT, Traits >::peof().
Author¶
Generated automatically by Doxygen for PStreams from the source code.Sat Jul 21 2018 | PStreams |