Re-exports§
pub use health_server::StoreProbe;pub use health_server::run_health_server;pub use discovery::DnsMembershipProvider;pub use discovery::MembershipProvider;pub use discovery::StaticSeedProvider;
Modules§
- discovery
- health_
server - HTTP health endpoints for orchestrator probes (Kubernetes, Nomad, etc.).
- proto
Structs§
- Cluster
Gateway Service - gRPC service handling cross-cluster grain forwarding.
- Cluster
Grain Ref - Cluster
Health - Tracks health of peer clusters via periodic gRPC probes.
- Cluster
Id - Identifies a cluster within a multi-cluster (GSI) deployment.
- Cluster
Silo - Cluster
Silo Builder - Connection
Pool - Failover
Config - Configuration for failover behavior.
- Failover
Manager - Manages failover for a single local cluster watching its peers.
- Failure
Detector - SWIM-based failure detector. Runs as a background task that periodically probes random cluster members using direct pings, indirect pings, and a suspicion mechanism before declaring members dead.
- Failure
Detector Config - Configuration for the SWIM-based failure detector.
- Grain
Ownership - Who owns a grain activation.
- Grain
Transport Service - Hash
Based Placement - Default strategy: consistent hashing via the hash ring. This is what Orleans uses for most grains.
- Hash
Ring - InMemory
Cross Cluster Directory - In-memory implementation for testing and single-process multi-cluster setups.
- Membership
Service - Message
Registry - Multi
Cluster Config - Configuration for a multi-cluster deployment.
- Prefer
Local Placement - Prefer-local placement: always activate grains on the silo that receives the first call. Useful for cache grains or compute-local workloads.
- Random
Placement - Random placement: distribute grains randomly across the cluster. Useful for stateless compute grains where you want even load distribution without the determinism of consistent hashing.
- Rebalancer
- Replica
Entry - A single replica entry with its metadata.
- Replica
Store - Thread-safe store of replicated grain state. The
ReplicationConsumerwrites entries here;ClusterGrainRefreads from it for stale-read serving. - Replication
Consumer - Tracks replication state for a single grain on a secondary cluster.
- Retry
Policy - Configurable retry policy for remote grain calls.
- Shared
Secret Auth - Shared-secret authentication. Validates that incoming requests carry
a specific token in the
authorizationgRPC metadata header. - Silo
Address
Enums§
- Cluster
Error - Directory
Error - Encoding
- Payload encoding for grain messages on the wire.
- Failover
Phase - Failover progression for a single peer cluster.
- Membership
Change - A membership change event broadcast to subscribers (e.g., the rebalancer).
- Peer
Status - Status of a peer cluster.
Traits§
- Cluster
Auth - Pluggable authentication for cluster gRPC endpoints.
- Cross
Cluster Directory - Tracks which cluster owns each grain activation globally. Implementations must provide CAS semantics: only one cluster can own a grain at a time. Concurrent registrations are resolved by first-writer-wins.
- Network
Message - A message that can be sent across silo boundaries.
- Placement
Strategy - Strategy for determining which silo should host a grain activation.
Functions§
- spawn_
replication_ pump - Spawn a background task that reads entries from
rxand appends them to the replication log. Returns theJoinHandleso the caller can monitor for unexpected termination.