--- name: "redi_pstream_common" section: "3" platform: "linux" package: "libpstreams-dev" version: "1.0.3-1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/redi_pstream_common" --- # redi\_pstream\_common(3) Class template for common base class ## NAME redi::pstream\_common - Class template for common base class ## SYNOPSIS `#include ` Inherits basic\_ios\< CharT, std::char\_traits\< CharT \> \>, and **redi::pstreams**. ### Public Types typedef int **fd\_type**\ Type used for file descriptors. ### Public Member Functions int **close** ()\ 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** **newpg** = std::ios\_base::trunc\ Create a new process group for the child process. ### Protected Types typedef **basic\_pstreambuf**\< CharT, Traits \> **streambuf\_type**\ typedef std::basic\_ios\< CharT, Traits \> **ios\_type**\ typedef **pstreams::pmode** **pmode**\ typedef **pstreams::argv\_type** **argv\_type**\ enum { **bufsz** = 32 }\ enum { **pbsz** = 2 }\ ### Protected Member Functions **pstream\_common** ()\ Default constructor. **pstream\_common** (const std::string &cmd, **pmode** mode)\ Constructor that initialises the stream by starting a process. **pstream\_common** (const std::string &file, const **argv\_type** &argv, **pmode** mode)\ Constructor that initialises the stream by starting a process. virtual **~pstream\_common** ()=0\ Pure virtual destructor. void **do\_open** (const std::string &cmd, **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\\> class redi::pstream\_common\< CharT, Traits \>" Class template for common base class. Abstract Base Class providing common functionality for **basic\_ipstream**, **basic\_opstream** and **basic\_pstream**. **pstream\_common** manages the **basic\_pstreambuf** stream buffer that is used by the derived classes to initialise an iostream class. ## Constructor & Destructor Documentation ### template\ redi::pstream\_common\< C, T \>::pstream\_common` [inline]`, ` [protected]` Default constructor. Creates an uninitialised stream. References redi::pstream\_common\< CharT, Traits \>::buf\_. ### template\ redi::pstream\_common\< C, T \>::pstream\_common (const std::string & cmd, pmode mode)` [inline]`, ` [protected]` Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do\_open( *command* , *mode* ) **Parameters** *cmd* 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)** References redi::pstream\_common\< CharT, Traits \>::buf\_, and redi::pstream\_common\< CharT, Traits \>::do\_open(). ### template\ redi::pstream\_common\< C, T \>::pstream\_common (const std::string & file, const argv\_type & argv, pmode mode)` [inline]`, ` [protected]` Constructor that initialises the stream by starting a process. Initialises the stream buffer by calling do\_open( *file* , *argv* , *mode* ) **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)** References redi::pstream\_common\< CharT, Traits \>::buf\_, and redi::pstream\_common\< CharT, Traits \>::do\_open(). ### template\ redi::pstream\_common\< C, T \>::~pstream\_common` [inline]`, ` [protected]`, ` [pure virtual]` Pure virtual destructor. This is a pure virtual function to make **pstream\_common abstract. Because it is the destructor it will be called by derived classes and so must be defined. It is also protected, to discourage use of the PStreams classes through pointers or references to the base class.** **See also** **If defining a pure virtual seems odd you should read http://www.gotw.ca/gotw/031.htm (and the rest of the site as well!)** ## Member Function Documentation ### template\ int redi::pstream\_common\< C, T \>::close` [inline]` **Close the pipe, returning the program's exit status, as [pclose(3)](/pclose/3.md) does.** **Calls rdbuf-\>close() and sets** `failbit` **on error. Returns process's exit status, as [pclose(3)](/pclose/3.md) does.** ### template\ const std::string & redi::pstream\_common\< C, T \>::command` [inline]` **Return the command used to initialise the stream.** **Returns** **a string containing the command used to initialise the stream.** ### template\ void redi::pstream\_common\< C, T \>::do\_open (const std::string & cmd, pmode mode)` [inline]`, ` [protected]` **Start a process. Calls rdbuf()-\>open(** *command* **,** *mode* **) and sets** `failbit` **on error.** **Parameters** *cmd* **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)** **Referenced by redi::pstream\_common\< CharT, Traits \>::pstream\_common().** ### template\ void redi::pstream\_common\< C, T \>::do\_open (const std::string & file, const argv\_type & argv, pmode mode)` [inline]`, ` [protected]` **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\ bool redi::pstream\_common\< C, T \>::is\_open` [inline]` **Report whether the stream's buffer has been initialised.** **Returns** **rdbuf()-\>is\_open().** **See also** **basic\_pstreambuf::is\_open()** ### template\ pstream\_common\< C, T \>::streambuf\_type \* redi::pstream\_common\< C, T \>::rdbuf` [inline]` **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.**