Skip to main content

ProtocolMessage

Enum ProtocolMessage 

Source
pub enum ProtocolMessage {
    Handshake {
        node_name: String,
        group_name: String,
        node_type: NodeType,
    },
    HandshakeResponse {
        accepted: bool,
        reason: Option<String>,
    },
    Heartbeat {
        master_vlsn: u64,
        timestamp_ms: u64,
    },
    HeartbeatResponse {
        replica_vlsn: u64,
        timestamp_ms: u64,
    },
    LogEntry {
        vlsn: u64,
        entry_type: u8,
        data: Vec<u8>,
    },
    Ack {
        vlsn: u64,
    },
    GroupChange {
        change_type: GroupChangeType,
        node: RepNode,
    },
    GroupChangeResponse {
        accepted: bool,
    },
    ElectionProposal {
        node_name: String,
        vlsn: u64,
        priority: u32,
        term: u64,
        dtvlsn: u64,
    },
    ElectionVote {
        voter: String,
        granted: bool,
        term: u64,
    },
    ElectionResult {
        master: String,
        term: u64,
    },
    Shutdown {
        reason: String,
    },
}
Expand description

A message in the replication protocol.

These messages are exchanged between master and replica nodes for handshaking, heartbeats, log replication, elections, and group management.

Variants§

§

Handshake

Initial handshake from a node joining the replication stream.

Fields

§node_name: String
§group_name: String
§node_type: NodeType
§

HandshakeResponse

Response to a handshake.

Fields

§accepted: bool
§reason: Option<String>
§

Heartbeat

Heartbeat from master to replica.

Fields

§master_vlsn: u64
§timestamp_ms: u64
§

HeartbeatResponse

Heartbeat response from replica to master.

Fields

§replica_vlsn: u64
§timestamp_ms: u64
§

LogEntry

A log entry being replicated from master to replica.

Fields

§vlsn: u64
§entry_type: u8
§data: Vec<u8>
§

Ack

Acknowledgment of a replicated log entry.

Fields

§vlsn: u64
§

GroupChange

A group membership change request.

Fields

§change_type: GroupChangeType
§node: RepNode
§

GroupChangeResponse

Response to a group change request.

Fields

§accepted: bool
§

ElectionProposal

An election proposal from a candidate.

Fields

§node_name: String
§vlsn: u64
§priority: u32
§term: u64
§dtvlsn: u64

DTVLSN (the major election-ranking key, D2). 0 = UNINITIALIZED.

§

ElectionVote

A vote in response to an election proposal.

Fields

§voter: String
§granted: bool
§term: u64
§

ElectionResult

The result of an election.

Fields

§master: String
§term: u64
§

Shutdown

Graceful shutdown notification.

Fields

§reason: String

Implementations§

Source§

impl ProtocolMessage

Source

pub fn encode(&self) -> Vec<u8>

Encodes this message into a byte vector.

Format: [tag: u8][payload...] Strings are encoded as [len: u32 LE][utf8 bytes]. Booleans as a single byte (0 or 1). Integers as little-endian fixed-width.

Source

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

Decodes a message from a byte slice.

Trait Implementations§

Source§

impl Clone for ProtocolMessage

Source§

fn clone(&self) -> ProtocolMessage

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProtocolMessage

Source§

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

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

impl PartialEq for ProtocolMessage

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 ProtocolMessage

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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