gbp-core 1.1.4

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

//! GBP frame delivery flags.
//!
//! * `O` (ordered)  — preserve in-stream ordering.
//! * `R` (reliable) — retransmit until ACK / NACK / timeout.
//! * `A` (ack-req)  — acknowledgement is mandatory.
//! * `S` (system)   — control plane frame; receiver MUST process it before
//!   application delivery.
//! * `C` (critical) — frame MUST match the receiver's current `transition_id`.

/// Bit set on top of `u16`. Hand-rolled to keep `gbp-core` free of any
/// dependency tree.
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct GbpFlags(pub u16);

impl GbpFlags {
    /// Bit 0: ordered.
    pub const ORDERED: u16 = 0x0001;
    /// Bit 1: reliable.
    pub const RELIABLE: u16 = 0x0002;
    /// Bit 2: ack required.
    pub const ACK_REQ: u16 = 0x0004;
    /// Bit 3: system frame.
    pub const SYSTEM: u16 = 0x0008;
    /// Bit 4: critical (must match the current transition_id).
    pub const CRITICAL: u16 = 0x0010;

    /// Constructs a flag set from raw bits.
    pub const fn from_bits(bits: u16) -> Self {
        Self(bits)
    }

    /// Returns `true` if the given bit is set.
    pub const fn has(self, bit: u16) -> bool {
        self.0 & bit != 0
    }

    /// `O | R | A` profile — chat / signaling messages.
    pub const fn ordered_reliable_ack() -> u16 {
        Self::ORDERED | Self::RELIABLE | Self::ACK_REQ
    }

    /// `O | R | S` profile — control plane (system).
    pub const fn ordered_reliable_system() -> u16 {
        Self::ORDERED | Self::RELIABLE | Self::SYSTEM
    }

    /// `O` profile — best-effort ordered (voice and other real-time media).
    pub const fn ordered_only() -> u16 {
        Self::ORDERED
    }
}