.TH "redi::basic_pstream< CharT, Traits >" 3 "Sun Dec 13 2020" "PStreams" \" -*- nroff -*-
.ad l
.nh
.SH NAME
redi::basic_pstream \- Class template for Bidirectional PStreams

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <pstream\&.h>\fP
.PP
Inherits basic_iostream< CharT, std::char_traits< CharT > >, \fBredi::pstream_common< CharT, std::char_traits< CharT > >\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\&. "
.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_pstream\fP ()"
.br
.RI "Default constructor, creates an uninitialised stream\&. "
.ti -1c
.RI "\fBbasic_pstream\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_pstream\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_pstream\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_pstream\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 "\fBbasic_pstream\fP & \fBout\fP ()"
.br
.RI "Set streambuf to read from process' \fCstdout\fP\&. "
.ti -1c
.RI "\fBbasic_pstream\fP & \fBerr\fP ()"
.br
.RI "Set streambuf to read from process' \fCstderr\fP\&. "
.ti -1c
.RI "int \fBclose\fP ()"
.br
.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 "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\&. "
.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 "typedef \fBbasic_pstreambuf\fP< CharT, std::char_traits< CharT > > \fBstreambuf_type\fP"
.br
.ti -1c
.RI "typedef std::basic_ios< CharT, std::char_traits< CharT > > \fBios_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 &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\&. "
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "std::string \fBcommand_\fP"
.br
.RI "The command used to start the process\&. "
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<typename CharT, typename Traits = std::char_traits<CharT>>
.br
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<typename CharT , typename Traits  = std::char_traits<CharT>> \fBredi::basic_pstream\fP< CharT, Traits >::\fBbasic_pstream\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<typename CharT , typename Traits  = std::char_traits<CharT>> \fBredi::basic_pstream\fP< CharT, Traits >::\fBbasic_pstream\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<typename CharT , typename Traits  = std::char_traits<CharT>> \fBredi::basic_pstream\fP< CharT, Traits >::\fBbasic_pstream\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

.SS "template<typename CharT , typename Traits  = std::char_traits<CharT>> \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 "int \fBredi::pstream_common\fP< C, T >::close\fC [inline]\fP, \fC [inherited]\fP"
Close the pipe, returning the program's exit status, as pclose(3) does\&.
.PP
Calls rdbuf->\fBclose()\fP and sets \fCfailbit\fP on error\&. Returns process's exit status, as pclose(3) does\&. 
.SS "const std::string & \fBredi::pstream_common\fP< C, T >::command\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 "void \fBredi::pstream_common\fP< C, T >::do_open (const std::string & cmd, \fBpmode\fP mode)\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
\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
\fBbasic_pstreambuf::open(const std::string&, pmode)\fP 
.RE
.PP

.SS "void \fBredi::pstream_common\fP< C, T >::do_open (const std::string & file, const \fBargv_type\fP & argv, \fBpmode\fP mode)\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<typename CharT , typename Traits  = std::char_traits<CharT>> \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::basic_pstreambuf< CharT, Traits >::read_err()\&.
.SS "bool \fBredi::pstream_common\fP< C, T >::is_open\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<typename CharT , typename Traits  = std::char_traits<CharT>> void \fBredi::basic_pstream\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( \fIcnd\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

.PP
References redi::pstream_common< CharT, std::char_traits< CharT > >::do_open()\&.
.SS "template<typename CharT , typename Traits  = std::char_traits<CharT>> void \fBredi::basic_pstream\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

.PP
References redi::pstream_common< CharT, std::char_traits< CharT > >::do_open()\&.
.SS "template<typename CharT , typename Traits  = std::char_traits<CharT>> \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::basic_pstreambuf< CharT, Traits >::read_err()\&.
.SS "\fBpstream_common\fP< C, T >::\fBstreambuf_type\fP * \fBredi::pstream_common\fP< C, T >::rdbuf\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\&.