Struct ClusterDirectory 

pub struct ClusterDirectory { /* private fields */ }

Available on crate feature cluster only.

In-memory cluster directory (control plane): which nodes serve which streams. Shared (Arc) by every node’s relay in the process.

By default entries live until an explicit withdraw. Opting into a TTL with with_ttl gives lease parity with the network DirectoryServer: an announce is valid only for the TTL, so a peer that stops a stream without withdraw (e.g. it crashed) is dropped on its own, and locate then steers to a live replica instead of a dead node. Re- announce within the TTL to keep a lease (the engine’s PublishEnded event makes a tiny auto-withdraw adapter easy, too).

Implementations

impl ClusterDirectory

pub fn new() -> Self

A fresh, empty directory whose entries never expire (withdraw-only).

pub fn with_ttl(ttl: Duration) -> Self

A directory whose announces carry a ttl lease (network-relay parity); an entry not re-announced within ttl is reaped on the next access.

pub fn announce(&self, node: &NodeAddr, key: &StreamKey)

Record that node serves key (refreshing its lease if TTL is set).

pub fn withdraw(&self, node: &NodeAddr, key: &StreamKey)

Drop node from key’s server set.

pub fn locate(&self, key: &StreamKey, exclude: &NodeAddr) -> Option<NodeAddr>

A live node serving key other than exclude, if any. Expired leases are skipped (and lazily reaped).

Trait Implementations

impl Debug for ClusterDirectory

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ClusterDirectory

fn default() -> ClusterDirectory

Returns the “default value” for a type.