Sane C++ Libraries
C++ Platform Abstraction Libraries
Loading...
Searching...
No Matches
SC::PipeDescriptor Struct Reference

Read / Write pipe (Process stdin/stdout and IPC communication) More...

#include <File.h>

Public Member Functions

Result createPipe (PipeOptions options={})
 Creates a Pipe.
 
Result close ()
 Closes the pipe.
 

Public Attributes

FileDescriptor readPipe
 The read side of the pipe.
 
FileDescriptor writePipe
 The write side of the pipe.
 

Detailed Description

Read / Write pipe (Process stdin/stdout and IPC communication)

Member Function Documentation

◆ close()

Result SC::PipeDescriptor::close ( )

Closes the pipe.

Returns
Valid Result if pipe destruction succeeded

◆ createPipe()

Result SC::PipeDescriptor::createPipe ( PipeOptions options = {})

Creates a Pipe.

File descriptors are created as blocking and non-inheritable

Returns
Valid Result if pipe creation succeeded

Member Data Documentation

◆ readPipe

FileDescriptor SC::PipeDescriptor::readPipe

The read side of the pipe.

◆ writePipe

FileDescriptor SC::PipeDescriptor::writePipe

The write side of the pipe.


The documentation for this struct was generated from the following file: