Struct membership::Membership

pub struct Membership { /* fields omitted */ }

Runs the gossip protocol on an internal thread.

Methods

impl Membership

pub fn new(bind_address: SocketAddr, config: ProtocolConfig) -> Self

Creates new instance communicating with other members through bind_address.

pub fn bind_address(&self) -> SocketAddr

Returns bind address of this member.

pub fn join(&mut self, member: SocketAddr) -> Result<(), Error>

Joins the group through member which has to already belong to the group.

Member might not be instantly spotted by all other members of the group.

pub fn stop(&mut self) -> Result<(), Error>

Stops this member, removing it from the group.

Member does not broadcast that its quiting (at least not yet), thus it may still be observed by others as alive, at least for a short period of time.

pub fn get_members(&self) -> Result<Vec<SocketAddr>, Error>

Returns all alive members of the group this member knows about.

These might not necessary be all alive members in the entire group.