steamkit-rs 0.1.0

Rust port of SteamKit2, a .NET library that aims to interoperate with the Steam network.
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

//! The trait every message handler implements.
//!
//! Handlers keep a `Weak<SteamClient>` back-reference, and the client is also
//! passed to [`ClientMsgHandler::handle_msg`], so a handler can reply without
//! holding a strong reference to the client (which would be a cycle).
//!
//! To expect a disconnect (e.g. before logging off), handlers call
//! `SteamClient::set_expect_disconnection`.

use async_trait::async_trait;

use crate::base::packet_base::IPacketMsg;
use crate::error::SteamResult;
use crate::steam::steam_client::steam_client::SteamClient;

/// A message handler. It gets the incoming messages it cares about and replies
/// through the [`SteamClient`].
#[async_trait]
pub trait ClientMsgHandler: Send + Sync {
    /// Handles a client message. Called by the client; don't call it yourself.
    async fn handle_msg(
        &self,
        client: &SteamClient,
        packet_msg: &dyn IPacketMsg,
    ) -> SteamResult<()>;
}