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

//! 客户端事件处理器
//! 
//! 定义客户端事件处理接口，允许用户实现自定义业务逻辑

use crate::common::protocol::Frame;
use crate::common::protocol::flare::core::commands::system_command::Type as SysType;
use crate::common::protocol::flare::core::commands::message_command::Type as MsgType;
use crate::common::protocol::flare::core::commands::notification_command::Type as NotifType;
use crate::transport::events::ConnectionEvent;
use crate::common::error::Result;

/// 客户端事件处理器
/// 
/// 允许用户实现自定义逻辑来处理不同类型的客户端事件和命令
/// 
/// 所有方法都有默认实现，用户只需要实现需要的方法即可
#[async_trait::async_trait]
pub trait ClientEventHandler: Send + Sync {
    /// 处理系统命令
    /// 
    /// # 参数
    /// - `command_type`: 系统命令类型（CONNECT, CONNECT_ACK, PING, PONG, KICKED, ERROR, CLOSE）
    /// - `frame`: 完整的消息帧
    /// 
    /// # 返回
    /// - `Ok(Some(Frame))`: 需要发送的回复消息（可选）
    /// - `Ok(None)`: 不需要回复
    /// - `Err`: 处理失败
    async fn handle_system_command(&self, command_type: SysType, frame: &Frame) -> Result<Option<Frame>> {
        let _ = (command_type, frame);
        Ok(None)
    }
    
    /// 处理消息命令
    /// 
    /// # 参数
    /// - `command_type`: 消息命令类型
    /// - `frame`: 完整的消息帧
    /// 
    /// # 返回
    /// - `Ok(Some(Frame))`: 需要发送的回复消息（可选）
    /// - `Ok(None)`: 不需要回复
    /// - `Err`: 处理失败
    async fn handle_message_command(&self, command_type: MsgType, frame: &Frame) -> Result<Option<Frame>> {
        let _ = (command_type, frame);
        Ok(None)
    }
    
    /// 处理通知命令
    /// 
    /// # 参数
    /// - `command_type`: 通知命令类型
    /// - `frame`: 完整的消息帧
    /// 
    /// # 返回
    /// - `Ok(Some(Frame))`: 需要发送的回复消息（可选）
    /// - `Ok(None)`: 不需要回复
    /// - `Err`: 处理失败
    async fn handle_notification_command(&self, command_type: NotifType, frame: &Frame) -> Result<Option<Frame>> {
        let _ = (command_type, frame);
        Ok(None)
    }
    
    /// 处理连接事件
    /// 
    /// # 参数
    /// - `event`: 连接事件（Connected, Disconnected, Error）
    /// 
    /// # 返回
    /// - `Ok(())`: 处理成功
    /// - `Err`: 处理失败
    async fn handle_connection_event(&self, event: &ConnectionEvent) -> Result<()> {
        let _ = event;
        Ok(())
    }
}