openrtc-netcode-core 0.1.0

Shared protocol types for OpenRTC netcode clients.
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use serde::{Deserialize, Serialize};
use serde_json::Value;

pub const NETCODE_PROTOCOL: &str = "openrtc-netcode";
pub const NETCODE_PROTOCOL_VERSION: u8 = 1;

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum EnvelopeKind {
    Hello,
    Peer,
    User,
    #[serde(rename = "state.snapshot")]
    StateSnapshot,
    #[serde(rename = "state.patch")]
    StatePatch,
    #[serde(rename = "lobby.meta")]
    LobbyMeta,
    #[serde(rename = "member.meta")]
    MemberMeta,
    Ping,
    Pong,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct NetcodeEnvelope<T = Value> {
    pub protocol: String,
    pub v: u8,
    pub kind: EnvelopeKind,
    #[serde(rename = "lobbyId")]
    pub lobby_id: String,
    pub from: String,
    pub seq: u64,
    #[serde(rename = "sentAt")]
    pub sent_at: u64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target: Option<String>,
    pub body: T,
}

impl<T> NetcodeEnvelope<T> {
    pub fn new(
        kind: EnvelopeKind,
        lobby_id: impl Into<String>,
        from: impl Into<String>,
        seq: u64,
        sent_at: u64,
        body: T,
    ) -> Self {
        Self {
            protocol: NETCODE_PROTOCOL.to_string(),
            v: NETCODE_PROTOCOL_VERSION,
            kind,
            lobby_id: lobby_id.into(),
            from: from.into(),
            seq,
            sent_at,
            target: None,
            body,
        }
    }

    pub fn with_target(mut self, target: impl Into<String>) -> Self {
        self.target = Some(target.into());
        self
    }

    pub fn validate(&self) -> Result<(), NetcodeProtocolError> {
        if self.protocol != NETCODE_PROTOCOL {
            return Err(NetcodeProtocolError::ProtocolMismatch);
        }
        if self.v != NETCODE_PROTOCOL_VERSION {
            return Err(NetcodeProtocolError::VersionMismatch(self.v));
        }
        if self.lobby_id.is_empty() {
            return Err(NetcodeProtocolError::MissingLobbyId);
        }
        if self.from.is_empty() {
            return Err(NetcodeProtocolError::MissingSender);
        }
        Ok(())
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum NetcodeProtocolError {
    ProtocolMismatch,
    VersionMismatch(u8),
    MissingLobbyId,
    MissingSender,
}

impl std::fmt::Display for NetcodeProtocolError {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::ProtocolMismatch => write!(formatter, "netcode protocol mismatch"),
            Self::VersionMismatch(version) => {
                write!(formatter, "unsupported netcode protocol version {version}")
            }
            Self::MissingLobbyId => write!(formatter, "netcode envelope missing lobby id"),
            Self::MissingSender => write!(formatter, "netcode envelope missing sender"),
        }
    }
}

impl std::error::Error for NetcodeProtocolError {}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct HelloBody {
    #[serde(rename = "peerId")]
    pub peer_id: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "displayName")]
    pub display_name: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct UserMessageBody {
    #[serde(rename = "type")]
    pub message_type: String,
    pub payload: Value,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct StateSnapshotBody {
    pub values: std::collections::BTreeMap<String, Value>,
    pub owners: std::collections::BTreeMap<String, String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct StatePatchBody {
    pub key: String,
    pub value: Value,
    pub owner: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MetadataBody {
    pub values: std::collections::BTreeMap<String, String>,
}

pub fn encode_envelope<T: Serialize>(envelope: &NetcodeEnvelope<T>) -> serde_json::Result<String> {
    serde_json::to_string(envelope)
}

pub fn decode_envelope(json: &str) -> serde_json::Result<NetcodeEnvelope<Value>> {
    serde_json::from_str(json)
}