Expand description
This modules defines a set of common message types used for managing resources in hyperactor meshes.
Modules§
- mesh
- This module defines common types for mesh resources. Meshes are managed as
resources, usually by a controller actor implementing the
crate::resourcebehavior.
Structs§
- Controller
- The generated behavior struct.
- Create
OrUpdate - Create or update a resource according to a spec.
- GetRank
Status - Get the status of a resource across the mesh.
- GetState
- Retrieve the current state of the resource.
- Keepalive
GetState - Same as GetState, but additionally tells the receiver that the owner is still alive. If the receiver does not receive this message for a while, it might assume the owner is dead.
- List
- List the set of resources managed by the controller.
- Rank
- Data type used to communicate ranks.
Implements
BindandUnbind; the comm actor replaces instances with the delivered rank. - Ranked
Values - RankedValues compactly represents rank-indexed values of type T. It stores contiguous values in a set of intervals; thus it is efficient and compact when the cardinality of T-typed values is low.
- State
- The state of a resource.
- Stop
- Stop a resource according to a spec.
- StopAll
- Stop all resources owned by the receiver of this message. No reply, this just issues the stop command. Use GetRankStatus to determine if it has successfully stopped.
- Stream
State - Subscribe to streaming state updates for a named resource.
The subscriber port will receive
State<S>whenever the resource’s state changes. The current state is sent immediately upon subscription. - Values
ByRank - An inverted index of RankedValues, providing all ranks for which each unique T-typed value appears.
- Wait
Rank Status - Like
GetRankStatus, but the handler defers its reply until the resource’s status is >=min_status. This avoids the race where the caller seesStoppingbefore the process has actually exited.
Enums§
- Status
- The current lifecycle status of a resource.
Traits§
- Create
OrUpdate Client - The custom client trait for this message type.
- Create
OrUpdate Handler - The custom handler trait for this message type.
- GetRank
Status Client - The custom client trait for this message type.
- GetRank
Status Handler - The custom handler trait for this message type.
- GetState
Client - The custom client trait for this message type.
- GetState
Handler - The custom handler trait for this message type.
- Keepalive
GetState Client - The custom client trait for this message type.
- Keepalive
GetState Handler - The custom handler trait for this message type.
- List
Client - The custom client trait for this message type.
- List
Handler - The custom handler trait for this message type.
- Resource
- A trait that bundles a set of types that together define a resource.
- State
Client - The custom client trait for this message type.
- State
Handler - The custom handler trait for this message type.
- Stop
AllClient - The custom client trait for this message type.
- Stop
AllHandler - The custom handler trait for this message type.
- Stop
Client - The custom client trait for this message type.
- Stop
Handler - The custom handler trait for this message type.
- Stream
State Client - The custom client trait for this message type.
- Stream
State Handler - The custom handler trait for this message type.
- Wait
Rank Status Client - The custom client trait for this message type.
- Wait
Rank Status Handler - The custom handler trait for this message type.