flare-core 0.1.2

A high-performance, reliable long-connection communication toolkit for Rust, supporting WebSocket and QUIC protocols with features like authentication, device management, serialization negotiation, and protocol racing.
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

use crate::common::error::FlareError;
use std::sync::Arc;

/// Represents events that occur on a connection.
///
/// This enum is used by the `ConnectionObserver` to react to various
/// states and data received on a connection.
#[derive(Debug, Clone)]
pub enum ConnectionEvent {
    /// Emitted when a connection is successfully established.
    Connected,
    /// Emitted when a connection is closed.
    /// The string parameter provides a reason for the disconnection.
    Disconnected(String),
    /// Emitted when a new message is received.
    /// The payload is a byte vector.
    Message(Vec<u8>),
    /// Emitted when a non-fatal error occurs on the connection.
    Error(FlareError),
}

/// An observer for connection events.
///
/// Implement this trait to react to events like connection establishment,
/// disconnection, and incoming messages. Observers are registered with
/// a `Connection` instance.
pub trait ConnectionObserver: Send + Sync {
    /// Called by the `Connection` when an event occurs.
    fn on_event(&self, event: &ConnectionEvent);
}

/// A type alias for a thread-safe, reference-counted observer.
pub type ArcObserver = Arc<dyn ConnectionObserver>;