Poster of Linux kernelThe best gift for a Linux geek
redi::basic_ipstream

redi::basic_ipstream

Section: C Library Functions (3) Updated: 25 Oct 2005
Local index Up
 

NAME

redi::basic_ipstream - Class template for Input PStreams.

 

SYNOPSIS


#include <pstream.h>

Inherits redi::pstream_common< CharT, Traits >< 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, 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:

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_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 () [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 & 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)

 

template<typename C, typename T> void redi::pstream_common< C, T >::do_open (const std::string & command, pmode mode) [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)

 

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

 

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_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>> void redi::basic_ipstream< CharT, Traits >::open (const std::string & command, pmode mode = pstdout) [inline]

Start a process.

Calls do_open( command , mode|pstdout ).

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

Set streambuf to read from process' stdout.

Returns:

*this

 

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.


 

Index

NAME
SYNOPSIS
Public Types
Public Member Functions
Static Public Attributes
Protected Types
Protected Member Functions
Protected Attributes
Detailed Description
template<typename CharT, typename Traits = std::char_traits<CharT>> class redi::basic_ipstream< CharT, Traits >
Constructor & Destructor Documentation
template<typename CharT, typename Traits = std::char_traits<CharT>> redi::basic_ipstream< CharT, Traits >::basic_ipstream (const std::string & command, pmode mode = pstdout) [inline]
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]
template<typename CharT, typename Traits = std::char_traits<CharT>> redi::basic_ipstream< CharT, Traits >::~basic_ipstream () [inline]
Member Function Documentation
template<typename C, typename T> void redi::pstream_common< C, T >::close () [inline, inherited]
template<typename C, typename T> const std::string & redi::pstream_common< C, T >::command () const [inline, inherited]
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]
template<typename C, typename T> void redi::pstream_common< C, T >::do_open (const std::string & command, pmode mode) [inline, protected, inherited]
template<typename CharT, typename Traits = std::char_traits<CharT>> basic_ipstream& redi::basic_ipstream< CharT, Traits >::err () [inline]
template<typename C, typename T> bool redi::pstream_common< C, T >::is_open () const [inline, inherited]
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]
template<typename CharT, typename Traits = std::char_traits<CharT>> void redi::basic_ipstream< CharT, Traits >::open (const std::string & command, pmode mode = pstdout) [inline]
template<typename CharT, typename Traits = std::char_traits<CharT>> basic_ipstream& redi::basic_ipstream< CharT, Traits >::out () [inline]
template<typename C, typename T> pstream_common< C, T >::streambuf_type * redi::pstream_common< C, T >::rdbuf () const [inline, inherited]
Author

This document was created by man2html, using the manual pages.
Time: 21:53:58 GMT, April 16, 2011