DOKK / manpages / debian 10 / libpstreams-dev / redi_basic_ipstream.3.en
redi::basic_ipstream< CharT, Traits >(3) Library Functions Manual redi::basic_ipstream< CharT, Traits >(3)

redi::basic_ipstream< CharT, Traits > - Class template for Input PStreams.

#include <pstream.h>

Inherits basic_istream< 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_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. 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.

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.

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:

cmd 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_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:

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_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:

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::pstreams::pstdout.

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.

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().

Return the command used to initialise the stream.

Returns:

a string containing the command used to initialise the stream.

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:

cmd 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)

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:

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)

References redi::pstream_common< CharT, Traits >::buf_, redi::pstream_common< CharT, Traits >::command_, and redi::basic_pstreambuf< CharT, Traits >::open().

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:

*this

Report whether the stream's buffer has been initialised.

Returns:

rdbuf()->is_open().

See also:

basic_pstreambuf::is_open()

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_ipstream< CharT, Traits >::open (const std::string & cmd, pmode mode = pstdout) [inline]

Start a process. Calls do_open( cmd , mode|pstdout ).

Parameters:

cmd 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>> 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:

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>> basic_ipstream& redi::basic_ipstream< CharT, Traits >::out () [inline]

Set streambuf to read from process' stdout.

Returns:

*this

Return a pointer to the stream buffer.

Returns:

a pointer to the private stream buffer member.

References redi::pstream_common< CharT, Traits >::buf_, redi::pstreams::pstderr, redi::pstreams::pstdin, and redi::pstreams::pstdout.

Generated automatically by Doxygen for PStreams from the source code.

Sat Jul 21 2018 PStreams