uk.co.thomasc.steamkit.base.gc

Class GCMsgBase<T extends IGCSerializableHeader>

java.lang.Object

uk.co.thomasc.steamkit.base.AMsgBase

uk.co.thomasc.steamkit.base.gc.GCMsgBase<T>

Type Parameters:

T - The header type for this gc message.

All Implemented Interfaces:

IClientGCMsg

Direct Known Subclasses:

ClientGCMsg

public abstract class GCMsgBase<T extends IGCSerializableHeader>
extends AMsgBase
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

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

Constructor Summary

Constructors

Constructor and Description
GCMsgBase(Class<T> clazz, int payloadReserve) Initializes a new instance of the GCMsgBase 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.gc.IClientGCMsg

getMsgType, getSourceJobID, getTargetJobID, isProto, setSourceJobID, setTargetJobID

Field Detail

isProto

private boolean isProto

true if this instance is protobuf backed; otherwise, false

msgType

private int msgType

The network message type.

targetJobID

public JobID targetJobID

The target job id.

sourceJobID

public JobID sourceJobID

The source job id.

header

private T extends IGCSerializableHeader header

Gets the header for this message type.

Constructor Detail

GCMsgBase

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

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

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 IClientGCMsg

Parameters:

data - The data representing a client message.

Throws:

IOException