uk.co.thomasc.steamkit.steam3.steamclient

Class SteamClient

java.lang.Object

uk.co.thomasc.steamkit.steam3.CMClient

uk.co.thomasc.steamkit.steam3.steamclient.SteamClient

public final class SteamClient
extends CMClient

Represents a single client that connects to the Steam3 network. This class is also responsible for handling the registration of client message handlers and callbacks.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Object	callbackLock
(package private) Queue<CallbackMsg>	callbackQueue
(package private) AtomicLong	currentJobId
(package private) Map<Class<? extends ClientMsgHandler>,ClientMsgHandler>	handlers

Fields inherited from class uk.co.thomasc.steamkit.steam3.CMClient

Servers

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addHandler(ClientMsgHandler handler) Adds a new handler to the internal list of message handlers.
void	freeLastCallback() Frees the last callback in the queue.
CallbackMsg	getCallback() Gets the next callback object in the queue.
CallbackMsg	getCallback(boolean freeLast) Gets the next callback object in the queue, and optionally frees it.
<T extends ClientMsgHandler> T	getHandler(Class<T> type) Returns a registered handler.
JobID	getNextJobID() Returns the next available JobID for job based messages.
(package private) void	handleEncryptResult(IPacketMsg packetMsg)
protected void	onClientConnected() Called when the client is connected to Steam3 and is ready to send messages.
protected 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	postCallback(CallbackMsg msg) Posts a callback to the queue.
void	removeHandler(Class<? extends ClientMsgHandler> handler) Removes a registered handler by name.
void	removeHandler(ClientMsgHandler handler) Removes a registered handler.
CallbackMsg	waitForCallback() Blocks the calling thread until a callback object is posted to the queue.
CallbackMsg	waitForCallback(boolean freeLast) Blocks the calling thread until a callback object is posted to the queue, and optionally frees it.
CallbackMsg	waitForCallback(boolean freeLast, long timeout) Blocks the calling thread until a callback object is posted to the queue, and optionally frees it.
CallbackMsg	waitForCallback(long timeout) Blocks the calling thread until a callback object is posted to the queue, or null after the timeout has elapsed.

Methods inherited from class uk.co.thomasc.steamkit.steam3.CMClient

connect, connect, disconnect, getLocalIP, getServersOfType, send

Methods inherited from class java.lang.Object

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

Field Detail

handlers

Map<Class<? extends ClientMsgHandler>,ClientMsgHandler> handlers

currentJobId

AtomicLong currentJobId

callbackLock

Object callbackLock

callbackQueue

Queue<CallbackMsg> callbackQueue

Constructor Detail

SteamClient

public SteamClient()

SteamClient

public SteamClient(ProtocolType type)

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

Parameters:

type - The connection type to use.

Method Detail

addHandler

public void addHandler(ClientMsgHandler handler)
                throws InvalidOpenTypeException

Adds a new handler to the internal list of message handlers.

Parameters:

handler - The handler to add.

Throws:

IllegalArgumentException - A handler of that type is already registered.

InvalidOpenTypeException

removeHandler

public void removeHandler(Class<? extends ClientMsgHandler> handler)

Removes a registered handler by name.

Parameters:

handler - The handler name to remove.

removeHandler

public void removeHandler(ClientMsgHandler handler)

Removes a registered handler.

Parameters:

handler - The handler to remove.

getHandler

public <T extends ClientMsgHandler> T getHandler(Class<T> type)

Returns a registered handler. T - The type of the handler to cast to. Must derive from ClientMsgHandler.

Returns:

A registered handler on success, or null if the handler could not be found.

getCallback

public CallbackMsg getCallback()

Gets the next callback object in the queue. This function does not dequeue the callback, you must call FreeLastCallback after processing it.

Returns:

The next callback in the queue, or null if no callback is waiting.

getCallback

public CallbackMsg getCallback(boolean freeLast)

Gets the next callback object in the queue, and optionally frees it.

Parameters:

freeLast - if set to true this function also frees the last callback if one existed.

Returns:

The next callback in the queue, or null if no callback is waiting.

waitForCallback

public CallbackMsg waitForCallback()

Blocks the calling thread until a callback object is posted to the queue. This function does not dequeue the callback, you must call FreeLastCallback after processing it.

Returns:

The callback object from the queue.

waitForCallback

public CallbackMsg waitForCallback(long timeout)

Blocks the calling thread until a callback object is posted to the queue, or null after the timeout has elapsed. This function does not dequeue the callback, you must call FreeLastCallback after processing it.

Parameters:

timeout - The length of time to block.

Returns:

A callback object from the queue if a callback has been posted, or null if the timeout has elapsed.

waitForCallback

public CallbackMsg waitForCallback(boolean freeLast)

Blocks the calling thread until a callback object is posted to the queue, and optionally frees it.

Parameters:

freeLast - if set to true this function also frees the last callback.

Returns:

The callback object from the queue.

waitForCallback

public CallbackMsg waitForCallback(boolean freeLast,
                          long timeout)

Blocks the calling thread until a callback object is posted to the queue, and optionally frees it.

Parameters:

freeLast - if set to true this function also frees the last callback.

timeout - The length of time to block.

Returns:

A callback object from the queue if a callback has been posted, or null if the timeout has elapsed.

freeLastCallback

public void freeLastCallback()

Frees the last callback in the queue.

postCallback

public void postCallback(CallbackMsg msg)

Posts a callback to the queue. This is normally used directly by client message handlers.

Parameters:

msg - The message.

getNextJobID

public JobID getNextJobID()

Returns the next available JobID for job based messages. This function is thread-safe.

Returns:

The next available JobID.

onClientMsgReceived

protected void onClientMsgReceived(IPacketMsg packetMsg)
                            throws IOException

Called when a client message is received from the network.

Overrides:

onClientMsgReceived in class CMClient

Parameters:

packetMsg - The packet message.

Throws:

IOException

onClientDisconnected

protected void onClientDisconnected()

Called when the client is physically disconnected from Steam3.

Specified by:

onClientDisconnected in class CMClient

onClientConnected

protected void onClientConnected()

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

Specified by:

onClientConnected in class CMClient

handleEncryptResult

void handleEncryptResult(IPacketMsg packetMsg)