msgtrans 1.0.10

Support for a variety of communication protocols such as TCP / QUIC / WebSocket, easy to create server and client network library.
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
use crate::{event::TransportEvent, packet::Packet, SessionId};
use futures::{Stream, StreamExt};
use std::pin::Pin;
use std::task::{Context, Poll};
use tokio::sync::{broadcast, mpsc};
use tokio_stream::wrappers::{errors::BroadcastStreamRecvError, BroadcastStream};

/// Unified event stream
///
/// Provides streaming access to transport events, supporting filtering and transformation
pub struct EventStream {
    /// Internal broadcast stream
    inner: BroadcastStream<TransportEvent>,
    /// Optional session filter
    session_filter: Option<SessionId>,
}

impl EventStream {
    /// Create new event stream
    pub fn new(receiver: broadcast::Receiver<TransportEvent>) -> Self {
        Self {
            inner: BroadcastStream::new(receiver),
            session_filter: None,
        }
    }

    /// Create event stream with session filter.
    ///
    /// Deprecated: session-level filtering cannot see core data events because
    /// `TransportEvent` does not carry a session id (only `RequestReceived` does),
    /// so `MessageReceived` / `ConnectionClosed` are silently dropped by the filter.
    /// Filter at the `ServerEvent` layer instead (e.g. `TransportServer::subscribe_events`
    /// or the `SessionHandler` API).
    #[deprecated(
        since = "1.0.7",
        note = "session filtering drops MessageReceived/ConnectionClosed; filter at the ServerEvent layer instead"
    )]
    pub fn with_session_filter(
        receiver: broadcast::Receiver<TransportEvent>,
        session_id: SessionId,
    ) -> Self {
        Self {
            inner: BroadcastStream::new(receiver),
            session_filter: Some(session_id),
        }
    }

    /// Filter events for specific session.
    ///
    /// Deprecated: filtering by session silently drops core data events; filter at
    /// the `ServerEvent` layer instead. See `with_session_filter` for details.
    #[deprecated(
        since = "1.0.7",
        note = "session filtering drops MessageReceived/ConnectionClosed; filter at the ServerEvent layer instead"
    )]
    pub fn filter_session(mut self, session_id: SessionId) -> Self {
        self.session_filter = Some(session_id);
        self
    }

    /// Get next connection event
    pub async fn next_connection_event(&mut self) -> Option<TransportEvent> {
        while let Some(result) = self.inner.next().await {
            if let Ok(event) = result {
                if self.should_emit_event(&event) && event.is_connection_event() {
                    return Some(event);
                }
            }
        }
        None
    }

    /// Get next data event
    pub async fn next_data_event(&mut self) -> Option<TransportEvent> {
        while let Some(result) = self.inner.next().await {
            if let Ok(event) = result {
                if self.should_emit_event(&event) && event.is_data_event() {
                    return Some(event);
                }
            }
        }
        None
    }

    /// Get next error event
    pub async fn next_error_event(&mut self) -> Option<TransportEvent> {
        while let Some(result) = self.inner.next().await {
            if let Ok(event) = result {
                if self.should_emit_event(&event) && event.is_error_event() {
                    return Some(event);
                }
            }
        }
        None
    }

    /// Check if event should be emitted (based on filter)
    fn should_emit_event(&self, event: &TransportEvent) -> bool {
        match self.session_filter {
            Some(filter_session_id) => match event.session_id() {
                Some(event_session_id) => event_session_id == filter_session_id,
                None => false,
            },
            None => true, // No filter, emit all events
        }
    }
}

