Struct CMClient 

pub struct CMClient { /* private fields */ }

The base client that handles the connection to a CM server. Use it through SteamClient.

Implementations

impl CMClient

pub fn new( configuration: Arc<SteamConfiguration>, identifier: &str, dispatcher: Arc<dyn ClientMsgDispatcher>, ) -> CMClient

Creates a client with the given configuration. The identifier must not be empty (the SteamClient constructors check this).

pub fn configuration(&self) -> &Arc<SteamConfiguration>

The configuration for this client.

pub fn id(&self) -> &str

A unique identifier for this client.

pub fn servers(&self) -> &Arc<SmartCMServerList>

The list of CM servers.

pub fn local_ip(&self) -> Option<IpAddr>

The local IP of the connection.

pub fn current_end_point(&self) -> Option<SocketAddr>

The endpoint we’re connected to.

pub fn public_ip(&self) -> Option<IpAddr>

Our public IP address, known after a successful logon.

pub fn ip_country_code(&self) -> Option<String>

The country code of our public IP, according to Steam.

pub fn user_country_code(&self) -> Option<String>

The country code of the account.

pub fn universe(&self) -> EUniverse

The universe of this client.

pub fn is_connected(&self) -> bool

Whether we’re connected to a CM server.

pub fn session_token(&self) -> u64

The session token assigned by the server.

pub fn cell_id(&self) -> Option<u32>

The cell id Steam recommends for this client.

pub fn session_id(&self) -> Option<i32>

The session id.

pub fn steam_id(&self) -> Option<SteamID>

The SteamID.

pub fn connection_timeout(&self) -> Duration

The timeout for connecting to a CM server.

pub fn debug_network_listener(&self) -> Option<Arc<dyn IDebugNetworkListener>>

The debug network listener, if any.

pub fn set_debug_network_listener( &self, listener: Option<Arc<dyn IDebugNetworkListener>>, )

Sets the debug network listener.

pub fn expect_disconnection(&self) -> bool

Whether the server is about to close the connection on purpose (e.g. after a log off).

pub fn set_expect_disconnection(&self, expect: bool)

Sets whether the server is about to close the connection on purpose.

pub fn set_connection_factory(&self, factory: ConnectionFactory)

Sets the factory that creates this client’s connections.

pub fn log_debug(&self, category: &str, message: &str)

Writes a line to the debug log under <client id>/<category>, and emits a tracing event too.

pub async fn connect( self: &Arc<Self>, cm_server: Option<ServerRecord>, ) -> Result<(), SteamError>

Connects to a CM server; if cm_server is None, the next one from the server list is used.

A logged-on session that the server closes is moved to another server automatically. Any other disconnect is reported, and it’s up to you to call this again.

pub async fn disconnect(&self)

Disconnects. Counts as user-initiated.

pub async fn disconnect_with(&self, user_initiated: bool)

Disconnects, saying whether it was user-initiated.

pub fn send(&self, msg: &dyn IClientMsg) -> Result<(), SteamError>

Sends a client message, filling in our session id and SteamID.

The message is taken by shared reference, so the session id and SteamID are written into the serialized bytes rather than into msg.

pub async fn on_client_connected(&self)

Called once the client is securely connected.

pub async fn on_client_disconnected(&self, user_initiated: bool)

Called when the connection is gone.

pub fn get_packet_msg(&self, data: Vec<u8>) -> Option<Box<dyn IPacketMsg>>

Parses a raw payload into a packet. Returns None if it can’t be parsed.

Trait Implementations

impl Debug for CMClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.