subprocess Namespace Reference

Namespaces
	detail
	util

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

Documentation for C++ subprocessing library.

Copyright

The code is licensed under the MIT License:
Copyright © 2016-2018 Arun Muralidharan.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author

[Arun Muralidharan]

See also

https://github.com/arun11299/cpp-subprocess to download the source code

Version

1.0.0

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 = typedef Buffer

Definition at line 693 of file subprocess.h.

OutBuffer

using subprocess::OutBuffer = typedef Buffer

Definition at line 691 of file subprocess.h.

Enumeration Type Documentation

IOTYPE

enum subprocess::IOTYPE

Used for redirecting input/output/error

Enumerator
STDOUT
STDERR
PIPE

Definition at line 551 of file subprocess.h.

Variable Documentation

DEFAULT_BUF_CAP_BYTES

const size_t subprocess::DEFAULT_BUF_CAP_BYTES = 8192

static

Definition at line 116 of file subprocess.h.

SP_MAX_ERR_BUF_SIZ

const size_t subprocess::SP_MAX_ERR_BUF_SIZ = 1024

static

Definition at line 111 of file subprocess.h.