Skip to main content

Crate rill_runtime_protocol

Crate rill_runtime_protocol 

Source
Expand description

Stable, versioned contracts shared by Rill Runtime and its hosts.

§IPC API versions

VersionIntroduced inChanges
10.5.0Original handshake, health, invoke
20.7.0Handshake response gains handler identity and effective capabilities

The runtime accepts both v1 and v2 requests. v1 clients receive RuntimeResponse (no handler fields). v2 clients receive RuntimeResponseV2 (with handler identity). The two wire schemas are independently frozen with fixture tests.

Modules§

error_code
Stable IPC error code constants.
v3
Preview IPC v3 types. This module is independent from the frozen v1/v2 request and response types below. Preview Runtime IPC v3.

Structs§

HandlerPackManifest
ModelPackManifest
ReleaseArtifact
ReleaseIndexPayload
SignedReleaseIndex
SignedReleaseIndexWithGenerationV1
A signed v3 index plus a monotonic generation used for rollback protection.
TrustKeyMetadataV1
A trusted publisher key and its lifecycle state.
TrustMetadataV1
External trust metadata for publisher key rotation.
TrustVerificationFloorV1
Monotonic state persisted by a consumer that opts into trust-metadata lifecycle verification.

Enums§

ReleaseArtifactKind
RuntimeRequest
RuntimeResponse
RuntimeResponseV2
TrustKeyRole
Rotation role for a trusted publisher key.

Constants§

HANDLER_API_VERSION
Handler ABI version (independent of IPC API version).
HANDLER_PACKAGE_FORMAT_VERSION
Signed handler-pack container version.
MAX_MESSAGE_BYTES
Hard upper bound for one newline-delimited IPC message.
MIN_RUNTIME_API_VERSION
Minimum IPC API version the runtime still accepts.
MODEL_PACK_FORMAT_VERSION
Signed model-pack container version.
PM_ADAPTER_ARTIFACT_ID
Stable artifact id for the OpenWrt Performance Manager decision adapter. The adapter is a distinct artifact kind (pm-adapter) because it speaks the independent pm-rill-shadow v1 protocol, not the Rill Runtime IPC API.
PM_ADAPTER_PROTOCOL_VERSION
pm-rill-shadow protocol version advertised by released adapter binaries and required by pm-adapter index entries.
RELEASE_INDEX_LIFECYCLE_SCHEMA_VERSION
Version of the signed release-generation envelope used with trust metadata.
RELEASE_INDEX_SCHEMA_VERSION
Signed release-index schema understood by independent updaters.
RUNTIME_API_VERSION
Latest IPC API version supported by this crate.
RUNTIME_ARTIFACT_ID
Stable artifact id for the GNU (default) runtime build.
RUNTIME_ARTIFACT_ID_MUSL
Stable artifact id for the musl runtime build. The libc variant is part of the stable asset identity so gnu and musl builds of the same OS+arch do not collide in a v2 release index.
RUNTIME_STATE_FORMAT_VERSION
Persisted host/runtime state envelope version.
TRUST_METADATA_SCHEMA_VERSION
Version of the external trust metadata used for key rotation and rollback protection. This is deliberately separate from the frozen release-index v3 payload, so existing v1.2 readers keep their exact fail-closed semantics.