Expand description
Host discovery and process ownership.
Structs§
- Exit
Classification - Classified exit evidence. A crash may carry a code or a signal.
- Muse
Child - The SDK-owned host process and its stdio handles.
- Muse
Host Discovery Error - No host was supplied explicitly and no executable
musewas onPATH. - Spawn
Options - Inputs for an SDK-owned
muse serveprocess.
Enums§
- Close
Attribution - How the spawned-host close path credits available exit evidence.
- Exit
Kind - Semantic host-exit class shared with the Python and TypeScript SDKs.
- Retry
Guidance - Whether retrying a documented host refusal can help.
- Spawn
Error - A discovery failure or an OS refusal to launch the discovered binary.
Constants§
- COMPATIBILITY_
PAGE_ URL - The compatibility matrix cited by discovery errors.
- DEFAULT_
SHUTDOWN_ TIMEOUT - Default
SpawnOptions::shutdown_timeout: how longMuseChild::close(and soMuseClient::close) lets the host drain after stdin EOF before it escalates (SIGTERMon Unix; the platform kill elsewhere). It is the host’s own stdio drain timeout, so a healthy host finishes its orderly wind-down (turn cancel, durable session end) inside it. - HOST_
BINARY_ NAME - The executable searched for when callers do not pass
muse_bin. - SIGTERM_
GRACE - Fixed grace between
SIGTERMandSIGKILLinsideMuseChild::close. Not a knob: by then the host has had its whole drain window, so this only covers a signal handler’s final flush. Off Unix, where the first escalation is already the platform kill, it only spaces the repeated kill request; the reap stays unbounded. - STDERR_
DRAIN_ TIMEOUT - Bound on waiting for the host’s stderr tail once its exit was observed.
- STDERR_
TAIL_ LIMIT - Maximum retained host stderr evidence for exit classification.
Functions§
- classify_
exit - Classify raw process evidence using the host’s documented exit table.
- discover_
muse_ bin - Resolve
muse_bin, thenPATH; return an explicit path verbatim. - spawn_
muse - Spawn an SDK-owned host driven by the caller’s runtime.