uk.co.thomasc.steamkit.base

Class MsgBase<T extends ISteamSerializableHeader>

java.lang.Object

uk.co.thomasc.steamkit.base.AMsgBase

uk.co.thomasc.steamkit.base.MsgBase<T>

Type Parameters:

T - The header type for this client message.

All Implemented Interfaces:

IClientMsg

Direct Known Subclasses:

ClientMsg, ClientMsgProtobuf, Msg

public abstract class MsgBase<T extends ISteamSerializableHeader>
extends AMsgBase
implements IClientMsg

This is the abstract base class for all available client messages. It's used to maintain packet payloads and provide a header for all client messages.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	header Gets the header for this message type.
private boolean	isProto true if this instance is protobuf backed; otherwise, false.
private EMsg	msgType The network message type.
protected int	sessionID The session id.
protected JobID	sourceJobID The source job id.
protected SteamID	steamID The SteamID
protected JobID	targetJobID The target job id.

Constructor Summary

Constructors

Constructor and Description
MsgBase(Class<T> clazz)
MsgBase(Class<T> clazz, int payloadReserve) Initializes a new instance of the MsgBase class.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	deSerialize(byte[] data) Initializes this client message by deserializing the specified data.
abstract byte[]	serialize() serializes this client message instance to a byte array.

Methods inherited from class uk.co.thomasc.steamkit.base.AMsgBase

write, write, write, write, writeNullTermString

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.co.thomasc.steamkit.base.IClientMsg

getMsgType, getSessionID, getSourceJobID, getSteamID, getTargetJobID, isProto, setSessionID, setSourceJobID, setSteamID, setTargetJobID

Field Detail

isProto

private boolean isProto

true if this instance is protobuf backed; otherwise, false.

msgType

private EMsg msgType

The network message type.

sessionID

protected int sessionID

The session id.

steamID

protected SteamID steamID

The SteamID

targetJobID

protected JobID targetJobID

The target job id.

sourceJobID

protected JobID sourceJobID

The source job id.

header

protected T extends ISteamSerializableHeader header

Gets the header for this message type.

Constructor Detail

MsgBase

public MsgBase(Class<T> clazz)

MsgBase

public MsgBase(Class<T> clazz,
       int payloadReserve)

Initializes a new instance of the MsgBase class.

Parameters:

payloadReserve - The number of bytes to initialize the payload capacity to.

Method Detail

serialize

public abstract byte[] serialize()
                          throws IOException

serializes this client message instance to a byte array.

Specified by:

serialize in interface IClientMsg

Returns:

Data representing a client message.

Throws:

IOException

deSerialize

public abstract void deSerialize(byte[] data)
                          throws IOException

Initializes this client message by deserializing the specified data.

Specified by:

deSerialize in interface IClientMsg

Parameters:

data - The data representing a client message.

Throws:

IOException