in.dragonbra.javasteam.base

Class ClientGCMsg<BodyType extends IGCSerializableMessage>

java.lang.Object

in.dragonbra.javasteam.base.AbstractMsgBase

in.dragonbra.javasteam.base.GCMsgBase<MsgGCHdr>

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

Type Parameters:

BodyType - The body type of this message.

All Implemented Interfaces:

IClientGCMsg

public class ClientGCMsg<BodyType extends IGCSerializableMessage>
extends GCMsgBase<MsgGCHdr>

Represents a struct backed game coordinator message.

Field Summary

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

payload

Constructor Summary

Constructors

Constructor and Description
ClientGCMsg(java.lang.Class<? extends BodyType> bodyType) Initializes a new instance of the ClientGCMsg class.
ClientGCMsg(java.lang.Class<? extends BodyType> bodyType, GCMsgBase<MsgGCHdr> msg) Initializes a new instance of the ClientGCMsg class.
ClientGCMsg(java.lang.Class<? extends BodyType> bodyType, GCMsgBase<MsgGCHdr> msg, int payloadReserve) Initializes a new instance of the ClientGCMsg class.
ClientGCMsg(java.lang.Class<? extends BodyType> bodyType, int payloadReserve) Initializes a new instance of the ClientGCMsg class.
ClientGCMsg(java.lang.Class<? extends BodyType> bodyType, IPacketGCMsg msg) Initializes a new instance of the ClientGCMsg class.

Method Summary

Modifier and Type	Method and Description
void	deserialize(byte[] data) Initializes this client message by deserializing the specified data.
int	getMsgType() Gets the network message type of this client message.
JobID	getSourceJobID() Gets the source job id 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	setSourceJobID(JobID jobID) Sets the source job id 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.GCMsgBase

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

ClientGCMsg

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

Initializes a new instance of the ClientGCMsg class.

Parameters:

bodyType - body type

ClientGCMsg

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

Initializes a new instance of the ClientGCMsg class.

Parameters:

bodyType - body type

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

ClientGCMsg

public ClientGCMsg(java.lang.Class<? extends BodyType> bodyType,
                   GCMsgBase<MsgGCHdr> msg)

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

Parameters:

bodyType - body type

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

ClientGCMsg

public ClientGCMsg(java.lang.Class<? extends BodyType> bodyType,
                   GCMsgBase<MsgGCHdr> msg,
                   int payloadReserve)

Initializes a new instance of the ClientGCMsg 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.

ClientGCMsg

public ClientGCMsg(java.lang.Class<? extends BodyType> bodyType,
                   IPacketGCMsg msg)

Initializes a new instance of the ClientGCMsg 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: IClientGCMsg

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

Returns:

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

getMsgType

public int getMsgType()

Description copied from interface: IClientGCMsg

Gets the network message type of this client message.

Returns:

The message type.

getTargetJobID

public JobID getTargetJobID()

Description copied from interface: IClientGCMsg

Gets the target job id for this client message.

Returns:

The target job id.

setTargetJobID

public void setTargetJobID(JobID jobID)

Description copied from interface: IClientGCMsg

Sets the target job id for this client message.

Parameters:

jobID - The target job id.

getSourceJobID

public JobID getSourceJobID()

Description copied from interface: IClientGCMsg

Gets the source job id for this client message.

Returns:

The source job id.

setSourceJobID

public void setSourceJobID(JobID jobID)

Description copied from interface: IClientGCMsg

Sets the source job id for this client message.

Parameters:

jobID - The source job id.

serialize

public byte[] serialize()

Description copied from interface: IClientGCMsg

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: IClientGCMsg

Initializes this client message by deserializing the specified data.

Parameters:

data - The data representing a client message.