Streamable pipe socket connection.
More...
#include <stream.h>
|
enum | access_t { RDONLY
, WRONLY
, RDWR
} |
|
|
void | cancel (void) |
|
int | close (void) |
| Close an active stream connection.
|
|
void | open (const char *path, access_t access, char **args, char **env=NULL, size_t buffering=512) |
| Open a stream connection to a pipe service.
|
|
| operator bool () const |
| See if stream connection is active.
|
|
bool | operator! () const |
| See if stream is disconnected.
|
|
| pipestream () |
| Create an unopened pipe stream.
|
|
| pipestream (const char *command, access_t access, char **args, char **env=NULL, size_t size=512) |
| Create child process and start pipe.
|
|
void | terminate (void) |
| Force terminate child and close.
|
|
virtual | ~pipestream () |
| Destroy a pipe stream.
|
|
bool | is_open (void) const |
|
| operator bool () const |
|
bool | operator! () const |
|
int | sync (void) |
| Flush the stream input and output buffers, writes pending output.
|
|
|
int | overflow (int ch) |
| This streambuf method is used to write the output buffer through the established pipe connection.
|
|
void | release (void) |
| Release the stream, detach/do not wait for the process.
|
|
int | underflow (void) |
| This streambuf method is used to load the input buffer through the established pipe connection.
|
|
void | allocate (size_t size) |
|
void | release (void) |
|
int | uflow () |
| This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode.
|
|
Streamable pipe socket connection.
This creates a stream between a parent and child process. As a stream class, data can be exchanged using the << and >> operators.
- Author
- David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org
Definition at line 237 of file stream.h.
◆ access_t
enum ucommon::pipestream::access_t |
◆ pipestream()
ucommon::pipestream::pipestream |
( |
const char * | command, |
|
|
access_t | access, |
|
|
char ** | args, |
|
|
char ** | env = NULL, |
|
|
size_t | size = 512 ) |
Create child process and start pipe.
- Parameters
-
path | to execute. |
access | mode of pipe stream. |
args | to pass to command. |
env | to create in child. |
size | of buffer. |
◆ cancel()
void ucommon::pipestream::cancel |
( |
void | | ) |
|
|
inline |
◆ close()
int ucommon::pipestream::close |
( |
void | | ) |
|
Close an active stream connection.
This waits for the child to terminate.
◆ open()
void ucommon::pipestream::open |
( |
const char * | path, |
|
|
access_t | access, |
|
|
char ** | args, |
|
|
char ** | env = NULL, |
|
|
size_t | buffering = 512 ) |
Open a stream connection to a pipe service.
- Parameters
-
path | to execute. |
access | mode of stream. |
args | to pass to command. |
env | to create in child process. |
buffering | size to use. |
◆ operator bool()
ucommon::pipestream::operator bool |
( |
| ) |
const |
|
inline |
See if stream connection is active.
- Returns
- true if stream is active.
Definition at line 302 of file stream.h.
◆ operator!()
bool ucommon::pipestream::operator! |
( |
| ) |
const |
|
inline |
See if stream is disconnected.
- Returns
- true if stream disconnected.
Definition at line 310 of file stream.h.
◆ overflow()
int ucommon::pipestream::overflow |
( |
int | ch | ) |
|
|
protected |
This streambuf method is used to write the output buffer through the established pipe connection.
- Parameters
-
- Returns
- char pushed through.
◆ underflow()
int ucommon::pipestream::underflow |
( |
void | | ) |
|
|
protected |
This streambuf method is used to load the input buffer through the established pipe connection.
- Returns
- char from get buffer, EOF if not connected.
◆ pid
◆ rd
fsys_t ucommon::pipestream::rd |
|
protected |
◆ wr
fsys_t ucommon::pipestream::wr |
|
protected |
The documentation for this class was generated from the following file:
- /builddir/build/BUILD/ucommon-7.0.0-build/ucommon-7.0.0/inc/ucommon/stream.h