PStreams
Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
redi::basic_pstream< CharT, Traits > Class Template Reference

Class template for Bidirectional PStreams. More...

#include <pstream.h>

Inheritance diagram for redi::basic_pstream< CharT, Traits >:
redi::pstream_common< CharT, Traits > redi::pstreams 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_pstream ()
 Default constructor, creates an uninitialised stream.
 
 basic_pstream (const std::string &cmd, pmode mode=pstdout|pstdin)
 Constructor that initialises the stream by starting a process. More...
 
 basic_pstream (const std::string &file, const argv_type &argv, pmode mode=pstdout|pstdin)
 Constructor that initialises the stream by starting a process. More...
 
 basic_pstream (const argv_type &argv, pmode mode=pstdout|pstdin)
 Constructor that initialises the stream by starting a process. More...
 
 ~basic_pstream ()
 Destructor. More...
 
void open (const std::string &cmd, pmode mode=pstdout|pstdin)
 Start a process. More...
 
void open (const std::string &file, const argv_type &argv, pmode mode=pstdout|pstdin)
 Start a process. More...
 
basic_pstreamout ()
 Set streambuf to read from process' stdout. More...
 
basic_pstreamerr ()
 Set streambuf to read from process' stderr. More...
 
void close ()
 Close the pipe. More...
 
bool is_open () const
 Report whether the stream's buffer has been initialised. More...
 
const std::string & command () const
 Return the command used to initialise the stream. More...
 
streambuf_typerdbuf () const
 Return a pointer to the stream buffer. More...
 

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, Traits > streambuf_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. More...
 
void do_open (const std::string &file, const argv_type &argv, pmode mode)
 Start a process. More...
 

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_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 &  cmd,
pmode  mode = pstdout|pstdin 
)
inlineexplicit

Constructor that initialises the stream by starting a process.

Initialises the stream buffer by calling do_open() with the supplied arguments.

Parameters
cmda string containing a shell command.
modethe 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,
pmode  mode = 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
filea string containing the pathname of a program to execute.
argva vector of argument strings passed to the new program.
modethe 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,
pmode  mode = pstdout|pstdin 
)
inlineexplicit

Constructor that initialises the stream by starting a process.

Initialises the stream buffer by calling do_open(argv[0],argv,mode)

Parameters
argva vector of argument strings passed to the new program.
modethe I/O mode to use when opening the pipe.
See also
do_open(const std::string&, const argv_type&, pmode)

References redi::pstreams::pstdin, and redi::pstreams::pstdout.

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

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

template<typename C , typename T >
const std::string & redi::pstream_common< C, T >::command ( ) const
inlineinherited

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

Start a process.

Calls rdbuf()->open( command , mode ) and sets failbit on error.

Parameters
cmda string containing a shell command.
modethe 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 
)
inlineprotectedinherited

Start a process.

Calls rdbuf()->open( file, argv, mode ) and sets failbit on error.

Parameters
filea string containing the pathname of a program to execute.
argva vector of argument strings passed to the new program.
modethe 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_pstream& redi::basic_pstream< 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
inlineinherited

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

Start a process.

Calls do_open( cnd , mode ).

Parameters
cmda string containing a shell command.
modethe 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_pstream< CharT, Traits >::open ( const std::string &  file,
const argv_type argv,
pmode  mode = pstdout|pstdin 
)
inline

Start a process.

Calls do_open( file , argv , mode ).

Parameters
filea string containing the pathname of a program to execute.
argva vector of argument strings passed to the new program.
modethe 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_pstream& redi::basic_pstream< 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
inlineinherited

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.


The documentation for this class was generated from the following file: