gbp-core 1.0.0

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

//! GSP signal opcode registry.

/// Signal opcode. Allocation:
/// 1xx — membership, 2xx — media permissions, 3xx — stream, 4xx — config.
#[repr(u16)]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum SignalType {
    /// Member announces that it has joined the group.
    Join = 100,
    /// Member announces that it is leaving.
    Leave = 101,
    /// Member changes its role.
    RoleChange = 102,
    /// Mute request or notification.
    Mute = 200,
    /// Unmute request or notification.
    Unmute = 201,
    /// Start of a stream publication.
    StreamStart = 300,
    /// End of a stream publication.
    StreamStop = 301,
    /// Codec or SDP parameters update.
    CodecUpdate = 400,
}

impl TryFrom<u32> for SignalType {
    type Error = u32;
    fn try_from(v: u32) -> Result<Self, u32> {
        use SignalType::*;
        Ok(match v {
            100 => Join,
            101 => Leave,
            102 => RoleChange,
            200 => Mute,
            201 => Unmute,
            300 => StreamStart,
            301 => StreamStop,
            400 => CodecUpdate,
            other => return Err(other),
        })
    }
}

impl SignalType {
    /// Stable human-readable name suitable for logs.
    pub fn name(self) -> &'static str {
        use SignalType::*;
        match self {
            Join => "JOIN",
            Leave => "LEAVE",
            RoleChange => "ROLE_CHANGE",
            Mute => "MUTE",
            Unmute => "UNMUTE",
            StreamStart => "STREAM_START",
            StreamStop => "STREAM_STOP",
            CodecUpdate => "CODEC_UPDATE",
        }
    }
}