tehuti 0.22.0

Modular communication system for game development.
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
use crate::{
    channel::Channel,
    engine::{EngineId, EnginePeerDescriptor},
    event::Duplex,
    peer::{Peer, PeerBuildResult, PeerFactory, PeerId, PeerInfo, PeerRoleId},
};
use std::{
    collections::BTreeMap,
    error::Error,
    ops::Deref,
    pin::Pin,
    sync::Arc,
    task::{Context, Poll},
};

#[derive(Debug)]
pub enum MeetingEngineEvent {
    /// Notification that the meeting has been destroyed.
    MeetingDestroyed,
    /// Notification that a peer has been created.
    PeerCreated(EnginePeerDescriptor),
    /// Notification that a peer has been destroyed.
    PeerDestroyed(PeerId),
    /// Notification that a peer has joined.
    PeerJoined(EngineId, PeerId, PeerRoleId),
    /// Notification that a peer has left.
    PeerLeft(PeerId),
}

#[derive(Debug)]
pub enum MeetingUserEvent {
    /// Request to create a peer with the given ID and role.
    PeerCreate(PeerId, PeerRoleId),
    /// Request to destroy the peer with the given ID.
    PeerDestroy(PeerId),
    /// Response that a peer has been added.
    PeerAdded(Peer),
    /// Response that a peer has been removed.
    PeerRemoved(PeerId),
}

/// User-side container for peers and channels.
/// The goal of a meeting is to replicate a multi-peer environment.
pub struct Meeting {
    factory: Arc<PeerFactory>,
    engine_event: Duplex<MeetingEngineEvent>,
    user_event: Duplex<MeetingUserEvent>,
    peers: BTreeMap<PeerId, Vec<Channel>>,
    name: String,
    peer_kill_event: Duplex<PeerId>,
}

impl Drop for Meeting {
    fn drop(&mut self) {
        let _ = self
            .engine_event
            .sender
            .send(MeetingEngineEvent::MeetingDestroyed);
        tracing::event!(
            target: "tehuti::meeting",
            tracing::Level::TRACE,
            "Meeting closed: {}",
            self.name
        );
    }
}

impl Meeting {
    pub fn new(
        factory: Arc<PeerFactory>,
        engine_event: Duplex<MeetingEngineEvent>,
        user_event: Duplex<MeetingUserEvent>,
        name: impl ToString,
    ) -> Self {
        let name = name.to_string();
        tracing::event!(
            target: "tehuti::meeting",
            tracing::Level::TRACE,
            "Meeting opened: {}",
            name
        );
        Self {
            factory,
            engine_event,
            user_event,
            peers: Default::default(),
            name,
            peer_kill_event: Duplex::unbounded(),
        }
    }

    pub fn name(&self) -> &str {
        &self.name
    }

    pub fn factory(&self) -> &Arc<PeerFactory> {
        &self.factory
    }

    pub fn peers(&self) -> impl Iterator<Item = PeerId> {
        self.peers.keys().copied()
    }

    pub fn pump(&mut self) -> Result<bool, Box<dyn Error>> {
        let mut result = false;
        if let Some(event) = self.peer_kill_event.receiver.try_recv() {
            self.handle_peer_kill(event)?;
            result = true;
        }
        if let Some(event) = self.engine_event.receiver.try_recv() {
            self.handle_engine_event(event)?;
            result = true;
        }
        if let Some(event) = self.user_event.receiver.try_recv() {
            self.handle_user_event(event)?;
            result = true;
        }
        for peer in self.peers.values_mut() {
            for channel in peer {
                let pumped = channel.pump()?;
                result = result || pumped;
            }
        }
        Ok(result)
    }

    pub fn pump_all(&mut self) -> Result<bool, Box<dyn Error>> {
        let mut result = false;
        if let Some(event) = self.peer_kill_event.receiver.try_recv() {
            self.handle_peer_kill(event)?;
            result = true;
        }
        while let Some(event) = self.engine_event.receiver.try_recv() {
            self.handle_engine_event(event)?;
            result = true;
        }
        while let Some(event) = self.user_event.receiver.try_recv() {
            self.handle_user_event(event)?;
            result = true;
        }
        for peer in self.peers.values_mut() {
            for channel in peer {
                let pumped = channel.pump_all()? > 0;
                result = result || pumped;
            }
        }
        Ok(result)
    }

