crafty-proto 0.2.2

Wire types and postcard codec shared across the crafty framework.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

//! Cluster join handshake wire types over `/cluster/join` (join-rpc, join-version-skew).

use serde::{Deserialize, Serialize};

use crate::{Membership, NodeId};

/// A request from a new node asking to join the cluster.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct JoinRequest {
    /// Wire/protocol version of the joining node (join-version-skew).
    pub protocol_version: u32,
    /// Desired node id.
    pub node_id: NodeId,
    /// Address peers should use to reach the joining node.
    pub advertise_addr: String,
}

/// The response to a [`JoinRequest`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum JoinResponse {
    /// Join accepted; membership change committed by the leader.
    Accepted {
        /// Current leader.
        leader: NodeId,
        /// Resulting cluster membership.
        membership: Membership,
    },
    /// Contacted node is not the leader; retry against `leader`.
    Redirect {
        /// Best-known current leader, if any.
        leader: Option<NodeId>,
    },
    /// Join refused.
    Rejected {
        /// Why the join was refused.
        reason: JoinRejection,
    },
}

/// One node's advertised address, as gossiped in a [`PeerBook`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct PeerEntry {
    /// The node this address belongs to.
    pub node: NodeId,
    /// The address peers should dial to reach it (`host:port`).
    pub addr: String,
}

/// A snapshot of a node's known peer addresses, served over `/cluster/peers`
/// (discovery) so a newly joined node — and existing members — can learn how to
/// reach every peer without static, cluster-wide address configuration. This is
/// the address-plane counterpart to the Raft-replicated membership (which
/// carries only [`NodeId`]s, not addresses).
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct PeerBook {
    /// Known `(node, addr)` pairs, ascending by id.
    pub entries: Vec<PeerEntry>,
}

/// Reason a [`JoinRequest`] was rejected.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum JoinRejection {
    /// Protocol version mismatch — hard reject (join-version-skew).
    VersionSkew {
        /// Version the cluster expects.
        expected: u32,
        /// Version the joiner offered.
        got: u32,
    },
    /// The cluster is not currently accepting joins (`--allow-join` off).
    JoinsDisabled,
    /// A node with this id is already a member.
    Duplicate,
    /// Any other refusal, human-readable.
    Other(String),
}