uk.co.thomasc.steamkit.base.gc

Class ClientGCMsg<T extends IGCSerializableMessage>

java.lang.Object

uk.co.thomasc.steamkit.base.AMsgBase

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

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

Type Parameters:

T - The body type of this message.

All Implemented Interfaces:

IClientGCMsg

public final class ClientGCMsg<T extends IGCSerializableMessage>
extends GCMsgBase<MsgGCHdr>

Represents a struct backed game coordinator message.

Field Summary

Fields

Modifier and Type	Field and Description
private T	body Gets the body structure of this message.
(package private) int	msgType

Fields inherited from class uk.co.thomasc.steamkit.base.gc.GCMsgBase

sourceJobID, targetJobID

Constructor Summary

Constructors

Constructor and Description
ClientGCMsg(Class<T> clazz)
ClientGCMsg(Class<T> clazz, GCMsgBase<MsgGCHdr> msg)
ClientGCMsg(Class<T> clazz, GCMsgBase<MsgGCHdr> msg, int payloadReserve) Initializes a new instance of the ClientGCMsg class.
ClientGCMsg(Class<T> clazz, int payloadReserve) Initializes a new instance of the ClientGCMsg class.
ClientGCMsg(Class<T> clazz, IPacketGCMsg msg) Initializes a new instance of the ClientGCMsg class.

Method Summary

Methods

Modifier and Type	Method and Description
void	deSerialize(byte[] data) Initializes this gc message by deserializing the specified data.
int	getMsgType() Gets the network message type of this gc message.
JobID	getSourceJobID() Gets the source job id for this gc message.
JobID	getTargetJobID() Gets the target job id for this gc message.
boolean	isProto() Gets a value indicating whether this gc message is protobuf backed.
byte[]	serialize() Serializes this gc message instance to a byte array.
void	setSourceJobID(JobID value) Sets the source job id for this gc message.
void	setTargetJobID(JobID value) Sets the target job id for this gc 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

msgType

int msgType

body

private T extends IGCSerializableMessage body

Gets the body structure of this message.

Constructor Detail

ClientGCMsg

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

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

Parameters:

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

ClientGCMsg

public ClientGCMsg(Class<T> clazz)

ClientGCMsg

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

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

ClientGCMsg

public ClientGCMsg(Class<T> clazz,
           GCMsgBase<MsgGCHdr> msg)

ClientGCMsg

public ClientGCMsg(Class<T> clazz,
           IPacketGCMsg msg)

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

Parameters:

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

Method Detail

isProto

public boolean isProto()

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

Returns:

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

getMsgType

public int getMsgType()

Gets the network message type of this gc message.

Returns:

The network message type.

getTargetJobID

public JobID getTargetJobID()

Gets the target job id for this gc message.

Returns:

The target job id

setTargetJobID

public void setTargetJobID(JobID value)

Sets the target job id for this gc message.

Parameters:

value - The target job id

getSourceJobID

public JobID getSourceJobID()

Gets the source job id for this gc message.

Returns:

The source job id

setSourceJobID

public void setSourceJobID(JobID value)

Sets the source job id for this gc message.

Parameters:

value - The source job id

serialize

public byte[] serialize()
                 throws IOException

Serializes this gc message instance to a byte array.

Specified by:

serialize in interface IClientGCMsg

Specified by:

serialize in class GCMsgBase<MsgGCHdr>

Returns:

Data representing a client message.

Throws:

IOException

deSerialize

public void deSerialize(byte[] data)
                 throws IOException

Initializes this gc message by deserializing the specified data.

Specified by:

deSerialize in interface IClientGCMsg

Specified by:

deSerialize in class GCMsgBase<MsgGCHdr>

Parameters:

data - The data representing a client message.

Throws:

IOException