subprocess Namespace Reference

Namespaces
namespace	util
namespace	detail

Classes
class	CalledProcessError
class	OSError
struct	string_arg
struct	executable
struct	input
struct	output
struct	error
class	Buffer
class	Popen

Typedefs
using	OutBuffer = Buffer
using	ErrBuffer = Buffer

Enumerations
enum	IOTYPE { STDOUT = 1 , STDERR , PIPE }

Variables
static const size_t	SP_MAX_ERR_BUF_SIZ = 1024
static const size_t	DEFAULT_BUF_CAP_BYTES = 8192

Detailed Description

Getting started with reading this source code. The source is mainly divided into four parts:

1. Exception Classes: These are very basic exception classes derived from runtime_error exception. There are two types of exception thrown from subprocess library: OSError and CalledProcessError
2. Popen Class This is the main class the users will deal with. It provides with all the API's to deal with processes.
3. Util namespace It includes some helper functions to split/join a string, reading from file descriptors, waiting on a process, fcntl options on file descriptors etc.
4. Detail namespace This includes some metaprogramming and helper classes.

Typedef Documentation

ErrBuffer

using subprocess::ErrBuffer = Buffer

Definition at line 705 of file subprocess.h.

OutBuffer

using subprocess::OutBuffer = Buffer

Definition at line 703 of file subprocess.h.

Enumeration Type Documentation

IOTYPE

enum subprocess::IOTYPE

Used for redirecting input/output/error

Enumerator
STDOUT
STDERR
PIPE

Definition at line 563 of file subprocess.h.

Variable Documentation

DEFAULT_BUF_CAP_BYTES

const size_t subprocess::DEFAULT_BUF_CAP_BYTES = 8192

static

Definition at line 124 of file subprocess.h.

SP_MAX_ERR_BUF_SIZ

const size_t subprocess::SP_MAX_ERR_BUF_SIZ = 1024

static

Definition at line 119 of file subprocess.h.