Struct Announcer 

pub struct Announcer { /* private fields */ }

Implementations

impl Announcer

pub fn new(config: AnnouncerConfig) -> Result<Announcer, AnnouncerError>

Construct a new Announcer from the AnnouncerConfig.

This will ensure that the local NodeId, provided in the AnnouncerConfig, will be removed from all sets.

Errors

Returns the following errors:

• AnnouncerError::NoSeeds: both sets of already synchronized and un-synchronized nodes were empty of nodes were empty
• AnnouncerError::AlreadySynced: no more nodes are available for synchronizing with
• AnnouncerError::Target: the target has no preferred seeds and no replicas

pub fn synced_with( &mut self, node: PublicKey, duration: Duration, ) -> ControlFlow<Success, Progress>

Mark the node as synchronized, with the given duration it took to synchronize with.

If the target for the Announcer has been reached, then a Success is returned via ControlFlow::Break. Otherwise, Progress is returned via ControlFlow::Continue.

The caller decides whether they wish to continue the announcement process.

pub fn timed_out(self) -> AnnouncerResult

Complete the Announcer process returning a AnnouncerResult.

If the target for the Announcer has been reached, then the result will be AnnouncerResult::Success, otherwise, it will be AnnouncerResult::TimedOut.

pub fn can_continue(self) -> ControlFlow<NoNodes, Announcer>

Check if the Announcer can continue synchronizing with more nodes. If there are no more nodes, then NoNodes is returned in the ControlFlow::Break, otherwise the Announcer is returned as-is in the ControlFlow::Continue.

pub fn to_sync(&self) -> BTreeSet<PublicKey>

Get all the nodes to be synchronized with.

pub fn target(&self) -> &Target

Get the Target of the Announcer.

pub fn progress(&self) -> Progress

Get the Progress of the Announcer.

Trait Implementations

impl Debug for Announcer

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

Formats the value using the given formatter.