NAME¶

redi::basic_ipstream - Class template for Input PStreams.

SYNOPSIS¶

#include <pstream.h> Inherits 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_ipstream () Default constructor, creates an uninitialised stream. basic_ipstream (const std::string &command, pmode mode=pstdout) Constructor that initialises the stream by starting a process. basic_ipstream (const std::string &file, const argv_type &argv, pmode mode=pstdout) Constructor that initialises the stream by starting a process. ~basic_ipstream () Destructor. void open (const std::string &command, pmode mode= pstdout) Start a process. void open (const std::string &file, const argv_type &argv, pmode mode=pstdout) Start a process. basic_ipstream & out () Set streambuf to read from process' stdout. basic_ipstream & err () Set streambuf to read from process' stderr. 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 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.

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 &command, 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.

Detailed Description¶

template<typename CharT, typename Traits = std::char_traits<CharT>>class redi::basic_ipstream< CharT, Traits >¶

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.

Constructor & Destructor Documentation¶

template<typename CharT , typename Traits = std::char_traits<CharT>> redi::basic_ipstream< CharT, Traits >:: basic_ipstream (const std::string &command, pmodemode = pstdout) [inline]¶

Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open() with the supplied arguments. Parameters: See also:

template<typename CharT , typename Traits = std::char_traits<CharT>> redi::basic_ipstream< CharT, Traits >:: basic_ipstream (const std::string &file, const argv_type &argv, pmodemode = pstdout) [inline]¶

Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open() with the supplied arguments. Parameters: See also:

template<typename CharT , typename Traits = std::char_traits<CharT>> redi::basic_ipstream< CharT, Traits >::~ basic_ipstream () [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:

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: See also: Referenced by redi::basic_rpstream< CharT, Traits >::open(), redi::basic_pstream< CharT, Traits >::open(), redi::basic_opstream< CharT, Traits >::open(), redi::basic_ipstream< 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: See also:

template<typename CharT , typename Traits = std::char_traits<CharT>> basic_ipstream& redi::basic_ipstream< CharT, Traits >::err () [inline]¶

Set streambuf to read from process' stderr. Returns: 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: See also:

template<typename CharT , typename Traits = std::char_traits<CharT>> void redi::basic_ipstream< CharT, Traits >::open (const std::string &command, pmodemode = pstdout ) [inline]¶

Start a process. Calls do_open( command , mode|pstdout ). Parameters: See also: References redi::pstream_common< CharT, Traits >::do_open().

template<typename CharT , typename Traits = std::char_traits<CharT>> void redi::basic_ipstream< CharT, Traits >::open (const std::string &file, const argv_type &argv, pmodemode = pstdout) [inline]¶

Start a process. Calls do_open( file , argv , mode|pstdout ). Parameters: See also: References redi::pstream_common< CharT, Traits >::do_open().

template<typename CharT , typename Traits = std::char_traits<CharT>> basic_ipstream& redi::basic_ipstream< CharT, Traits >::out () [inline]¶

Set streambuf to read from process' stdout. Returns: 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:

Author¶

Generated automatically by Doxygen for PStreams from the source code.