Skip to main content

Module runtime

Module runtime 

Source

Modules§

shutdown
Shutdown signal handling utilities

Structs§

ClientRegistration
A type-erased client registration for injecting clients into the ClientHub.
DependencyChecker
Sticky, dynamic dependency-resolution tracker shared across serving modes (in-process host and OoP).
Endpoint
Represents an endpoint where a gear instance can be reached
GearInstallers
Installers for a specific gear (gear name + service installers).
GearInstance
Represents a single instance of a gear
GearManager
Central registry that tracks all running gear instances in the system. Provides discovery, health tracking, and round-robin load balancing.
GrpcInstallerData
Grouped installers for all gears in the process.
GrpcInstallerStore
Runtime-owned store for gRPC service installers.
HostRuntime
OopGearSpawnConfig
Configuration for a single OoP gear to be spawned.
OopServeOptions
Configuration and collaborators for the OoP HTTP runtime, assembled by the bootstrap layer and consumed by HostRuntime’s OoP serving path.
OopSpawnOptions
Options for spawning OoP gears.
ReadinessHealthcheck
Bridges a DependencyChecker into the RestHealthcheckRegistry as a single leaf check, for the in-process (api-gateway-hosted) /readyz path where readiness is one check among many in a shared registry.
ReadinessReport
The aggregate readiness report rendered as the /readyz response body.
ReadinessState
Shared, framework-owned readiness state for an OoP gear instance.
RunOptions
Options for running the ToolKit runner.
SystemContext
System-level context provided to system gears during the wiring phase.

Enums§

DbOptions
How the runtime should provide DBs to gears.
InstanceState
ReadinessLifecycle
Lifecycle state reported on /readyz (cpt-cf-adr-eventual-readiness).
ShutdownOptions
How the runtime should decide when to stop.

Constants§

DEFAULT_HEALTHCHECK_TIMEOUT
Default per-check timeout for readiness healthchecks.
DEFAULT_SHUTDOWN_DEADLINE
Default shutdown deadline for graceful gear stop (35 seconds).
TOOLKIT_DIRECTORY_ENDPOINT_ENV
Environment variable name for passing directory endpoint to OoP gears.
TOOLKIT_MODULE_CONFIG_ENV
Environment variable name for passing rendered gear config to OoP gears.

Functions§

run
Run the full gear lifecycle.
run_oop_serving
Run an out-of-process gear and serve its HTTP routes.