CMClient

abstract class CMClient

This base client handles the underlying connection to a CM server. This class should not be use directly, but through the SteamClient class.

Inheritors

Constructors

Link copied to clipboard
constructor(configuration: SteamConfiguration)

Properties

Link copied to clipboard
@Nullable
@get:Nullable
open val cellID: @Nullable Integer
Link copied to clipboard
Link copied to clipboard
@Nullable
@get:Nullable
open val ipCountryCode: @Nullable String
Link copied to clipboard
Link copied to clipboard
@Nullable
@get:Nullable
open val publicIP: @Nullable InetAddress
Link copied to clipboard
@Nullable
@get:Nullable
open val sessionID: @Nullable Integer
Link copied to clipboard
open val sessionToken: Long
Link copied to clipboard
@Nullable
@get:Nullable
open val steamID: @Nullable SteamID

Functions

Link copied to clipboard
open fun connect()
open fun connect(cmServer: ServerRecord)
Connects this client to a Steam3 server.
Link copied to clipboard
open fun disconnect()
Disconnects this client.
Link copied to clipboard
Gets or sets the connection timeout used when connecting to the Steam server.
Link copied to clipboard
@Nullable
open fun getCurrentEndpoint(): @Nullable InetSocketAddress
Returns the current endpoint this client is connected to.
Link copied to clipboard
@Nullable
open fun getLocalIP(): @Nullable InetAddress
Returns the local IP of this client.
Link copied to clipboard
open fun getPacketMsg(data: Array<Byte>): IPacketMsg
Link copied to clipboard
Link copied to clipboard
open fun getUniverse(): EUniverse
Gets the universe of this client.
Link copied to clipboard
Gets a value indicating whether isConnected and connection is not connected to the remote CM server.
Link copied to clipboard
Link copied to clipboard
open fun receiveTestPacketMsg(packetMsg: IPacketMsg)
Debugging only method: Do not use this directly.
Link copied to clipboard
open fun send(msg: IClientMsg)
Sends the specified client message to the server.
Link copied to clipboard
open fun setExpectDisconnection(expectDisconnection: Boolean)