impl Stream for EventStream {
    type Item = TransportEvent;

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        loop {
            match Pin::new(&mut self.inner).poll_next(cx) {
                Poll::Ready(Some(Ok(event))) => {
                    if self.should_emit_event(&event) {
                        return Poll::Ready(Some(event));
                    }
                    // Continue loop, get next event
                }
                Poll::Ready(Some(Err(BroadcastStreamRecvError::Lagged(skipped)))) => {
                    tracing::warn!(
                        "[STREAM] EventStream lagged, skipped {} transport events",
                        skipped
                    );
                    continue;
                }
                Poll::Ready(None) => {
                    return Poll::Ready(None);
                }
                Poll::Pending => {
                    return Poll::Pending;
                }
            }
        }
    }
}

/// Generic receiver
///
/// Solves Future state management issues in the original Stream trait implementation
/// Avoids recreating Future on poll_next by maintaining Future state
pub struct GenericReceiver<T> {
    /// Internal receiver
    receiver: mpsc::Receiver<T>,
    /// Current receive Future (may be None)
    #[allow(dead_code)]
    recv_future: Option<Pin<Box<dyn std::future::Future<Output = Option<T>> + Send>>>,
}

impl<T: Send + 'static> GenericReceiver<T> {
    /// Create new generic receiver
    pub fn new(receiver: mpsc::Receiver<T>) -> Self {
        Self {
            receiver,
            recv_future: None,
        }
    }

    /// Non-blocking attempt to receive
    pub fn try_recv(&mut self) -> Result<T, mpsc::error::TryRecvError> {
        self.receiver.try_recv()
    }

    /// Asynchronous receive
    pub async fn recv(&mut self) -> Option<T> {
        self.receiver.recv().await
    }

    /// Close receiver
    pub fn close(&mut self) {
        self.receiver.close();
    }
}

impl<T: Send + 'static> Stream for GenericReceiver<T> {
    type Item = T;

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        // Poll receiver directly
        self.receiver.poll_recv(cx)
    }
}

/// Packet stream
///
/// Stream specifically for handling packets
pub struct PacketStream {
    /// Internal event stream
    event_stream: EventStream,
}

impl PacketStream {
    /// Create new packet stream
    pub fn new(receiver: broadcast::Receiver<TransportEvent>) -> Self {
        Self {
            event_stream: EventStream::new(receiver),
        }
    }

    /// Create packet stream with session filter.
    ///
    /// Deprecated: session filtering drops core data events; filter at the
    /// `ServerEvent` layer instead. See `EventStream::with_session_filter`.
    #[deprecated(
        since = "1.0.7",
        note = "session filtering drops MessageReceived/ConnectionClosed; filter at the ServerEvent layer instead"
    )]
    #[allow(deprecated)]
    pub fn with_session_filter(
        receiver: broadcast::Receiver<TransportEvent>,
        session_id: SessionId,
    ) -> Self {
        Self {
            event_stream: EventStream::with_session_filter(receiver, session_id),
        }
    }

    /// Get next packet
    pub async fn next_packet(&mut self) -> Option<Packet> {
        while let Some(event) = self.event_stream.next().await {
            if let crate::event::TransportEvent::MessageReceived(packet) = event {
                return Some(packet);
            }
        }
        None
    }
}

impl Stream for PacketStream {
    type Item = Packet;

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        loop {
            match Pin::new(&mut self.event_stream).poll_next(cx) {
                Poll::Ready(Some(crate::event::TransportEvent::MessageReceived(packet))) => {
                    return Poll::Ready(Some(packet));
                }
                Poll::Ready(Some(_)) => {
                    continue;
                }
                Poll::Ready(None) => {
                    return Poll::Ready(None);
                }
                Poll::Pending => {
                    return Poll::Pending;
                }
            }
        }
    }
}

/// Connection event stream
///
/// Specifically handles connection establishment and closing events
pub struct ConnectionStream {
    /// Internal event stream
    event_stream: EventStream,
}

impl ConnectionStream {
    /// Create new connection event stream
    pub fn new(receiver: broadcast::Receiver<TransportEvent>) -> Self {
        Self {
            event_stream: EventStream::new(receiver),
        }
    }

