.TH "redi::basic_rpstream< CharT, Traits >" 3 "Sat Jul 21 2018" "PStreams" \" -*- nroff -*- .ad l .nh .SH NAME redi::basic_rpstream< CharT, Traits > \- Class template for Restricted PStreams\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits basic_ostream< CharT, Traits >, basic_istream< 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 "Type used to specify how to connect to the process\&. " .ti -1c .RI "typedef pbase_type::argv_type \fBargv_type\fP" .br .RI "Type used to hold the arguments for a command\&. " .ti -1c .RI "typedef int \fBfd_type\fP" .br .RI "Type used for file descriptors\&. " .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBbasic_rpstream\fP ()" .br .RI "Default constructor, creates an uninitialised stream\&. " .ti -1c .RI "\fBbasic_rpstream\fP (const std::string &cmd, \fBpmode\fP mode=\fBpstdout\fP|\fBpstdin\fP)" .br .RI "Constructor that initialises the stream by starting a process\&. " .ti -1c .RI "\fBbasic_rpstream\fP (const std::string &file, const \fBargv_type\fP &argv, \fBpmode\fP mode=\fBpstdout\fP|\fBpstdin\fP)" .br .RI "Constructor that initialises the stream by starting a process\&. " .ti -1c .RI "\fBbasic_rpstream\fP (const \fBargv_type\fP &argv, \fBpmode\fP mode=\fBpstdout\fP|\fBpstdin\fP)" .br .RI "Constructor that initialises the stream by starting a process\&. " .ti -1c .RI "\fB~basic_rpstream\fP ()" .br .RI "Destructor\&. " .ti -1c .RI "void \fBopen\fP (const std::string &cmd, \fBpmode\fP mode=\fBpstdout\fP|\fBpstdin\fP)" .br .RI "Start a process\&. " .ti -1c .RI "void \fBopen\fP (const std::string &file, const \fBargv_type\fP &argv, \fBpmode\fP mode=\fBpstdout\fP|\fBpstdin\fP)" .br .RI "Start a process\&. " .ti -1c .RI "istream_type & \fBout\fP ()" .br .RI "Obtain a reference to the istream that reads the process' \fCstdout\fP\&. " .ti -1c .RI "istream_type & \fBerr\fP ()" .br .RI "Obtain a reference to the istream that reads the process' \fCstderr\fP\&. " .in -1c .SS "Static Public Attributes" .in +1c .ti -1c .RI "static const \fBpmode\fP \fBpstdin\fP = std::ios_base::out" .br .RI "Write to stdin\&. " .ti -1c .RI "static const \fBpmode\fP \fBpstdout\fP = std::ios_base::in" .br .RI "Read from stdout\&. " .ti -1c .RI "static const \fBpmode\fP \fBpstderr\fP = std::ios_base::app" .br .RI "Read from stderr\&. " .ti -1c .RI "static const \fBpmode\fP \fBnewpg\fP = std::ios_base::trunc" .br .RI "Create a new process group for the child process\&. " .in -1c .SS "Protected Types" .in +1c .ti -1c .RI "enum { \fBbufsz\fP = 32 }" .br .ti -1c .RI "enum { \fBpbsz\fP = 2 }" .br .in -1c .SS "Private Types" .in +1c .ti -1c .RI "typedef \fBbasic_pstreambuf\fP< 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 "typedef int \fBfd_type\fP" .br .RI "Type used for file descriptors\&. " .in -1c .SS "Private Member Functions" .in +1c .ti -1c .RI "void \fBdo_open\fP (const std::string &cmd, \fBpmode\fP mode)" .br .RI "Start a process\&. " .ti -1c .RI "void \fBdo_open\fP (const std::string &file, const \fBargv_type\fP &argv, \fBpmode\fP mode)" .br .RI "Start a process\&. " .ti -1c .RI "void \fBclose\fP ()" .br .RI "Close the pipe\&. " .ti -1c .RI "bool \fBis_open\fP () const" .br .RI "Report whether the stream's buffer has been initialised\&. " .ti -1c .RI "const std::string & \fBcommand\fP () const" .br .RI "Return the command used to initialise the stream\&. " .ti -1c .RI "\fBstreambuf_type\fP * \fBrdbuf\fP () const" .br .RI "Return a pointer to the stream buffer\&. " .in -1c .SS "Private Attributes" .in +1c .ti -1c .RI "std::string \fBcommand_\fP" .br .RI "The command used to start the process\&. " .ti -1c .RI "\fBstreambuf_type\fP \fBbuf_\fP" .br .RI "The stream buffer\&. " .in -1c .SS "Static Private Attributes" .in +1c .ti -1c .RI "static const \fBpmode\fP \fBpstdin\fP = std::ios_base::out" .br .RI "Write to stdin\&. " .ti -1c .RI "static const \fBpmode\fP \fBpstdout\fP = std::ios_base::in" .br .RI "Read from stdout\&. " .ti -1c .RI "static const \fBpmode\fP \fBpstderr\fP = std::ios_base::app" .br .RI "Read from stderr\&. " .ti -1c .RI "static const \fBpmode\fP \fBnewpg\fP = std::ios_base::trunc" .br .RI "Create a new process group for the child process\&. " .in -1c .SH "Detailed Description" .PP .SS "template> .br class redi::basic_rpstream< CharT, Traits >" Class template for Restricted PStreams\&. Writing to an rpstream opened with \fCpmode\fP \fCpstdin\fP writes to the standard input of the command\&. It is not possible to read directly from an rpstream object, to use an rpstream as in istream you must call either \fBbasic_rpstream::out()\fP or \fBbasic_rpstream::err()\fP\&. This is to prevent accidental reads from the wrong input source\&. If the rpstream was not opened with \fCpmode\fP \fCpstderr\fP then the class cannot read the process' \fCstderr\fP, and \fBbasic_rpstream::err()\fP will return an istream that reads from the process' \fCstdout\fP, and vice versa\&. Reading from an rpstream 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_rpstream\fP< CharT, Traits >::\fBbasic_rpstream\fP (const std::string & cmd, \fBpmode\fP mode = \fC\fBpstdout\fP|\fBpstdin\fP\fP)\fC [inline]\fP, \fC [explicit]\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 \fIcmd\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_rpstream\fP< CharT, Traits >::\fBbasic_rpstream\fP (const std::string & file, const \fBargv_type\fP & argv, \fBpmode\fP mode = \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_rpstream\fP< CharT, Traits >::\fBbasic_rpstream\fP (const \fBargv_type\fP & argv, \fBpmode\fP mode = \fC\fBpstdout\fP|\fBpstdin\fP\fP)\fC [inline]\fP, \fC [explicit]\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 .PP References redi::pstreams::pstdin, and redi::pstreams::pstdout\&. .SH "Member Function Documentation" .PP .SS "template> istream_type& \fBredi::basic_rpstream\fP< CharT, Traits >::err ()\fC [inline]\fP" .PP Obtain a reference to the istream that reads the process' \fCstderr\fP\&. .PP \fBReturns:\fP .RS 4 \fC*this\fP .RE .PP .SS "template> void \fBredi::basic_rpstream\fP< CharT, Traits >::open (const std::string & cmd, \fBpmode\fP mode = \fC\fBpstdout\fP|\fBpstdin\fP\fP)\fC [inline]\fP" .PP Start a process\&. Calls do_open( \fIcmd\fP , \fImode\fP )\&. .PP \fBParameters:\fP .RS 4 \fIcmd\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> void \fBredi::basic_rpstream\fP< CharT, Traits >::open (const std::string & file, const \fBargv_type\fP & argv, \fBpmode\fP mode = \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 .SS "template> istream_type& \fBredi::basic_rpstream\fP< CharT, Traits >::out ()\fC [inline]\fP" .PP Obtain a reference to the istream that reads the process' \fCstdout\fP\&. .PP \fBReturns:\fP .RS 4 \fC*this\fP .RE .PP .SH "Author" .PP Generated automatically by Doxygen for PStreams from the source code\&.