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
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

//! 客户端传输协议模块
//! 
//! 提供多种传输协议的客户端实现：
//! - QUIC：基于 QUIC 协议的客户端
//! - WebSocket：基于 WebSocket 协议的客户端
//! - Hybrid：混合客户端，支持多种协议
//! 
//! 同时定义客户端的标准 trait 接口

use crate::common::error::Result;
use crate::common::protocol::Frame;
use crate::transport::events::ArcObserver;
use async_trait::async_trait;

/// 客户端标准接口
/// 
/// 实现此 trait 以创建自定义客户端实现
/// 
/// # 示例
/// 
/// ```rust
/// use flare_core::client::Client;
/// use flare_core::common::error::Result;
/// use flare_core::common::protocol::Frame;
/// 
/// struct MyCustomClient;
/// 
/// #[async_trait]
/// impl Client for MyCustomClient {
///     async fn connect(&mut self) -> Result<()> {
///         // 实现连接逻辑
///         Ok(())
///     }
///     
///     async fn disconnect(&mut self) -> Result<()> {
///         // 实现断开逻辑
///         Ok(())
///     }
///     
///     async fn send_frame(&mut self, frame: &Frame) -> Result<()> {
///         // 实现发送逻辑
///         Ok(())
///     }
///     
///     fn is_connected(&self) -> bool {
///         // 返回连接状态
///         true
///     }
///     
///     fn add_observer(&mut self, observer: ArcObserver) {
///         // 添加观察者
///     }
/// }
/// ```
#[async_trait]
pub trait Client: Send + Sync {
    /// 连接到服务器
    /// 
    /// # 返回
    /// 连接成功返回 `Ok(())`，失败返回错误
    async fn connect(&mut self) -> Result<()>;
    
    /// 断开连接
    /// 
    /// # 返回
    /// 断开成功返回 `Ok(())`，失败返回错误
    async fn disconnect(&mut self) -> Result<()>;
    
    /// 发送 Frame 消息
    /// 
    /// # 参数
    /// - `frame`: 要发送的 Frame
    /// 
    /// # 返回
    /// 发送成功返回 `Ok(())`，失败返回错误
    async fn send_frame(&mut self, frame: &Frame) -> Result<()>;
    
    /// 检查连接状态
    /// 
    /// # 返回
    /// 如果已连接返回 `true`，否则返回 `false`
    fn is_connected(&self) -> bool;
    
    /// 添加观察者
    /// 
    /// 观察者会收到连接事件和消息事件
    /// 
    /// # 参数
    /// - `observer`: 连接观察者
    fn add_observer(&mut self, observer: ArcObserver);
    
    /// 移除观察者
    /// 
    /// # 参数
    /// - `observer`: 要移除的观察者
    fn remove_observer(&mut self, observer: ArcObserver);
    
    /// 获取连接 ID（如果已连接）
    /// 
    /// # 返回
    /// 连接 ID，如果未连接则返回 `None`
    fn connection_id(&self) -> Option<String> {
        None
    }
}

pub mod quic;
pub mod hybrid;
pub mod websocket;
pub mod client_core;

// 重新导出常用类型
pub use quic::QUICClient;
pub use hybrid::HybridClient;
pub use websocket::WebSocketClient;
pub use client_core::ClientCore;