stop
Module: stop
Section titled “Module: stop”Contents
Section titled “Contents”Structs
StopOutcome- Result of astopcall.
Functions
stop_components- Stop a running stack made of the named components.
firma_process_orchestrator::stop::StopOutcome
Section titled “firma_process_orchestrator::stop::StopOutcome”Struct
Result of a stop call.
Fields:
forced: bool- Whether at least one recorded [TerminationTarget] survived the
Trait Implementations:
- Clone
fn clone(self: &Self) -> StopOutcome
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
firma_process_orchestrator::stop::stop_components
Section titled “firma_process_orchestrator::stop::stop_components”Function
Stop a running stack made of the named components.
The component names are caller-supplied data (in startup order); this function is agnostic to which components the stack contains.
Errors
Section titled “Errors”Returns pidfile, process-probe, termination, or cleanup errors. Runtime
state is retained when probing or hard termination fails, or when the
generation is malformed, so cleanup can be retried. Malformed generation
state does not prevent process teardown; its
[OrchestratorError::InvalidStackGeneration] is returned afterward.
fn stop_components(state_dir: &std::path::Path, timeout: std::time::Duration, topology: &crate::StackTopology) -> Result<StopOutcome, crate::error::OrchestratorError>