Enum foca::Timer

pub enum Timer<T> {
    ProbeRandomMember(TimerToken),
    SendIndirectProbe {
        probed_id: T,
        token: TimerToken,
    },
    ChangeSuspectToDown {
        member_id: T,
        incarnation: Incarnation,
        token: TimerToken,
    },
    PeriodicAnnounce(TimerToken),
    PeriodicAnnounceDown(TimerToken),
    PeriodicGossip(TimerToken),
    RemoveDown(T),
}

Timer is an event that’s scheduled by a Runtime. You won’t need to construct or understand these, just ensure a timely delivery.

Warning: This type implements Ord to facilitate correcting for out-of-order delivery due to the runtime lagging for whatever reason. It assumes the events being sorted come from the same foca instance and are not being persisted after being handled via crate::Foca::handle_timer. Any use outside of this scenario will likely lead to unintended consequences.

Variants

ProbeRandomMember(TimerToken)

Pick a random active member and initiate the probe cycle.

SendIndirectProbe

Fields

probed_id: T

The current member being probed

token: TimerToken

See TimerToken

Send indirect probes if the direct one hasn’t completed yet.

ChangeSuspectToDown

Fields

member_id: T

Target member identity

incarnation: Incarnation

Its Incarnation the moment the suspicion was raised. If the member refutes the suspicion (by increasing its Incarnation), this won’t match and it won’t be declared Down.

token: TimerToken

See TimerToken

Transitions member T from Suspect to Down if the incarnation is still the same.

PeriodicAnnounce(TimerToken)

Sends a crate::Message::Announce to randomly chosen members as specified by crate::Config::periodic_announce

PeriodicAnnounceDown(TimerToken)

Sends a crate::Message::Announce to randomly chosen members that are condidered crate::State::Down as specified by crate::Config::periodic_announce_to_down_members

PeriodicGossip(TimerToken)

Sends a crate::Message::Gossip to randomly chosen members as specified by crate::Config::periodic_gossip

RemoveDown(T)

Forgets about dead member T, allowing them to join the cluster again with the same identity.

Trait Implementations

impl<T: Clone> Clone for Timer<T>

fn clone(&self) -> Timer<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Timer<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Timer<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Eq> Ord for Timer<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Timer<T>

fn eq(&self, other: &Timer<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialEq> PartialOrd for Timer<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for Timer<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for Timer<T>

impl<T> StructuralPartialEq for Timer<T>