Logo ProcessKit API Reference

Mechanism Type

The OS primitive a `ProcessGroup` uses to contain a process tree. Reported honestly (never a silent downgrade) so callers can reason about the containment guarantee on the current platform.

Union cases

Union case Description

CgroupV2

Full Usage: CgroupV2

Linux cgroup v2. Resource limits apply to each child and every descendant it forks *after* it has been migrated into the cgroup. A child is migrated (its pid written to `cgroup.procs`) immediately after it is spawned; a descendant it forks in the brief window before that write completes is created in the parent cgroup and stays there, so it is covered by kill-on-drop teardown (the whole subtree is reaped) but not by the resource limits. If a child cannot be migrated at all, it is killed and reaped and the spawn fails with `ProcessError.ResourceLimit` rather than being left to run unconstrained.

JobObject

Full Usage: JobObject

Windows Job Object.

ProcessGroup

Full Usage: ProcessGroup

POSIX process group (macOS/BSD, or the Linux fallback).

Instance members

Instance member Description

this.IsCgroupV2

Full Usage: this.IsCgroupV2

Returns: bool
Returns: bool

this.IsJobObject

Full Usage: this.IsJobObject

Returns: bool
Returns: bool

this.IsProcessGroup

Full Usage: this.IsProcessGroup

Returns: bool
Returns: bool

Type something to start searching.