Skip to main content

Crate orlando_cluster

Crate orlando_cluster 

Source

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§

ClusterGatewayService
gRPC service handling cross-cluster grain forwarding.
ClusterGrainRef
ClusterHealth
Tracks health of peer clusters via periodic gRPC probes.
ClusterId
Identifies a cluster within a multi-cluster (GSI) deployment.
ClusterSilo
ClusterSiloBuilder
ConnectionPool
FailoverConfig
Configuration for failover behavior.
FailoverManager
Manages failover for a single local cluster watching its peers.
FailureDetector
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.
FailureDetectorConfig
Configuration for the SWIM-based failure detector.
GrainOwnership
Who owns a grain activation.
GrainTransportService
HashBasedPlacement
Default strategy: consistent hashing via the hash ring. This is what Orleans uses for most grains.
HashRing
InMemoryCrossClusterDirectory
In-memory implementation for testing and single-process multi-cluster setups.
MembershipService
MessageRegistry
MultiClusterConfig
Configuration for a multi-cluster deployment.
PreferLocalPlacement
Prefer-local placement: always activate grains on the silo that receives the first call. Useful for cache grains or compute-local workloads.
RandomPlacement
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
ReplicaEntry
A single replica entry with its metadata.
ReplicaStore
Thread-safe store of replicated grain state. The ReplicationConsumer writes entries here; ClusterGrainRef reads from it for stale-read serving.
ReplicationConsumer
Tracks replication state for a single grain on a secondary cluster.
RetryPolicy
Configurable retry policy for remote grain calls.
SharedSecretAuth
Shared-secret authentication. Validates that incoming requests carry a specific token in the authorization gRPC metadata header.
SiloAddress

Enums§

ClusterError
DirectoryError
Encoding
Payload encoding for grain messages on the wire.
FailoverPhase
Failover progression for a single peer cluster.
MembershipChange
A membership change event broadcast to subscribers (e.g., the rebalancer).
PeerStatus
Status of a peer cluster.

Traits§

ClusterAuth
Pluggable authentication for cluster gRPC endpoints.
CrossClusterDirectory
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.
NetworkMessage
A message that can be sent across silo boundaries.
PlacementStrategy
Strategy for determining which silo should host a grain activation.

Functions§

spawn_replication_pump
Spawn a background task that reads entries from rx and appends them to the replication log. Returns the JoinHandle so the caller can monitor for unexpected termination.