dfx::Subprocess::Process::Config Struct Reference

Process spawn and I/O configuration. More...

#include <dfx-subprocess/Process.hpp>

Collaboration diagram for dfx::Subprocess::Process::Config:

Public Attributes
fs::path	bin
	Program path (may be absolute or resolved via PATH; see resolveProgramPath()).
std::vector< std::string >	args
	Arguments passed to the program (excluding argv[0]).
std::vector< std::string >	env
	Environment entries, in "KEY=VALUE" form.
std::optional< fs::path >	cwd
	Optional working directory for the child process.
EnvMode	envMode = EnvMode::Merge
	Environment application mode.
StreamMode	stdinMode = StreamMode::Forward
	Child stdin wiring mode.
StreamMode	stdoutMode = StreamMode::Forward
	Child stdout wiring mode.
StreamMode	stderrMode = StreamMode::Forward
	Child stderr wiring mode.
CaptureConfig	stdoutCaptureConfig
	Capture behavior for stdout when stdoutMode is StreamMode::Pipe.
CaptureConfig	stderrCaptureConfig
	Capture behavior for stderr when stderrMode is StreamMode::Pipe.
bool	useParentDeathSignal = true
	Whether to set a "parent death" signal for the child. PR_SET_PDEATHSIG(2const)
std::optional< uid_t >	uid
	Optional UID that will be used as the effective UID for the new process (requires priviledges).
std::optional< gid_t >	gid
	Optional GID that will be used as the effective GID for the new process (requires priviledges).
bool	newSid = false
	Whether to place the new process in its own session or not.

Detailed Description

Process spawn and I/O configuration.

Member Data Documentation

args

std::vector<std::string> dfx::Subprocess::Process::Config::args

Arguments passed to the program (excluding argv[0]).

bin

fs::path dfx::Subprocess::Process::Config::bin

Program path (may be absolute or resolved via PATH; see resolveProgramPath()).

cwd

std::optional<fs::path> dfx::Subprocess::Process::Config::cwd

Optional working directory for the child process.

env

std::vector<std::string> dfx::Subprocess::Process::Config::env

Environment entries, in "KEY=VALUE" form.

envMode

EnvMode dfx::Subprocess::Process::Config::envMode = EnvMode::Merge

Environment application mode.

gid

std::optional<gid_t> dfx::Subprocess::Process::Config::gid

Optional GID that will be used as the effective GID for the new process (requires priviledges).

newSid

bool dfx::Subprocess::Process::Config::newSid = false

Whether to place the new process in its own session or not.

stderrCaptureConfig

CaptureConfig dfx::Subprocess::Process::Config::stderrCaptureConfig

Capture behavior for stderr when stderrMode is StreamMode::Pipe.

stderrMode

StreamMode dfx::Subprocess::Process::Config::stderrMode = StreamMode::Forward

Child stderr wiring mode.

stdinMode

StreamMode dfx::Subprocess::Process::Config::stdinMode = StreamMode::Forward

Child stdin wiring mode.

stdoutCaptureConfig

CaptureConfig dfx::Subprocess::Process::Config::stdoutCaptureConfig

Capture behavior for stdout when stdoutMode is StreamMode::Pipe.

stdoutMode

StreamMode dfx::Subprocess::Process::Config::stdoutMode = StreamMode::Forward

Child stdout wiring mode.

uid

std::optional<uid_t> dfx::Subprocess::Process::Config::uid

Optional UID that will be used as the effective UID for the new process (requires priviledges).

useParentDeathSignal

bool dfx::Subprocess::Process::Config::useParentDeathSignal = true

Whether to set a "parent death" signal for the child. PR_SET_PDEATHSIG(2const)

---

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

• lib/dfx-subprocess/Process.hpp