redi::basic_ipstream< CharT, Traits >(3) | Library Functions Manual | redi::basic_ipstream< CharT, Traits >(3) |
NAME¶
redi::basic_ipstream - Class template for Input PStreams
SYNOPSIS¶
#include <pstream.h>
Inherits basic_istream< CharT, std::char_traits< CharT > >, redi::pstream_common< CharT, std::char_traits< CharT > >, 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 &cmd, 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 (const argv_type &argv, pmode
mode=pstdout)
Constructor that initialises the stream by starting a process.
~basic_ipstream ()
Destructor. void open (const std::string &cmd, 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. int close ()
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, std::char_traits<
CharT > > streambuf_type
typedef std::basic_ios< CharT, std::char_traits< CharT > >
ios_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.
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 & cmd, pmode mode = pstdout) [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_ipstream< CharT, Traits >::basic_ipstream (const std::string & file, const argv_type & argv, pmode mode = pstdout) [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_ipstream< CharT, Traits >::basic_ipstream (const argv_type & argv, pmode mode = pstdout) [inline], [explicit]¶
Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do_open(argv[0],argv,mode|pstdout)
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_ipstream< CharT, Traits >::~basic_ipstream () [inline]¶
Destructor. Closes the stream and waits for the child to exit.
Member Function Documentation¶
int redi::pstream_common< C, T >::close [inline], [inherited]¶
Close the pipe, returning the program's exit status, as pclose(3) does.
Calls rdbuf->close() and sets failbit on error. Returns process's exit status, as pclose(3) does.
const std::string & redi::pstream_common< C, T >::command [inline], [inherited]¶
Return the command used to initialise the stream.
Returns
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
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
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::basic_pstreambuf< CharT, Traits >::read_err().
bool redi::pstream_common< C, T >::is_open [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 & cmd, pmode mode = pstdout) [inline]¶
Start a process. Calls do_open( cmd , mode|pstdout ).
Parameters
mode the I/O mode to use when opening the pipe.
See also
References redi::pstream_common< CharT, std::char_traits< CharT > >::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, pmode mode = pstdout) [inline]¶
Start a process. Calls do_open( file , argv , mode|pstdout ).
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, std::char_traits< CharT > >::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::basic_pstreambuf< CharT, Traits >::read_err().
pstream_common< C, T >::streambuf_type * redi::pstream_common< C, T >::rdbuf [inline], [inherited]¶
Return a pointer to the stream buffer.
Returns
Author¶
Generated automatically by Doxygen for PStreams from the source code.
Sun Dec 13 2020 | PStreams |