Skip to main content

GossipMessage

Enum GossipMessage 

Source
pub enum GossipMessage {
    Ping {
        seq: u64,
        sender: NodeId,
        updates: Vec<NodeUpdate>,
    },
    PingReq {
        seq: u64,
        sender: NodeId,
        target: NodeId,
        target_addr: SocketAddr,
    },
    Ack {
        seq: u64,
        sender: NodeId,
        updates: Vec<NodeUpdate>,
    },
    Join {
        sender: NodeId,
        sender_addr: SocketAddr,
    },
    Welcome {
        sender: NodeId,
        members: Vec<MemberInfo>,
    },
    SlotsAnnounce {
        sender: NodeId,
        incarnation: u64,
        slots: Vec<SlotRange>,
    },
}
Expand description

Message types for the SWIM gossip protocol.

Variants§

§

Ping

Direct probe to check if a node is alive.

Fields

§seq: u64
§sender: NodeId
§updates: Vec<NodeUpdate>

Piggybacked state updates.

§

PingReq

Request another node to probe a target on our behalf.

Fields

§seq: u64
§sender: NodeId
§target: NodeId
§target_addr: SocketAddr
§

Ack

Response to a Ping or forwarded PingReq.

Fields

§seq: u64
§sender: NodeId
§updates: Vec<NodeUpdate>

Piggybacked state updates.

§

Join

Join request from a new node.

Fields

§sender: NodeId
§sender_addr: SocketAddr
§

Welcome

Welcome response with current cluster state.

Fields

§sender: NodeId
§members: Vec<MemberInfo>
§

SlotsAnnounce

Direct slot announcement: the sender is telling peers its current slot ownership without going through the normal piggybacking mechanism. Used by broadcast_local_slots to eagerly push slot state to all peers.

Fields

§sender: NodeId
§incarnation: u64

Implementations§

Source§

impl GossipMessage

Source

pub fn encode(&self) -> Bytes

Serializes the message to bytes.

Source

pub fn encode_into(&self, buf: &mut BytesMut)

Serializes the message into the given buffer.

Source

pub fn decode(buf: &[u8]) -> Result<Self>

Deserializes a message from bytes.

Source

pub fn encode_authenticated(&self, secret: &ClusterSecret) -> Bytes

Encodes the message with a trailing HMAC-SHA256 tag.

Source

pub fn decode_authenticated(buf: &[u8], secret: &ClusterSecret) -> Result<Self>

Decodes a message, verifying the trailing HMAC-SHA256 tag first.

Returns an error if the buffer is too short or the tag doesn’t match.

Trait Implementations§

Source§

impl Clone for GossipMessage

Source§

fn clone(&self) -> GossipMessage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GossipMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for GossipMessage

Source§

fn eq(&self, other: &GossipMessage) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for GossipMessage

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> OptionalSend for T
where T: Send + ?Sized,

Source§

impl<T> OptionalSync for T
where T: Sync + ?Sized,