Struct Peer

Source

pub struct Peer { /* private fields */ }

Expand description

One peer in the cluster ring.

Implementations§

Source §

impl Peer

Source

pub fn new( idx: u32, endpoint: PeerEndpoint, rack: String, dc: String, tokens: Vec<DynToken>, is_local: bool, is_same_dc: bool, is_secure: bool, ) -> Self

Build a new peer record.

idx is the peer’s index in the pool’s peer array (0 is always the local node). is_local and is_same_dc mirror the reference engine’s flags. The initial state is PeerState::Joining for the local node and PeerState::Down for a remote one (the reference engine optimistically waits for the first gossip ack before promoting a remote peer).

§Examples

use dynomite::cluster::peer::{Peer, PeerEndpoint, PeerState};
use dynomite::hashkit::DynToken;
let p = Peer::new(
    1,
    PeerEndpoint::tcp("h".into(), 1),
    "r".into(),
    "d".into(),
    vec![DynToken::from_u32(0)],
    false,
    true,
    false,
);
assert_eq!(p.idx(), 1);
assert_eq!(p.state(), PeerState::Down);

Source

pub fn idx(&self) -> u32

Index of the peer in the pool’s array.

Source

pub fn endpoint(&self) -> &PeerEndpoint

Endpoint reference.

Source

pub fn rack(&self) -> &str

Rack name.

Source

pub fn dc(&self) -> &str

Datacenter name.

Source

pub fn tokens(&self) -> &[DynToken]

Token list.

Source

pub fn is_local(&self) -> bool

True for the local node.

Source

pub fn is_same_dc(&self) -> bool

True when the peer shares the local datacenter.

Source

pub fn is_secure(&self) -> bool

True when the peer expects an encrypted dnode link.

Source

pub fn state(&self) -> PeerState

Current lifecycle state.

Source

pub fn set_state(&mut self, state: PeerState, ts_secs: u64)

Update the lifecycle state. The supplied ts_secs mirrors the reference engine’s gossip_node::ts and is used by the failure detector to age the peer out.

§Examples

use dynomite::cluster::peer::{Peer, PeerEndpoint, PeerState};
use dynomite::hashkit::DynToken;
let mut p = Peer::new(
    0, PeerEndpoint::tcp("h".into(), 1), "r".into(), "d".into(),
    vec![DynToken::from_u32(0)], true, true, false,
);
p.set_state(PeerState::Normal, 42);
assert_eq!(p.state(), PeerState::Normal);
assert_eq!(p.last_state_ts_secs(), 42);

Source

pub fn last_state_ts_secs(&self) -> u64

Last observed gossip timestamp (epoch seconds).

Source

pub fn record_failure(&mut self)

Increment the consecutive-failure counter.

Source

pub fn record_success(&mut self)

Reset the consecutive-failure counter.

Source

pub fn failure_count(&self) -> u32

Current consecutive-failure count.

Source

pub fn failure_detector(&self) -> &PhiAccrual

Borrow the phi-accrual failure detector for this peer. Used by the gossip task to record heartbeat arrivals and to query the suspicion level on every tick.

Source

pub fn failure_detector_mut(&mut self) -> &mut PhiAccrual

Mutably borrow the phi-accrual failure detector. Use from the gossip / heartbeat task.

Source

pub fn primary_token(&self) -> Option<&DynToken>

First (primary) token of this peer, if any.

§Examples

use dynomite::cluster::peer::{Peer, PeerEndpoint};
use dynomite::hashkit::DynToken;
let p = Peer::new(
    0, PeerEndpoint::tcp("h".into(), 1), "r".into(), "d".into(),
    vec![DynToken::from_u32(7)], true, true, false,
);
assert_eq!(p.primary_token().unwrap().get_int(), 7);