redi::basic_pstream< CharT, Traits >(3) | Library Functions Manual | redi::basic_pstream< CharT, Traits >(3) |
NAME¶
redi::basic_pstream< CharT, Traits > - Class template for Bidirectional PStreams.SYNOPSIS¶
#include <pstream.h> Inherits basic_iostream< CharT, Traits >, redi::pstream_common< CharT, Traits >, and redi::pstreams.Public Types¶
typedef pbase_type::pmode pmode
Public Member Functions¶
basic_pstream ()
Static Public Attributes¶
static const pmode pstdin = std::ios_base::out
Protected Types¶
typedef basic_pstreambuf
Protected Member Functions¶
void do_open (const std::string &command, pmode mode)
Protected Attributes¶
std::string command_
Detailed Description¶
template<typename CharT, typename Traits = std::char_traits<CharT>>class redi::basic_pstream< CharT, Traits >¶
Class template for Bidirectional PStreams. Writing to a pstream opened with pmode pstdin writes to the standard input of the command. Reading from a pstream 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 & Destructor Documentation¶
template<typename CharT , typename Traits = std::char_traits<CharT>> redi::basic_pstream< CharT, Traits >:: basic_pstream (const std::string &command, pmodemode = pstdout|pstdin ) [inline]¶
Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open() with the supplied arguments. Parameters:command a string containing a shell command.
mode the I/O mode to use when opening the pipe.
See Also:
do_open(const std::string&, pmode)
template<typename CharT , typename Traits = std::char_traits<CharT>> redi::basic_pstream< CharT, Traits >:: basic_pstream (const std::string &file, const argv_type &argv, pmodemode = pstdout|pstdin) [inline]¶
Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open() with the supplied arguments. Parameters: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.
See Also:
do_open(const std::string&, const argv_type&,
pmode)
template<typename CharT , typename Traits = std::char_traits<CharT>> redi::basic_pstream< CharT, Traits >:: basic_pstream (const argv_type &argv, pmodemode = pstdout|pstdin ) [inline]¶
Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open(argv[0],argv,mode) 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:
do_open(const std::string&, const argv_type&,
pmode)
template<typename CharT , typename Traits = std::char_traits<CharT>> redi::basic_pstream< CharT, Traits >::~ basic_pstream () [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.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:a string containing the command used to initialise the
stream.
template<typename C , typename T > void redi::pstream_common< C, T >::do_open (const std::string &command, pmodemode) [inline], [protected], [inherited]¶
Start a process. Calls rdbuf()->open( command , mode ) and sets failbit on error. Parameters:command a string containing a shell command.
mode the I/O mode to use when opening the pipe.
See Also:
basic_pstreambuf::open(const std::string&,
pmode)
Referenced by redi::basic_ipstream< CharT, Traits >::open(),
redi::basic_opstream< CharT, Traits >::open(), redi::basic_pstream<
CharT, Traits >::open(), redi::basic_rpstream< CharT, Traits
>::open(), and 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, pmodemode) [inline], [protected], [inherited]¶
Start a process. Calls rdbuf()->open( file, argv, mode ) and sets failbit on error. Parameters: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.
See Also:
basic_pstreambuf::open(const std::string&, const
argv_type&, pmode)
template<typename CharT , typename Traits = std::char_traits<CharT>> basic_pstream& redi::basic_pstream< CharT, Traits >::err () [inline]¶
Set streambuf to read from process' stderr. Returns:*this
References redi::pstream_common< CharT, Traits >::buf_, and
redi::basic_pstreambuf< CharT, Traits >::read_err().
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:rdbuf()->is_open().
See Also:
basic_pstreambuf::is_open()
template<typename CharT , typename Traits = std::char_traits<CharT>> void redi::basic_pstream< CharT, Traits >::open (const std::string &command, pmodemode = pstdout|pstdin) [inline]¶
Start a process. Calls do_open( command , mode ). Parameters:command a string containing a shell command.
mode the I/O mode to use when opening the pipe.
See Also:
do_open(const std::string&, pmode)
References redi::pstream_common< CharT, Traits >::do_open().
template<typename CharT , typename Traits = std::char_traits<CharT>> void redi::basic_pstream< CharT, Traits >::open (const std::string &file, const argv_type &argv, pmodemode = pstdout| pstdin) [inline]¶
Start a process. Calls do_open( file , argv , mode ). Parameters: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.
See Also:
do_open(const std::string&, const argv_type&,
pmode)
References redi::pstream_common< CharT, Traits >::do_open().
template<typename CharT , typename Traits = std::char_traits<CharT>> basic_pstream& redi::basic_pstream< CharT, Traits >::out () [inline]¶
Set streambuf to read from process' stdout. Returns:*this
References redi::pstream_common< CharT, Traits >::buf_, and
redi::basic_pstreambuf< CharT, Traits >::read_err().
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:a pointer to the private stream buffer member.
Author¶
Generated automatically by Doxygen for PStreams from the source code.Sun Jan 12 2014 | PStreams |