Logo ProcessKit API Reference

Signal Type

A signal delivered to one run via `RunningProcess.Signal` or broadcast through `ProcessGroup.Signal`. The curated variants map to the POSIX signal of the same name on Unix. On **Windows** `Kill` maps to the Job Object terminate (the same hard kill as `ProcessGroup.KillAll`), and `Int`/`Term` are a best-effort soft stop: a console CTRL+BREAK to each child started with `Command.WindowsCtrlSignals()` and a `WM_CLOSE` posted to the top-level windows of every member that has one (a GUI child). They yield `ProcessError.Unsupported` only when the group has neither a CTRL-capable child nor a windowed member — nothing to soft-signal — never a silent downgrade. Every other variant yields `ProcessError.Unsupported` on Windows. `Other` is an escape hatch carrying a raw signal number on Unix (e.g. `SIGWINCH`); it is always unsupported on Windows. `SIGSTOP`/`SIGCONT` are deliberately absent from the curated set — pause and resume the whole tree with `ProcessGroup.Suspend` / `ProcessGroup.Resume`, which are portable (Windows included); `Signal.Other` with the raw `SIGSTOP` number remains available when the raw signal is specifically wanted on Unix.

Union cases

Union case Description

Hup

Full Usage: Hup

`SIGHUP` — hangup; conventionally "reload configuration".

Int

Full Usage: Int

`SIGINT` — keyboard interrupt.

Kill

Full Usage: Kill

`SIGKILL` — unblockable kill. On Windows: terminate the Job Object.

Other SignalNumber

Full Usage: Other SignalNumber

Parameters:
    SignalNumber : int

A raw signal number, passed through verbatim (Unix only). It must be a real, *deliverable* signal (`>= 1`): it lands in the *signal* argument of `kill(pid, sig)` (never the pid/target), so an out-of-range value cannot retarget the signal — it simply fails the send. The number **0** is rejected rather than sent: `kill`/`killpg` with signal 0 is a *liveness probe* that only checks the target exists (and the caller may signal it) and delivers nothing, so accepting it would report a successful delivery while doing nothing. A **negative** number is likewise not a signal and is refused. Both fail with a typed `ProcessError` (not an exception) — never a silent success. Always unsupported on Windows.

SignalNumber : int

Quit

Full Usage: Quit

`SIGQUIT` — quit, typically with a core dump.

Term

Full Usage: Term

`SIGTERM` — polite request to exit.

Usr1

Full Usage: Usr1

`SIGUSR1` — user-defined.

Usr2

Full Usage: Usr2

`SIGUSR2` — user-defined.

Instance members

Instance member Description

this.IsHup

Full Usage: this.IsHup

Returns: bool
Returns: bool

this.IsInt

Full Usage: this.IsInt

Returns: bool
Returns: bool

this.IsKill

Full Usage: this.IsKill

Returns: bool
Returns: bool

this.IsOther

Full Usage: this.IsOther

Returns: bool
Returns: bool

this.IsQuit

Full Usage: this.IsQuit

Returns: bool
Returns: bool

this.IsTerm

Full Usage: this.IsTerm

Returns: bool
Returns: bool

this.IsUsr1

Full Usage: this.IsUsr1

Returns: bool
Returns: bool

this.IsUsr2

Full Usage: this.IsUsr2

Returns: bool
Returns: bool

Type something to start searching.