.TH "redi::basic_pstream< CharT, Traits >" 3 "Sun Jan 12 2014" "PStreams" \" -*- nroff -*- .ad l .nh .SH NAME redi::basic_pstream< CharT, Traits > \- .PP Class template for Bidirectional PStreams\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits basic_iostream< CharT, Traits >, \fBredi::pstream_common< CharT, Traits >\fP, and \fBredi::pstreams\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "typedef pbase_type::pmode \fBpmode\fP" .br .RI "\fIType used to specify how to connect to the process\&. \fP" .ti -1c .RI "typedef pbase_type::argv_type \fBargv_type\fP" .br .RI "\fIType used to hold the arguments for a command\&. \fP" .ti -1c .RI "typedef int \fBfd_type\fP" .br .RI "\fIType used for file descriptors\&. \fP" .ti -1c .RI "typedef int \fBfd_type\fP" .br .RI "\fIType used for file descriptors\&. \fP" .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBbasic_pstream\fP ()" .br .RI "\fIDefault constructor, creates an uninitialised stream\&. \fP" .ti -1c .RI "\fBbasic_pstream\fP (const std::string &\fBcommand\fP, \fBpmode\fP mode=\fBpstdout\fP|\fBpstdin\fP)" .br .RI "\fIConstructor that initialises the stream by starting a process\&. \fP" .ti -1c .RI "\fBbasic_pstream\fP (const std::string &file, const \fBargv_type\fP &argv, \fBpmode\fP mode=\fBpstdout\fP|\fBpstdin\fP)" .br .RI "\fIConstructor that initialises the stream by starting a process\&. \fP" .ti -1c .RI "\fBbasic_pstream\fP (const \fBargv_type\fP &argv, \fBpmode\fP mode=\fBpstdout\fP|\fBpstdin\fP)" .br .RI "\fIConstructor that initialises the stream by starting a process\&. \fP" .ti -1c .RI "\fB~basic_pstream\fP ()" .br .RI "\fIDestructor\&. \fP" .ti -1c .RI "void \fBopen\fP (const std::string &\fBcommand\fP, \fBpmode\fP mode=\fBpstdout\fP|\fBpstdin\fP)" .br .RI "\fIStart a process\&. \fP" .ti -1c .RI "void \fBopen\fP (const std::string &file, const \fBargv_type\fP &argv, \fBpmode\fP mode=\fBpstdout\fP|\fBpstdin\fP)" .br .RI "\fIStart a process\&. \fP" .ti -1c .RI "\fBbasic_pstream\fP & \fBout\fP ()" .br .RI "\fISet streambuf to read from process' \fCstdout\fP\&. \fP" .ti -1c .RI "\fBbasic_pstream\fP & \fBerr\fP ()" .br .RI "\fISet streambuf to read from process' \fCstderr\fP\&. \fP" .ti -1c .RI "void \fBclose\fP ()" .br .RI "\fIClose the pipe\&. \fP" .ti -1c .RI "bool \fBis_open\fP () const " .br .RI "\fIReport whether the stream's buffer has been initialised\&. \fP" .ti -1c .RI "const std::string & \fBcommand\fP () const " .br .RI "\fIReturn the command used to initialise the stream\&. \fP" .ti -1c .RI "\fBstreambuf_type\fP * \fBrdbuf\fP () const " .br .RI "\fIReturn a pointer to the stream buffer\&. \fP" .in -1c .SS "Static Public Attributes" .in +1c .ti -1c .RI "static const \fBpmode\fP \fBpstdin\fP = std::ios_base::out" .br .RI "\fIWrite to stdin\&. \fP" .ti -1c .RI "static const \fBpmode\fP \fBpstdout\fP = std::ios_base::in" .br .RI "\fIRead from stdout\&. \fP" .ti -1c .RI "static const \fBpmode\fP \fBpstderr\fP = std::ios_base::app" .br .RI "\fIRead from stderr\&. \fP" .ti -1c .RI "static const \fBpmode\fP \fBpstdin\fP = std::ios_base::out" .br .RI "\fIWrite to stdin\&. \fP" .ti -1c .RI "static const \fBpmode\fP \fBpstdout\fP = std::ios_base::in" .br .RI "\fIRead from stdout\&. \fP" .ti -1c .RI "static const \fBpmode\fP \fBpstderr\fP = std::ios_base::app" .br .RI "\fIRead from stderr\&. \fP" .in -1c .SS "Protected Types" .in +1c .ti -1c .RI "typedef \fBbasic_pstreambuf\fP .br < CharT, Traits > \fBstreambuf_type\fP" .br .ti -1c .RI "enum { \fBbufsz\fP = 32 }" .br .ti -1c .RI "enum { \fBpbsz\fP = 2 }" .br .ti -1c .RI "enum { \fBbufsz\fP = 32 }" .br .ti -1c .RI "enum { \fBpbsz\fP = 2 }" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "void \fBdo_open\fP (const std::string &\fBcommand\fP, \fBpmode\fP mode)" .br .RI "\fIStart a process\&. \fP" .ti -1c .RI "void \fBdo_open\fP (const std::string &file, const \fBargv_type\fP &argv, \fBpmode\fP mode)" .br .RI "\fIStart a process\&. \fP" .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "std::string \fBcommand_\fP" .br .RI "\fIThe command used to start the process\&. \fP" .ti -1c .RI "\fBstreambuf_type\fP \fBbuf_\fP" .br .RI "\fIThe stream buffer\&. \fP" .in -1c .SH "Detailed Description" .PP .SS "template>class redi::basic_pstream< CharT, Traits >" Class template for Bidirectional PStreams\&. Writing to a pstream opened with \fCpmode\fP \fCpstdin\fP writes to the standard input of the command\&. Reading from a pstream opened with \fCpmode\fP \fCpstdout\fP and/or \fCpstderr\fP reads the command's standard output and/or standard error\&. Any of the process' \fCstdin\fP, \fCstdout\fP or \fCstderr\fP that is not connected to the pstream (as specified by the \fCpmode\fP) will be the same as the process that created the pstream object, unless altered by the command itself\&. .SH "Constructor & Destructor Documentation" .PP .SS "template> \fBredi::basic_pstream\fP< CharT, Traits >::\fBbasic_pstream\fP (const std::string &command, \fBpmode\fPmode = \fC\fBpstdout\fP|\fBpstdin\fP\fP)\fC [inline]\fP" .PP Constructor that initialises the stream by starting a process\&. Initialises the stream buffer by calling \fBdo_open()\fP with the supplied arguments\&. .PP \fBParameters:\fP .RS 4 \fIcommand\fP a string containing a shell command\&. .br \fImode\fP the I/O mode to use when opening the pipe\&. .RE .PP \fBSee Also:\fP .RS 4 \fBdo_open(const std::string&, pmode)\fP .RE .PP .SS "template> \fBredi::basic_pstream\fP< CharT, Traits >::\fBbasic_pstream\fP (const std::string &file, const \fBargv_type\fP &argv, \fBpmode\fPmode = \fC\fBpstdout\fP|\fBpstdin\fP\fP)\fC [inline]\fP" .PP Constructor that initialises the stream by starting a process\&. Initialises the stream buffer by calling \fBdo_open()\fP with the supplied arguments\&. .PP \fBParameters:\fP .RS 4 \fIfile\fP a string containing the pathname of a program to execute\&. .br \fIargv\fP a vector of argument strings passed to the new program\&. .br \fImode\fP the I/O mode to use when opening the pipe\&. .RE .PP \fBSee Also:\fP .RS 4 \fBdo_open(const std::string&, const argv_type&, pmode)\fP .RE .PP .SS "template> \fBredi::basic_pstream\fP< CharT, Traits >::\fBbasic_pstream\fP (const \fBargv_type\fP &argv, \fBpmode\fPmode = \fC\fBpstdout\fP|\fBpstdin\fP\fP)\fC [inline]\fP" .PP Constructor that initialises the stream by starting a process\&. Initialises the stream buffer by calling \fCdo_open(argv[0],argv,mode)\fP .PP \fBParameters:\fP .RS 4 \fIargv\fP a vector of argument strings passed to the new program\&. .br \fImode\fP the I/O mode to use when opening the pipe\&. .RE .PP \fBSee Also:\fP .RS 4 \fBdo_open(const std::string&, const argv_type&, pmode)\fP .RE .PP .SS "template> \fBredi::basic_pstream\fP< CharT, Traits >::~\fBbasic_pstream\fP ()\fC [inline]\fP" .PP Destructor\&. Closes the stream and waits for the child to exit\&. .SH "Member Function Documentation" .PP .SS "template void \fBredi::pstream_common\fP< C, T >::close ()\fC [inline]\fP, \fC [inherited]\fP" .PP Close the pipe\&. Calls rdbuf->\fBclose()\fP and sets \fCfailbit\fP on error\&. .SS "template const std::string & \fBredi::pstream_common\fP< C, T >::command () const\fC [inline]\fP, \fC [inherited]\fP" .PP Return the command used to initialise the stream\&. .PP \fBReturns:\fP .RS 4 a string containing the command used to initialise the stream\&. .RE .PP .SS "template void \fBredi::pstream_common\fP< C, T >::do_open (const std::string &command, \fBpmode\fPmode)\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Start a process\&. Calls \fBrdbuf()\fP->open( \fIcommand\fP , \fImode\fP ) and sets \fCfailbit\fP on error\&. .PP \fBParameters:\fP .RS 4 \fIcommand\fP a string containing a shell command\&. .br \fImode\fP the I/O mode to use when opening the pipe\&. .RE .PP \fBSee Also:\fP .RS 4 \fBbasic_pstreambuf::open(const std::string&, pmode)\fP .RE .PP .PP Referenced by redi::basic_ipstream< CharT, Traits >::open(), redi::basic_opstream< CharT, Traits >::open(), redi::basic_pstream< CharT, Traits >::open(), redi::basic_rpstream< CharT, Traits >::open(), and redi::pstream_common< CharT, Traits >::pstream_common()\&. .SS "template void \fBredi::pstream_common\fP< C, T >::do_open (const std::string &file, const \fBargv_type\fP &argv, \fBpmode\fPmode)\fC [inline]\fP, \fC [protected]\fP, \fC [inherited]\fP" .PP Start a process\&. Calls \fBrdbuf()\fP->open( \fIfile\fP, \fIargv\fP, \fImode\fP ) and sets \fCfailbit\fP on error\&. .PP \fBParameters:\fP .RS 4 \fIfile\fP a string containing the pathname of a program to execute\&. .br \fIargv\fP a vector of argument strings passed to the new program\&. .br \fImode\fP the I/O mode to use when opening the pipe\&. .RE .PP \fBSee Also:\fP .RS 4 \fBbasic_pstreambuf::open(const std::string&, const argv_type&, pmode)\fP .RE .PP .SS "template> \fBbasic_pstream\fP& \fBredi::basic_pstream\fP< CharT, Traits >::err ()\fC [inline]\fP" .PP Set streambuf to read from process' \fCstderr\fP\&. .PP \fBReturns:\fP .RS 4 \fC*this\fP .RE .PP .PP References redi::pstream_common< CharT, Traits >::buf_, and redi::basic_pstreambuf< CharT, Traits >::read_err()\&. .SS "template bool \fBredi::pstream_common\fP< C, T >::is_open () const\fC [inline]\fP, \fC [inherited]\fP" .PP Report whether the stream's buffer has been initialised\&. .PP \fBReturns:\fP .RS 4 \fBrdbuf()\fP->\fBis_open()\fP\&. .RE .PP \fBSee Also:\fP .RS 4 \fBbasic_pstreambuf::is_open()\fP .RE .PP .SS "template> void \fBredi::basic_pstream\fP< CharT, Traits >::open (const std::string &command, \fBpmode\fPmode = \fC\fBpstdout\fP|\fBpstdin\fP\fP)\fC [inline]\fP" .PP Start a process\&. Calls do_open( \fIcommand\fP , \fImode\fP )\&. .PP \fBParameters:\fP .RS 4 \fIcommand\fP a string containing a shell command\&. .br \fImode\fP the I/O mode to use when opening the pipe\&. .RE .PP \fBSee Also:\fP .RS 4 \fBdo_open(const std::string&, pmode)\fP .RE .PP .PP References redi::pstream_common< CharT, Traits >::do_open()\&. .SS "template> void \fBredi::basic_pstream\fP< CharT, Traits >::open (const std::string &file, const \fBargv_type\fP &argv, \fBpmode\fPmode = \fC\fBpstdout\fP|\fBpstdin\fP\fP)\fC [inline]\fP" .PP Start a process\&. Calls do_open( \fIfile\fP , \fIargv\fP , \fImode\fP )\&. .PP \fBParameters:\fP .RS 4 \fIfile\fP a string containing the pathname of a program to execute\&. .br \fIargv\fP a vector of argument strings passed to the new program\&. .br \fImode\fP the I/O mode to use when opening the pipe\&. .RE .PP \fBSee Also:\fP .RS 4 \fBdo_open(const std::string&, const argv_type&, pmode)\fP .RE .PP .PP References redi::pstream_common< CharT, Traits >::do_open()\&. .SS "template> \fBbasic_pstream\fP& \fBredi::basic_pstream\fP< CharT, Traits >::out ()\fC [inline]\fP" .PP Set streambuf to read from process' \fCstdout\fP\&. .PP \fBReturns:\fP .RS 4 \fC*this\fP .RE .PP .PP References redi::pstream_common< CharT, Traits >::buf_, and redi::basic_pstreambuf< CharT, Traits >::read_err()\&. .SS "template \fBpstream_common\fP< C, T >::\fBstreambuf_type\fP * \fBredi::pstream_common\fP< C, T >::rdbuf () const\fC [inline]\fP, \fC [inherited]\fP" .PP Return a pointer to the stream buffer\&. .PP \fBReturns:\fP .RS 4 a pointer to the private stream buffer member\&. .RE .PP .SH "Author" .PP Generated automatically by Doxygen for PStreams from the source code\&.