Skip to main content

Module runtime

Module runtime 

Expand description

Packaged runtime entrypoints for embedding SOF.

Structs§

DerivedStateReplayConfig
Typed replay retention configuration for derived-state consumers.
DerivedStateRuntimeConfig
Typed derived-state runtime configuration.
RuntimeSetup
Programmatic runtime setup that mirrors selected SOF environment variables.

Enums§

RuntimeError
Public runtime error surface for packaged SOF entrypoints.

Functions§

run
Runs the packaged observer runtime on a Tokio multi-thread runtime.
run_async
Async variant of run, for callers that already own a Tokio runtime.
run_async_with_derived_state_host
Async variant of run_with_derived_state_host.
run_async_with_derived_state_host_and_setup
Async variant of run_with_derived_state_host_and_setup.
run_async_with_extension_host
Async variant of run_with_extension_host.
run_async_with_extension_host_and_setup
Async variant of run_with_extension_host_and_setup.
run_async_with_hosts
Async variant of run_with_hosts.
run_async_with_hosts_and_derived_state_host
Async variant of run_with_hosts_and_derived_state_host.
run_async_with_hosts_and_derived_state_host_and_setup
Async variant of run_with_hosts_and_derived_state_host_and_setup.
run_async_with_hosts_and_setup
Async variant of run_with_hosts_and_setup.
run_async_with_plugin_host
Async variant of run_with_plugin_host.
run_async_with_plugin_host_and_setup
Async variant of run_with_plugin_host_and_setup.
run_async_with_setup
Async variant of run_with_setup, for callers that already own a Tokio runtime.
run_with_derived_state_host
Runs the packaged observer runtime with an explicit derived-state host.
run_with_derived_state_host_and_setup
Runs the packaged observer runtime with a derived-state host and explicit setup overrides.
run_with_extension_host
Runs the packaged observer runtime with a custom runtime extension host.
run_with_extension_host_and_setup
Runs the packaged observer runtime with a custom runtime extension host and setup overrides.
run_with_hosts
Runs the packaged observer runtime with explicit plugin and runtime extension hosts.
run_with_hosts_and_derived_state_host
Runs the packaged observer runtime with explicit hosts, including derived-state consumers.
run_with_hosts_and_derived_state_host_and_setup
Runs the packaged observer runtime with explicit hosts, a derived-state host, and setup overrides.
run_with_hosts_and_setup
Runs the packaged observer runtime with explicit hosts and setup overrides.
run_with_plugin_host
Runs the packaged observer runtime with a custom plugin host.
run_with_plugin_host_and_setup
Runs the packaged observer runtime with a custom plugin host and explicit setup overrides.
run_with_setup
Runs the packaged observer runtime with explicit code-driven setup overrides.