Package in.dragonbra.javasteam.base

Class GCMsgBase<HdrType extends IGCSerializableHeader>

java.lang.Object

in.dragonbra.javasteam.base.AbstractMsgBase

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

Type Parameters:

HdrType - The header type for this gc message.

All Implemented Interfaces:

IClientGCMsg

Direct Known Subclasses:

ClientGCMsg, ClientGCMsgProtobuf

public abstract class GCMsgBase<HdrType extends IGCSerializableHeader>
extends AbstractMsgBase
implements IClientGCMsg

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

Field Summary

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

payload

Constructor Summary

Constructors

Constructor	Description
GCMsgBase(java.lang.Class<HdrType> clazz)	Initializes a new instance of the GCMsgBase class.
GCMsgBase(java.lang.Class<HdrType> clazz, int payloadReserve)	Initializes a new instance of the GCMsgBase class.

Method Summary

Modifier and Type	Method	Description
HdrType	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

Methods inherited from interface in.dragonbra.javasteam.base.IClientGCMsg

deserialize, getMsgType, getSourceJobID, getTargetJobID, isProto, serialize, setSourceJobID, setTargetJobID

Constructor Detail

GCMsgBase

public GCMsgBase(java.lang.Class<HdrType> clazz)

Initializes a new instance of the GCMsgBase class.

Parameters:

clazz - the type of the header

GCMsgBase

public GCMsgBase(java.lang.Class<HdrType> clazz,
                 int payloadReserve)

Initializes a new instance of the GCMsgBase class.

Parameters:

clazz - the type of the header

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

Method Detail

getHeader

public HdrType getHeader()

Returns:

the header for this message type.