    fn handle_peer_kill(&mut self, peer_id: PeerId) -> Result<(), Box<dyn Error>> {
        if self.peers.remove(&peer_id).is_some() {
            tracing::event!(
                target: "tehuti::meeting",
                tracing::Level::TRACE,
                "Meeting {} peer killed: {:?}",
                self.name,
                peer_id
            );
            self.engine_event
                .sender
                .send(MeetingEngineEvent::PeerDestroyed(peer_id))
                .map_err(|err| format!("Engine event sender error: {err}"))?;
            self.user_event
                .sender
                .send(MeetingUserEvent::PeerRemoved(peer_id))
                .map_err(|err| format!("User event sender error: {err}"))?;
        } else {
            tracing::event!(
                target: "tehuti::meeting",
                tracing::Level::WARN,
                "Meeting {} peer kill request for non-existent peer: {:?}",
                self.name,
                peer_id
            );
        }
        Ok(())
    }

    fn handle_engine_event(&mut self, event: MeetingEngineEvent) -> Result<(), Box<dyn Error>> {
        tracing::event!(
            target: "tehuti::meeting",
            tracing::Level::TRACE,
            "Meeting {} handle engine event: {:?}",
            self.name,
            event
        );
        match event {
            MeetingEngineEvent::PeerJoined(engine_id, peer_id, role_id) => {
                let PeerBuildResult {
                    mut peer,
                    channels,
                    mut descriptor,
                } = self.factory.create(Peer::new(
                    PeerInfo {
                        peer_id,
                        role_id,
                        remote: true,
                    },
                    self.peer_kill_event.sender.clone(),
                ))?;
                descriptor.origin_engine = Some(engine_id);
                if self.peers.contains_key(&peer.info().peer_id) {
                    unsafe { peer.set_destroy_on_drop(false) };
                    return Err(
                        format!("Joined peer {:?} already exists", peer.info().peer_id).into(),
                    );
                }
                self.peers.insert(peer.info().peer_id, channels);
                tracing::event!(
                    target: "tehuti::meeting",
                    tracing::Level::TRACE,
                    "Meeting {} peer joined: {:?}",
                    self.name,
                    peer.info()
                );
                self.engine_event
                    .sender
                    .send(MeetingEngineEvent::PeerCreated(descriptor))
                    .map_err(|err| format!("Engine event sender error: {err}"))?;
                self.user_event
                    .sender
                    .send(MeetingUserEvent::PeerAdded(peer))
                    .map_err(|err| format!("User event sender error: {err}"))?;
            }
            MeetingEngineEvent::PeerLeft(peer_id) => {
                if self.peers.remove(&peer_id).is_some() {
                    tracing::event!(
                        target: "tehuti::meeting",
                        tracing::Level::TRACE,
                        "Meeting {} peer left: {:?}",
                        self.name,
                        peer_id
                    );
                    self.engine_event
                        .sender
                        .send(MeetingEngineEvent::PeerDestroyed(peer_id))
                        .map_err(|err| format!("Engine event sender error: {err}"))?;
                    self.user_event
                        .sender
                        .send(MeetingUserEvent::PeerRemoved(peer_id))
                        .map_err(|err| format!("User event sender error: {err}"))?;
                } else {
                    tracing::event!(
                        target: "tehuti::meeting",
                        tracing::Level::WARN,
                        "Meeting {} peer left event for non-existent peer: {:?}",
                        self.name,
                        peer_id
                    );
                }
            }
            _ => {
                tracing::event!(
                    target: "tehuti::meeting",
                    tracing::Level::WARN,
                    "Meeting {} received unhandled engine event: {:?}",
                    self.name,
                    event
                );
            }
        }
        Ok(())
    }

