Package in.dragonbra.javasteam.handlers

Class ClientMsgHandler

java.lang.Object

in.dragonbra.javasteam.handlers.ClientMsgHandler

Direct Known Subclasses:

SteamApps, SteamCloud, SteamFriends, SteamGameCoordinator, SteamGameServer, SteamMasterServer, SteamNotifications, SteamScreenshots, SteamTrading, SteamUnifiedMessages, SteamUser, SteamUserStats, SteamWorkshop

public abstract class ClientMsgHandler
extends java.lang.Object

This class implements the base requirements every message handler should inherit from.

Field Summary

Fields

Modifier and Type	Field	Description
protected SteamClient	client

Constructor Summary

Constructors

Constructor	Description
ClientMsgHandler()

Method Summary

Modifier and Type	Method	Description
SteamClient	getClient()
abstract void	handleMsg(IPacketMsg packetMsg)	Handles a client message.
protected boolean	isExpectDisconnection()	Gets whether or not the related SteamClient should imminently expect the server to close the connection.
protected void	setExpectDisconnection(boolean expectDisconnection)	Sets whether or not the related SteamClient should imminently expect the server to close the connection.
void	setup(SteamClient client)

Methods inherited from class java.lang.Object

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

Field Detail

client

protected SteamClient client

Constructor Detail

ClientMsgHandler

public ClientMsgHandler()

Method Detail

setup

public void setup(SteamClient client)

isExpectDisconnection

protected boolean isExpectDisconnection()

Gets whether or not the related SteamClient should imminently expect the server to close the connection. If this is true when the connection is closed, the DisconnectedCallback's DisconnectedCallback.isUserInitiated() property will be set to true.

Returns:

whether or not the related SteamClient should imminently expect the server to close the connection.

setExpectDisconnection

protected void setExpectDisconnection(boolean expectDisconnection)

Sets whether or not the related SteamClient should imminently expect the server to close the connection. If this is true when the connection is closed, the DisconnectedCallback's DisconnectedCallback.isUserInitiated() property will be set to true.

Parameters:

expectDisconnection - whether or not the related SteamClient should imminently expect the server to close the connection.

getClient

public SteamClient getClient()

Returns:

the underlying SteamClient for use in sending replies.

handleMsg

public abstract void handleMsg(IPacketMsg packetMsg)

Handles a client message. This should not be called directly.

Parameters:

packetMsg - The packet message that contains the data.