    /// Get next connection event
    pub async fn next_connection(&mut self) -> Option<ConnectionEvent> {
        while let Some(event) = self.event_stream.next().await {
            match event {
                TransportEvent::ConnectionEstablished { info } => {
                    return Some(ConnectionEvent::Established { info });
                }
                TransportEvent::ConnectionClosed { reason } => {
                    return Some(ConnectionEvent::Closed { reason });
                }
                _ => continue,
            }
        }
        None
    }
}

impl Stream for ConnectionStream {
    type Item = ConnectionEvent;

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        loop {
            match Pin::new(&mut self.event_stream).poll_next(cx) {
                Poll::Ready(Some(TransportEvent::ConnectionEstablished { info })) => {
                    return Poll::Ready(Some(ConnectionEvent::Established { info }));
                }
                Poll::Ready(Some(TransportEvent::ConnectionClosed { reason })) => {
                    return Poll::Ready(Some(ConnectionEvent::Closed { reason }));
                }
                Poll::Ready(Some(_)) => {
                    // Other events, continue loop
                    continue;
                }
                Poll::Ready(None) => {
                    return Poll::Ready(None);
                }
                Poll::Pending => {
                    return Poll::Pending;
                }
            }
        }
    }
}

/// Connection event
#[derive(Debug, Clone)]
pub enum ConnectionEvent {
    /// Connection established
    Established {
        info: crate::command::ConnectionInfo,
    },
    /// Connection closed
    Closed { reason: crate::CloseReason },
}

/// Stream factory
///
/// Provides convenient methods for creating various types of streams
pub struct StreamFactory;

impl StreamFactory {
    /// Create event stream
    pub fn event_stream(receiver: broadcast::Receiver<TransportEvent>) -> EventStream {
        EventStream::new(receiver)
    }

    /// Create packet stream
    pub fn packet_stream(receiver: broadcast::Receiver<TransportEvent>) -> PacketStream {
        PacketStream::new(receiver)
    }

    /// Create connection stream
    pub fn connection_stream(receiver: broadcast::Receiver<TransportEvent>) -> ConnectionStream {
        ConnectionStream::new(receiver)
    }

    /// Create session-filtered event stream.
    ///
    /// Deprecated: session filtering drops core data events; filter at the
    /// `ServerEvent` layer instead. See `EventStream::with_session_filter`.
    #[deprecated(
        since = "1.0.7",
        note = "session filtering drops MessageReceived/ConnectionClosed; filter at the ServerEvent layer instead"
    )]
    #[allow(deprecated)]
    pub fn session_event_stream(
        receiver: broadcast::Receiver<TransportEvent>,
        session_id: SessionId,
    ) -> EventStream {
        EventStream::with_session_filter(receiver, session_id)
    }

    /// Create session-filtered packet stream.
    ///
    /// Deprecated: session filtering drops core data events; filter at the
    /// `ServerEvent` layer instead. See `EventStream::with_session_filter`.
    #[deprecated(
        since = "1.0.7",
        note = "session filtering drops MessageReceived/ConnectionClosed; filter at the ServerEvent layer instead"
    )]
    #[allow(deprecated)]
    pub fn session_packet_stream(
        receiver: broadcast::Receiver<TransportEvent>,
        session_id: SessionId,
    ) -> PacketStream {
        PacketStream::with_session_filter(receiver, session_id)
    }

    /// Create client event stream (hide session ID)
    pub fn client_event_stream(
        receiver: tokio::sync::broadcast::Receiver<crate::event::TransportEvent>,
    ) -> ClientEventStream {
        ClientEventStream::new(receiver)
    }
}

/// Stream combinator
///
/// Provides stream combination and transformation functionality
pub struct StreamCombinator;

impl StreamCombinator {
    /// Merge multiple event streams
    pub fn merge_event_streams(streams: Vec<EventStream>) -> impl Stream<Item = TransportEvent> {
        futures::stream::select_all(streams)
    }

