in.dragonbra.javasteam.base

Class ClientMsg<BodyType extends ISteamSerializableMessage>

java.lang.Object

in.dragonbra.javasteam.base.AbstractMsgBase

in.dragonbra.javasteam.base.MsgBase<ExtendedClientMsgHdr>

in.dragonbra.javasteam.base.ClientMsg<BodyType>

Type Parameters:

BodyType - The body type of this message.

All Implemented Interfaces:

IClientMsg

public class ClientMsg<BodyType extends ISteamSerializableMessage>
extends MsgBase<ExtendedClientMsgHdr>

Represents a struct backed client message.

Field Summary

Fields inherited from class in.dragonbra.javasteam.base.AbstractMsgBase

payload

Constructor Summary

Constructors

Constructor and Description
ClientMsg(java.lang.Class<? extends BodyType> bodyType) Initializes a new instance of the ClientMsg class.
ClientMsg(java.lang.Class<? extends BodyType> bodyType, int payloadReserve) Initializes a new instance of the ClientMsg class.
ClientMsg(java.lang.Class<? extends BodyType> bodyType, IPacketMsg msg) Initializes a new instance of the ClientMsg class.
ClientMsg(java.lang.Class<? extends BodyType> bodyType, MsgBase<ExtendedClientMsgHdr> msg) Initializes a new instance of the ClientMsg class.
ClientMsg(java.lang.Class<? extends BodyType> bodyType, MsgBase<ExtendedClientMsgHdr> msg, int payloadReserve) Initializes a new instance of the ClientMsg class.

Method Summary

Modifier and Type	Method and Description
void	deserialize(byte[] data) Initializes this client message by deserializing the specified data.
BodyType	getBody()
EMsg	getMsgType() Gets the network message type of this client message.
int	getSessionID() Gets the session id for this client message.
JobID	getSourceJobID() Gets the source job id for this client message.
SteamID	getSteamID() Gets the SteamID for this client message.
JobID	getTargetJobID() Gets 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 source 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 in.dragonbra.javasteam.base.MsgBase

getHeader

Methods inherited from class in.dragonbra.javasteam.base.AbstractMsgBase

getPayload, readByte, readBytes, readDouble, readFloat, readInt, readLong, readNullTermString, readNullTermString, readShort, seek, write, write, write, write, write, write, write, write, write, writeNullTermString, writeNullTermString

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientMsg

public ClientMsg(java.lang.Class<? extends BodyType> bodyType)

Initializes a new instance of the ClientMsg class.

Parameters:

bodyType - body type

ClientMsg

public ClientMsg(java.lang.Class<? extends BodyType> bodyType,
                 int payloadReserve)

Initializes a new instance of the ClientMsg class.

Parameters:

bodyType - body type

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

ClientMsg

public ClientMsg(java.lang.Class<? extends BodyType> bodyType,
                 MsgBase<ExtendedClientMsgHdr> msg)

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

Parameters:

bodyType - body type

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

ClientMsg

public ClientMsg(java.lang.Class<? extends BodyType> bodyType,
                 MsgBase<ExtendedClientMsgHdr> msg,
                 int payloadReserve)

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

Parameters:

bodyType - body type

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

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

ClientMsg

public ClientMsg(java.lang.Class<? extends BodyType> bodyType,
                 IPacketMsg msg)

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

Parameters:

bodyType - body type

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

Method Detail

isProto

public boolean isProto()

Description copied from interface: IClientMsg

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

Returns:

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

getMsgType

public EMsg getMsgType()

Description copied from interface: IClientMsg

Gets the network message type of this client message.

Returns:

The message type.

getSessionID

public int getSessionID()

Description copied from interface: IClientMsg

Gets the session id for this client message.

Returns:

The session id.

setSessionID

public void setSessionID(int sessionID)

Description copied from interface: IClientMsg

Sets the session id for this client message.

Parameters:

sessionID - The session id.

getSteamID

public SteamID getSteamID()

Description copied from interface: IClientMsg

Gets the SteamID for this client message.

Returns:

The SteamID.

setSteamID

public void setSteamID(SteamID steamID)

Description copied from interface: IClientMsg

Sets the SteamID for this client message.

Parameters:

steamID - The SteamID.

getTargetJobID

public JobID getTargetJobID()

Description copied from interface: IClientMsg

Gets the target job id for this client message.

Returns:

The target job id.

setTargetJobID

public void setTargetJobID(JobID jobID)

Description copied from interface: IClientMsg

Sets the target job id for this client message.

Parameters:

jobID - The target job id.

getSourceJobID

public JobID getSourceJobID()

Description copied from interface: IClientMsg

Gets the source job id for this client message.

Returns:

The source job id.

setSourceJobID

public void setSourceJobID(JobID jobID)

Description copied from interface: IClientMsg

Sets the source job id for this client message.

Parameters:

jobID - The source job id.

serialize

public byte[] serialize()

Description copied from interface: IClientMsg

serializes this client message instance to a byte array.

Returns:

Data representing a client message.

deserialize

public void deserialize(byte[] data)

Description copied from interface: IClientMsg

Initializes this client message by deserializing the specified data.

Parameters:

data - The data representing a client message.

getBody

public BodyType getBody()

Returns:

the body structure of this message.