    fn handle_user_event(&mut self, event: MeetingUserEvent) -> Result<(), Box<dyn Error>> {
        tracing::event!(
            target: "tehuti::meeting",
            tracing::Level::TRACE,
            "Meeting {} handle user event: {:?}",
            self.name,
            event
        );
        match event {
            MeetingUserEvent::PeerCreate(peer_id, role_id) => {
                let PeerBuildResult {
                    mut peer,
                    channels,
                    descriptor,
                } = self.factory.create(Peer::new(
                    PeerInfo {
                        peer_id,
                        role_id,
                        remote: false,
                    },
                    self.peer_kill_event.sender.clone(),
                ))?;
                if self.peers.contains_key(&peer.info().peer_id) {
                    unsafe { peer.set_destroy_on_drop(false) };
                    return Err(
                        format!("Created peer {:?} already exists", peer.info().peer_id).into(),
                    );
                }
                self.peers.insert(peer.info().peer_id, channels);
                tracing::event!(
                    target: "tehuti::meeting",
                    tracing::Level::TRACE,
                    "Meeting {} peer created: {:?}",
                    self.name,
                    peer.info()
                );
                self.engine_event
                    .sender
                    .send(MeetingEngineEvent::PeerCreated(descriptor))
                    .map_err(|err| format!("Engine event sender error: {err}"))?;
                self.user_event
                    .sender
                    .send(MeetingUserEvent::PeerAdded(peer))
                    .map_err(|err| format!("User event sender error: {err}"))?;
            }
            MeetingUserEvent::PeerDestroy(peer_id) => {
                if self.peers.remove(&peer_id).is_some() {
                    tracing::event!(
                        target: "tehuti::meeting",
                        tracing::Level::TRACE,
                        "Meeting {} peer destroyed: {:?}",
                        self.name,
                        peer_id
                    );
                    self.engine_event
                        .sender
                        .send(MeetingEngineEvent::PeerDestroyed(peer_id))
                        .map_err(|err| format!("Engine event sender error: {err}"))?;
                    self.user_event
                        .sender
                        .send(MeetingUserEvent::PeerRemoved(peer_id))
                        .map_err(|err| format!("User event sender error: {err}"))?;
                } else {
                    tracing::event!(
                        target: "tehuti::meeting",
                        tracing::Level::WARN,
                        "Meeting {} peer destroy request for non-existent peer: {:?}",
                        self.name,
                        peer_id
                    );
                }
            }
            _ => {
                tracing::event!(
                    target: "tehuti::meeting",
                    tracing::Level::WARN,
                    "Meeting {} received unhandled user event: {:?}",
                    self.name,
                    event
                );
            }
        }
        Ok(())
    }
}

impl Future for Meeting {
    type Output = Result<(), Box<dyn Error>>;

    fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        match self.pump() {
            Ok(true) => Poll::Ready(Ok(())),
            Ok(false) => {
                cx.waker().wake_by_ref();
                Poll::Pending
            }
            Err(e) => Poll::Ready(Err(e)),
        }
    }
}

pub struct MeetingInterfaceResult {
    pub meeting: Meeting,
    pub interface: MeetingInterface,
    pub engine_event: Duplex<MeetingEngineEvent>,
}

#[derive(Clone)]
pub struct MeetingInterface {
    user_event: Duplex<MeetingUserEvent>,
}

impl MeetingInterface {
    pub fn make(factory: Arc<PeerFactory>, name: impl ToString) -> MeetingInterfaceResult {
        let (inside_engine, outside_engine) = Duplex::crossing_unbounded();
        let (inside_user, outside_user) = Duplex::crossing_unbounded();
        let meeting = Meeting::new(factory, inside_engine, inside_user, name);
        MeetingInterfaceResult {
            meeting,
            interface: Self {
                user_event: outside_user,
            },
            engine_event: outside_engine,
        }
    }
}

impl Deref for MeetingInterface {
    type Target = Duplex<MeetingUserEvent>;

    fn deref(&self) -> &Self::Target {
        &self.user_event
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_async() {
        fn is_send<T: Send>() {}

        is_send::<MeetingEngineEvent>();
        is_send::<MeetingUserEvent>();
        is_send::<Meeting>();
    }
}