Struct OnlineManager 

pub struct OnlineManager { /* private fields */ }

Online user manager 在线用户管理器

Manages online users and handles real-time message pushing 管理在线用户并处理实时消息推送

Implementations

impl OnlineManager

pub fn new() -> OnlineManager

Create a new online manager 创建新的在线管理器

Example | 示例

let manager = OnlineManager::new();

pub async fn register_pusher(&self, pusher: Arc<dyn MessagePusher>)

Register a message pusher 注册消息推送器

Arguments | 参数

• pusher - Message pusher implementation | 消息推送器实现

Example | 示例

let pusher = Arc::new(MyCustomPusher::new());
manager.register_pusher(pusher).await;

pub async fn mark_online(&self, user: OnlineUser)

Mark a user as online 标记用户上线

Arguments | 参数

• user - Online user information | 在线用户信息

Example | 示例

let user = OnlineUser {
    login_id: "user123".to_string(),
    token: "token123".to_string(),
    device: "web".to_string(),
    connect_time: Utc::now(),
    last_activity: Utc::now(),
    metadata: HashMap::new(),
};
manager.mark_online(user).await;

pub async fn mark_offline(&self, login_id: &str, token: &str)

Mark a specific user session as offline 标记特定用户会话离线

Arguments | 参数

• login_id - User login ID | 用户登录 ID
• token - Session token to remove | 要移除的会话 Token

Example | 示例

manager.mark_offline("user123", "token123").await;

pub async fn mark_offline_all(&self, login_id: &str)

Mark all sessions of a user as offline 标记用户的所有会话离线

Arguments | 参数

• login_id - User login ID | 用户登录 ID

Example | 示例

manager.mark_offline_all("user123").await;

pub async fn is_online(&self, login_id: &str) -> bool

Check if a user is online 检查用户是否在线

Arguments | 参数

• login_id - User login ID | 用户登录 ID

Returns | 返回值

• true - User is online | 用户在线
• false - User is offline | 用户离线

Example | 示例

if manager.is_online("user123").await {
    println!("User is online");
}

pub async fn get_online_count(&self) -> usize

Get online user count 获取在线用户数量

Returns | 返回值

Number of online users | 在线用户数量

Example | 示例

let count = manager.get_online_count().await;
println!("{} users online", count);

pub async fn get_online_users(&self) -> Vec<String>

Get list of online user IDs 获取在线用户 ID 列表

Returns | 返回值

Vector of login IDs | 登录 ID 向量

Example | 示例

let users = manager.get_online_users().await;
for user_id in users {
    println!("User {} is online", user_id);
}

pub async fn get_user_sessions(&self, login_id: &str) -> Vec<OnlineUser>

Get all sessions for a specific user 获取特定用户的所有会话

Arguments | 参数

• login_id - User login ID | 用户登录 ID

Returns | 返回值

Vector of online user sessions | 在线用户会话向量

Example | 示例

let sessions = manager.get_user_sessions("user123").await;
println!("User has {} active sessions", sessions.len());

pub async fn update_activity(&self, login_id: &str, token: &str)

Update user activity timestamp 更新用户活跃时间戳

Arguments | 参数

• login_id - User login ID | 用户登录 ID
• token - Session token | 会话 Token

Example | 示例

manager.update_activity("user123", "token123").await;

pub async fn push_to_user( &self, login_id: &str, content: String, ) -> Result<(), SaTokenError>

Push a text message to a specific user 向特定用户推送文本消息

Arguments | 参数

• login_id - User login ID | 用户登录 ID
• content - Message content | 消息内容

Example | 示例

manager.push_to_user("user123", "Hello!".to_string()).await?;

pub async fn push_to_users( &self, login_ids: Vec<String>, content: String, ) -> Result<(), SaTokenError>

Push a message to multiple users 向多个用户推送消息

Arguments | 参数

• login_ids - List of user login IDs | 用户登录 ID 列表
• content - Message content | 消息内容

Example | 示例

let users = vec!["user1".to_string(), "user2".to_string()];
manager.push_to_users(users, "Broadcast!".to_string()).await?;

pub async fn broadcast(&self, content: String) -> Result<(), SaTokenError>

Broadcast a message to all online users 向所有在线用户广播消息

Arguments | 参数

• content - Message content | 消息内容

Example | 示例

manager.broadcast("System maintenance in 5 minutes".to_string()).await?;

pub async fn push_message_to_user( &self, login_id: &str, message: PushMessage, ) -> Result<(), SaTokenError>

Push a custom message to a user 向用户推送自定义消息

Arguments | 参数

• login_id - User login ID | 用户登录 ID
• message - Custom push message | 自定义推送消息

Example | 示例

let message = PushMessage {
    message_id: uuid::Uuid::new_v4().to_string(),
    content: "Custom content".to_string(),
    message_type: MessageType::Custom("event".to_string()),
    timestamp: Utc::now(),
    metadata: HashMap::new(),
};
manager.push_message_to_user("user123", message).await?;

pub async fn kick_out_notify( &self, login_id: &str, reason: String, ) -> Result<(), SaTokenError>

Kick out a user and send notification 踢出用户并发送通知

Arguments | 参数

• login_id - User login ID | 用户登录 ID
• reason - Kick-out reason | 踢出原因

Example | 示例

manager.kick_out_notify("user123", "Duplicate login detected".to_string()).await?;

Trait Implementations

impl Default for OnlineManager

fn default() -> OnlineManager

Returns the “default value” for a type.