Struct HostMesh 

pub struct HostMesh { /* private fields */ }

An owned mesh of hosts.

Lifecycle

HostMesh owns host lifecycles. Callers must invoke HostMesh::shutdown for deterministic teardown.

In tests and production, prefer explicit shutdown to guarantee that host agents drop their BootstrapProcManagers and that all child procs are reaped. You can use shutdown_guard to get a wrapper which will try to do a best-effort shutdown on Drop.

Implementations

impl HostMesh

pub async fn local() -> Result<HostMesh>

Bring up a local single-host mesh and, in the launcher process, return a HostMesh handle for it.

There are two execution modes:

• bootstrap-child mode: if Bootstrap::get_from_env() says this process was launched as a bootstrap child, we call boot.bootstrap().await, which hands control to the bootstrap logic for this process (as defined by the BootstrapCommand the parent used to spawn it). if that call returns, we log the error and terminate. this branch does not produce a HostMesh.

• launcher mode: otherwise, we are the process that is setting up the mesh. we create a Host, spawn a HostAgent in it, and build a single-host HostMesh around that. that HostMesh is returned to the caller.

This API is intended for tests, examples, and local bring-up, not production.

TODO: fix up ownership

pub async fn local_with_bootstrap( bootstrap_cmd: BootstrapCommand, ) -> Result<HostMesh>

Same as [local], but the caller supplies the BootstrapCommand instead of deriving it from the current process.

The provided bootstrap_cmd is used when spawning bootstrap children and determines the behavior of boot.bootstrap().await in those children.

pub async fn local_in_process() -> Result<HostMesh>

Create a local in-process host mesh where all procs run in the current OS process.

Unlike [local] which spawns child processes for each proc, this method uses LocalProcManager to run everything in-process. This makes all actors visible in the admin tree (useful for debugging with the TUI).

This API is intended for tests, examples, and debugging.

pub async fn process( extent: Extent, command: BootstrapCommand, ) -> Result<HostMesh>

Create a new process-based host mesh. Each host is represented by a local process, which manages its set of procs. This is not a true host mesh the sense that each host is not independent. The intent of process is for testing, examples, and experimentation.

The bootstrap command is used to bootstrap both hosts and processes, thus it should be a command that reaches crate::bootstrap_or_die. process is itself a valid bootstrap entry point; thus using BootstrapCommand::current works correctly as long as process is called early in the lifecycle of the process and reached unconditionally.

TODO: thread through ownership

pub fn take(mesh: HostMeshRef) -> Self

Take ownership of an existing host mesh reference.

Consumes the HostMeshRef and returns an owned HostMesh that assumes lifecycle responsibility for those hosts.

pub async fn attach( cx: &impl Actor, id: HostMeshId, addresses: Vec<ChannelAddr>, ) -> Result<Self>

Attach to pre-existing workers and push client config.

This is the “simple bootstrap” attach protocol:

1. Wraps the provided addresses into a HostMeshRef.
2. Snapshots propagatable_attrs() from the client’s global config.
3. Pushes the config to each host agent as Source::ClientOverride, awaiting per-host installation acknowledgement.
4. Returns the owned HostMesh.

HM-1 / HM-2 / HM-3 / HM-4 (see module docs): if config push fails on any host, this returns Err. A successful return means every attached host installed the propagatable config snapshot.

pub async fn shutdown(&mut self, cx: &impl Actor) -> Result<()>

Request a clean shutdown of all hosts owned by this HostMesh.

Uses a two-phase approach:

1. Cast DrainHost and wait for every host to finish draining its user procs while networking stays alive.
2. Cast ShutdownHost and wait for every host to acknowledge that its local shutdown handler has completed.

pub fn shutdown_guard(self) -> HostMeshShutdownGuard

Consumes and wraps this HostMesh with a HostMeshShutdownGuard, which will ensure shutdown is run on Drop.

pub async fn stop(&mut self, cx: &impl Actor) -> Result<()>

Stop all hosts owned by this HostMesh, draining user procs but keeping worker processes and their sockets alive for reconnection.

After stop, the same worker addresses can be passed to HostMesh::attach to create a new mesh.

impl HostMesh

pub fn set_bootstrap(&mut self, cmd: BootstrapCommand)

Set the bootstrap command on the underlying HostMeshRef, so that future spawn calls use it. Unlike HostMeshRef::with_bootstrap this mutates in place, preserving ownership.

Methods from Deref<Target = HostMeshRef>

pub async fn spawn<C: Actor>( &self, cx: &C, name: &str, per_host: Extent, proc_bind: Option<Vec<ProcBind>>, per_rank_bootstrap: Option<Box<PerRankBootstrapFn>>, ) -> Result<ProcMesh>

where C::A: Handler<MeshFailure>,

Spawn a ProcMesh onto this host mesh. The per_host extent specifies the shape of the procs to spawn on each host.

proc_bind, when provided, is a per-process CPU/NUMA binding configuration. Its length must equal the number of ranks in per_host. Each entry maps binding keys (cpunodebind, membind, physcpubind, cpus) to their values. Only takes effect when running on Linux.

per_rank_bootstrap, when provided, is a function called once per proc to produce that proc’s BootstrapCommand. The function receives a view::Point over the combined host_extent ⊕ per_host extent. Its return value takes precedence over self.bootstrap_command for that proc only.

Spawn is issued as a single SpawnProcs cast — each HostAgent spawns all of its per-host proc slots — then fenced with an accumulated status barrier so returned procs are addressable and ready.

pub fn id(&self) -> &HostMeshId

The identity of the referenced host mesh.

pub fn host_addrs(&self) -> Vec<ChannelAddr>

The host channel addresses in rank order.

Trait Implementations

impl AsRef<HostMeshRef> for HostMesh

fn as_ref(&self) -> &HostMeshRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for HostMesh

type Target = HostMeshRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.