gbp-core 1.2.1

Core type vocabulary for the Group Broadcast Protocol stack: stream classes, frame flags, FSM states, opcodes and the error code registry.
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

//! GBP control plane opcode registry.

/// Control plane opcode. Width: u16.
#[repr(u16)]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum ControlOpcode {
    /// Coordinator announces an upcoming epoch change.
    PrepareTransition = 0x0001,
    /// Member acknowledges that it is ready to apply the commit.
    ReadyForTransition = 0x0002,
    /// Coordinator: apply the new epoch.
    ExecuteTransition = 0x0003,
    /// Coordinator: abort the pending transition.
    AbortTransition = 0x0004,
    /// Request a digest of the current group state.
    GroupStateDigestRequest = 0x0005,
    /// Response to a [`GroupStateDigestRequest`](Self::GroupStateDigestRequest).
    GroupStateDigestResponse = 0x0006,
    /// Report an invalid MLS commit.
    ReportInvalidCommit = 0x0007,
    /// Capability advertisement (interoperability profile).
    CapabilitiesAdvertise = 0x0008,
    /// Positive acknowledgement.
    Ack = 0x0009,
    /// Negative acknowledgement carrying an `ErrorObject`.
    Nack = 0x000A,
}

impl ControlOpcode {
    /// Stable human-readable name suitable for logs and dumps.
    pub fn name(self) -> &'static str {
        use ControlOpcode::*;
        match self {
            PrepareTransition => "PREPARE_TRANSITION",
            ReadyForTransition => "READY_FOR_TRANSITION",
            ExecuteTransition => "EXECUTE_TRANSITION",
            AbortTransition => "ABORT_TRANSITION",
            GroupStateDigestRequest => "GROUP_STATE_DIGEST_REQUEST",
            GroupStateDigestResponse => "GROUP_STATE_DIGEST_RESPONSE",
            ReportInvalidCommit => "REPORT_INVALID_COMMIT",
            CapabilitiesAdvertise => "CAPABILITIES_ADVERTISE",
            Ack => "ACK",
            Nack => "NACK",
        }
    }
}

impl TryFrom<u16> for ControlOpcode {
    type Error = u16;
    fn try_from(v: u16) -> Result<Self, u16> {
        use ControlOpcode::*;
        Ok(match v {
            0x0001 => PrepareTransition,
            0x0002 => ReadyForTransition,
            0x0003 => ExecuteTransition,
            0x0004 => AbortTransition,
            0x0005 => GroupStateDigestRequest,
            0x0006 => GroupStateDigestResponse,
            0x0007 => ReportInvalidCommit,
            0x0008 => CapabilitiesAdvertise,
            0x0009 => Ack,
            0x000A => Nack,
            other => return Err(other),
        })
    }
}