    /// Convert event stream to packet stream
    pub fn events_to_packets(event_stream: EventStream) -> impl Stream<Item = Packet> {
        event_stream.filter_map(|event| async move {
            match event {
                crate::event::TransportEvent::MessageReceived(packet) => Some(packet),
                _ => None,
            }
        })
    }

    /// Convert event stream to connection event stream
    pub fn events_to_connections(event_stream: EventStream) -> impl Stream<Item = ConnectionEvent> {
        event_stream.filter_map(|event| async move {
            match event {
                TransportEvent::ConnectionEstablished { info } => {
                    Some(ConnectionEvent::Established { info })
                }
                TransportEvent::ConnectionClosed { reason } => {
                    Some(ConnectionEvent::Closed { reason })
                }
                _ => None,
            }
        })
    }
}

// Add extension trait for broadcast::Receiver
pub trait ReceiverExt {
    /// Convert to event stream
    fn into_event_stream(self) -> EventStream;

    /// Convert to packet stream
    fn into_packet_stream(self) -> PacketStream;

    /// Convert to connection stream
    fn into_connection_stream(self) -> ConnectionStream;
}

impl ReceiverExt for broadcast::Receiver<TransportEvent> {
    fn into_event_stream(self) -> EventStream {
        EventStream::new(self)
    }

    fn into_packet_stream(self) -> PacketStream {
        PacketStream::new(self)
    }

    fn into_connection_stream(self) -> ConnectionStream {
        ConnectionStream::new(self)
    }
}

/// Client event stream - hides session ID concept
pub struct ClientEventStream {
    inner: tokio::sync::broadcast::Receiver<crate::event::TransportEvent>,
}

impl ClientEventStream {
    /// Create new client event stream
    pub fn new(receiver: tokio::sync::broadcast::Receiver<crate::event::TransportEvent>) -> Self {
        Self { inner: receiver }
    }

    /// Receive next client event
    pub async fn next(
        &mut self,
    ) -> Result<crate::event::ClientEvent, crate::error::TransportError> {
        loop {
            match self.inner.recv().await {
                Ok(transport_event) => {
                    // Convert to client event, filter out irrelevant events
                    if let Some(client_event) =
                        crate::event::ClientEvent::from_transport_event(transport_event)
                    {
                        return Ok(client_event);
                    }
                    // If it's an irrelevant event, continue looping to wait for next event
                }
                Err(tokio::sync::broadcast::error::RecvError::Closed) => {
                    return Err(crate::error::TransportError::connection_error(
                        "Event stream closed",
                        false,
                    ));
                }
                Err(tokio::sync::broadcast::error::RecvError::Lagged(skipped)) => {
                    tracing::warn!(
                        "[STREAM] ClientEventStream lagged, skipped {} transport events",
                        skipped
                    );
                    continue;
                }
            }
        }
    }

    /// Try to receive event (non-blocking)
    pub fn try_next(
        &mut self,
    ) -> Result<Option<crate::event::ClientEvent>, crate::error::TransportError> {
        loop {
            match self.inner.try_recv() {
                Ok(transport_event) => {
                    // Convert to client event, filter out irrelevant events
                    if let Some(client_event) =
                        crate::event::ClientEvent::from_transport_event(transport_event)
                    {
                        return Ok(Some(client_event));
                    }
                    // If it's an irrelevant event, continue looping
                }
                Err(tokio::sync::broadcast::error::TryRecvError::Empty) => {
                    return Ok(None);
                }
                Err(tokio::sync::broadcast::error::TryRecvError::Closed) => {
                    return Err(crate::error::TransportError::connection_error(
                        "Event stream closed",
                        false,
                    ));
                }
                Err(tokio::sync::broadcast::error::TryRecvError::Lagged(skipped)) => {
                    tracing::warn!(
                        "[STREAM] ClientEventStream lagged, skipped {} transport events",
                        skipped
                    );
                    continue;
                }
            }
        }
    }
}