Struct State

pub struct State<PI, R> { /* private fields */ }

The state of the iroh-gossip protocol.

The implementation works as an IO-less state machine. The implementer injects events through Self::handle, which returns an iterator of OutEvents to be processed.

This struct contains a map of topic::State for each topic that was joined. It mostly acts as a forwarder of InEvents to matching topic state. Each topic’s state is completely independent; thus the actual protocol logic lives with topic::State.

Implementations

impl<PI: PeerIdentity, R: Rng + Clone> State<PI, R>

pub fn new(me: PI, me_data: Option<PeerData>, config: Config, rng: R) -> Self

Create a new protocol state instance.

me is the PeerIdentity of the local node, peer_data is the initial PeerData (which can be updated over time). For the protocol to perform as recommended in the papers, the Config should be identical for all nodes in the network.

pub fn me(&self) -> &PI

Get a reference to the node’s PeerIdentity

pub fn state(&self, topic: &TopicId) -> Option<&State<PI, R>>

Get a reference to the protocol state for a topic.

pub fn topics(&self) -> impl Iterator<Item = &TopicId>

Get an iterator of all joined topics.

pub fn states(&self) -> impl Iterator<Item = (&TopicId, &State<PI, R>)>

Get an iterator for the states of all joined topics.

pub fn has_active_peers(&self, topic: &TopicId) -> bool

Check if a topic has any active (connected) peers.

pub fn max_message_size(&self) -> usize

Returns the maximum message size configured in the gossip protocol.

pub fn handle( &mut self, event: InEvent<PI>, now: Instant, ) -> impl Iterator<Item = OutEvent<PI>> + '_

Handle an InEvent

This returns an iterator of OutEvents that must be processed.

Trait Implementations

impl<PI: Debug, R: Debug> Debug for State<PI, R>

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

Formats the value using the given formatter.