uk.co.thomasc.steamkit.steam3

Class CMClient

java.lang.Object

uk.co.thomasc.steamkit.steam3.CMClient

Direct Known Subclasses:

SteamClient

public abstract class CMClient
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
private EUniverse	connectedUniverse The universe.
(package private) Connection	connection
(package private) boolean	encrypted
(package private) ScheduledFunction	heartBeatFunc
(package private) short	PortCM_Public
(package private) short	PortCM_PublicEncrypted
(package private) Map<EServerType,List<IPEndPoint>>	serverMap
static InetAddress[]	Servers Bootstrap list of CM servers.
private Integer	sessionId The session ID.
private SteamID	steamId The SteamID.
(package private) byte[]	tempSessionKey

Constructor Summary

Constructors

Constructor and Description
CMClient()
CMClient(ProtocolType type) Initializes a new instance of the CMClient class with a specific connection type.

Method Summary

Methods

Modifier and Type	Method and Description
void	connect()
void	connect(boolean bEncrypted) Connects this client to a Steam3 server.
void	disconnect() Disconnects this client.
InetAddress	getLocalIP() Returns the the local IP of this client.
(package private) static IPacketMsg	getPacketMsg(byte[] data)
List<IPEndPoint>	getServersOfType(EServerType type) Returns the list of servers matching the given type
(package private) void	handleEncryptRequest(IPacketMsg packetMsg)
(package private) void	handleEncryptResult(IPacketMsg packetMsg)
(package private) void	handleLoggedOff(IPacketMsg packetMsg)
(package private) void	handleLogOnResponse(IPacketMsg packetMsg)
(package private) void	handleMulti(IPacketMsg packetMsg)
(package private) void	handleServerList(IPacketMsg packetMsg)
protected abstract void	onClientConnected() Called when the client is connected to Steam3 and is ready to send messages.
protected abstract void	onClientDisconnected() Called when the client is physically disconnected from Steam3.
protected void	onClientMsgReceived(IPacketMsg packetMsg) Called when a client message is received from the network.
void	send(IClientMsg msg) Sends the specified client message to the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PortCM_PublicEncrypted

final short PortCM_PublicEncrypted

See Also:

Constant Field Values

PortCM_Public

final short PortCM_Public

See Also:

Constant Field Values

Servers

public static final InetAddress[] Servers

Bootstrap list of CM servers.

connectedUniverse

private EUniverse connectedUniverse

The universe.

sessionId

private Integer sessionId

The session ID.

steamId

private SteamID steamId

The SteamID.

connection

Connection connection

tempSessionKey

byte[] tempSessionKey

encrypted

boolean encrypted

heartBeatFunc

ScheduledFunction heartBeatFunc

serverMap

Map<EServerType,List<IPEndPoint>> serverMap

Constructor Detail

CMClient

public CMClient()

CMClient

public CMClient(ProtocolType type)

Initializes a new instance of the CMClient class with a specific connection type.

Parameters:

type - The connection type to use.

Throws:

UnsupportedOperationException - The provided ProtocolType is not supported. Only Tcp and Udp are available.

Method Detail

getLocalIP

public InetAddress getLocalIP()

Returns the the local IP of this client.

Returns:

The local IP.

connect

public void connect()

connect

public void connect(boolean bEncrypted)

Connects this client to a Steam3 server. This begins the process of connecting and encrypting the data channel between the client and the server. Results are returned in a ConnectedCallback

Parameters:

bEncrypted - If set to true the underlying connection to Steam will be encrypted. This is the default mode of communication. Previous versions of SteamKit always used encryption.

disconnect

public void disconnect()

Disconnects this client.

send

public void send(IClientMsg msg)

Sends the specified client message to the server. This method automatically assigns the correct SessionID and SteamID of the message.

Parameters:

msg - The client message to send.

getServersOfType

public List<IPEndPoint> getServersOfType(EServerType type)

Returns the list of servers matching the given type

Parameters:

type - Server type requested

Returns:

List of server endpoints

onClientMsgReceived

protected void onClientMsgReceived(IPacketMsg packetMsg)
                            throws IOException

Called when a client message is received from the network.

Parameters:

packetMsg - The packet message.

Throws:

IOException

onClientDisconnected

protected abstract void onClientDisconnected()

Called when the client is physically disconnected from Steam3.

onClientConnected

protected abstract void onClientConnected()

Called when the client is connected to Steam3 and is ready to send messages.

getPacketMsg

static IPacketMsg getPacketMsg(byte[] data)

handleMulti

void handleMulti(IPacketMsg packetMsg)
           throws IOException

Throws:

IOException

handleLogOnResponse

void handleLogOnResponse(IPacketMsg packetMsg)

handleEncryptRequest

void handleEncryptRequest(IPacketMsg packetMsg)

handleEncryptResult

void handleEncryptResult(IPacketMsg packetMsg)

handleLoggedOff

void handleLoggedOff(IPacketMsg packetMsg)

handleServerList

void handleServerList(IPacketMsg packetMsg)