uk.co.thomasc.steamkit.base

Class ClientMsg<T extends ISteamSerializableMessage>

java.lang.Object

uk.co.thomasc.steamkit.base.AMsgBase

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

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

Type Parameters:

T - The body type of this message.

All Implemented Interfaces:

IClientMsg

public final class ClientMsg<T extends ISteamSerializableMessage>
extends MsgBase<ExtendedClientMsgHdr>

Represents a struct backed client message.

Field Summary

Fields

Modifier and Type	Field and Description
private T	body Gets the body structure of this message.

Fields inherited from class uk.co.thomasc.steamkit.base.MsgBase

header, sessionID, sourceJobID, steamID, targetJobID

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	deSerialize(byte[] data) Initializes this client message by deserializing the specified data.
EMsg	getMsgType() The message type.
int	getSessionID() Gets the session id for this client message.
JobID	getSourceJobID() Gets or sets the target job id for this client message.
SteamID	getSteamID() Gets the SteamID for this client message.
JobID	getTargetJobID() Gets or sets the target job id for this client message.
boolean	isProto() Gets a value indicating whether this client message is protobuf backed.
byte[]	serialize() serializes this client message instance to a byte array.
void	setSessionID(int sessionID) Sets the session id for this client message.
void	setSourceJobID(JobID jobID) Sets the target job id for this client message.
void	setSteamID(SteamID steamID) Sets the SteamID for this client message.
void	setTargetJobID(JobID jobID) Sets the target job id for this client message.

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

Field Detail

body

private T extends ISteamSerializableMessage body

Gets the body structure of this message.

Constructor Detail

ClientMsg

public ClientMsg(Class<T> clazz)

ClientMsg

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

Initializes a new instance of the ClientMsg class. This is a client send constructor.

Parameters:

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

ClientMsg

public ClientMsg(Class<T> clazz,
         MsgBase<ExtendedClientMsgHdr> msg)

ClientMsg

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

Initializes a new instance of the ClientMsg class. This a reply constructor.

Parameters:

msg - The message that this instance is a reply for.

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

ClientMsg

public ClientMsg(IPacketMsg msg,
         Class<T> clazz)

Initializes a new instance of the ClientMsg class. This is a recieve constructor.

Parameters:

msg - The packet message to build this client message from.

Method Detail

isProto

public boolean isProto()

Gets a value indicating whether this client message is protobuf backed.

getMsgType

public EMsg getMsgType()

Description copied from interface: IClientMsg

The message type.

getSessionID

public int getSessionID()

Gets the session id for this client message.

setSessionID

public void setSessionID(int sessionID)

Sets the session id for this client message.

getSteamID

public SteamID getSteamID()

Gets the SteamID for this client message.

setSteamID

public void setSteamID(SteamID steamID)

Sets the SteamID for this client message.

getTargetJobID

public JobID getTargetJobID()

Gets or sets the target job id for this client message.

setTargetJobID

public void setTargetJobID(JobID jobID)

Sets the target job id for this client message.

getSourceJobID

public JobID getSourceJobID()

Gets or sets the target job id for this client message.

setSourceJobID

public void setSourceJobID(JobID jobID)

Sets the target job id for this client message.

serialize

public byte[] serialize()
                 throws IOException

serializes this client message instance to a byte array.

Specified by:

serialize in interface IClientMsg

Specified by:

serialize in class MsgBase<ExtendedClientMsgHdr>

Returns:

Data representing a client message.

Throws:

IOException

deSerialize

public void deSerialize(byte[] data)
                 throws IOException

Initializes this client message by deserializing the specified data.

Specified by:

deSerialize in interface IClientMsg

Specified by:

deSerialize in class MsgBase<ExtendedClientMsgHdr>

Parameters:

data - The data representing a client message.

Throws:

IOException