Expand description
Host-mesh attach and lifecycle.
§Host-mesh invariants (HM-*)
These are the load-bearing semantic contracts of HostMesh::attach()
and HostMeshRef::push_config(). They describe what callers may
rely on; they do not pin specific mechanisms (the current
implementation chooses a particular send path, error taxonomy, and
timeout shape — those are not invariants and may evolve).
-
HM-1 (attach-config-complete). If
HostMesh::attach()returnsOk, every attached host has installed the client’s propagatable config snapshot. -
HM-2 (attach-config-fails-closed). If config push fails on any attached host,
HostMesh::attach()returnsErr. It must not return a partially-configured mesh as success. -
HM-3 (in-band-request-failure-surface). Attach-time config-push request failure must surface through
attach()/push_config()as a structured error. It must not bypass that result path by returning the outbound request on the caller’sUndeliverable<MessageEnvelope>channel. The invariant names a specific prohibited bypass; what a caller chooses to do with the returnedErr(escalate, retry, abort) is outside scope. Cross-cutting: depends on hyperactor undeliverable semantics inhyperactor::referenceandhyperactor::actor; the invariant still belongs here because the attach contract is owned here. -
HM-4 (host-scoped-error-reporting). Config-push failure reported from
push_config()identifies the failing host(s) individually, so callers can act per-host. The contract commits to per-host identity; the failure-mode taxonomy carried alongside it (theConfigPushFailurevariant set) is implementation detail and may evolve without changing the contract.
Re-exports§
pub use crate::host_mesh::host_agent::HostAgent;
Modules§
- host_
agent - The mesh agent actor that manages a host.
Structs§
- Config
Push Error - Aggregated
attach()config-push failure surface — one entry per host that didn’t acknowledge installation. - Host
Mesh - An owned mesh of hosts.
- Host
Mesh Ref - A non-owning reference to a mesh of hosts.
- Host
Mesh Shutdown Guard - Wrapper around HostMesh that runs shutdown on Drop.
- HostRef
- A reference to a single host.
Enums§
- Config
Push Failure - Per-host failure modes for the attach-time config push.
- Host
Mesh RefParse Error - The type of error occuring during
HostMeshRefparsing.
Constants§
- PROC_
MESH_ CONTROLLER_ NAME - Actor name for
ProcMeshControllerwhen spawned as a named child.
Statics§
- GET_
PROC_ STATE_ MAX_ IDLE - The maximum idle time between updates while querying host meshes for their proc states.
- PROC_
SPAWN_ MAX_ IDLE - The maximum idle time between updates while spawning proc meshes.
- PROC_
STOP_ MAX_ IDLE - The maximum idle time between updates while stopping proc meshes.
Functions§
- spawn_
admin - Spawn a
MeshAdminAgentthat aggregates hosts from multiple meshes.
Type Aliases§
- PerRank
Bootstrap Fn - A function that produces a per-rank
BootstrapCommand, called once per proc during spawn with that proc’sview::Pointover the combinedhost_extent ⊕ per_hostextent. Returning an error aborts the spawn with that error surfaced as a configuration failure.