in.dragonbra.javasteam.base

Interface IClientGCMsg

All Known Implementing Classes:

ClientGCMsg, ClientGCMsgProtobuf, GCMsgBase

public interface IClientGCMsg

Represents a unified interface into client messages.

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.

Method Detail

isProto

boolean isProto()

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

Returns:

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

getMsgType

int getMsgType()

Gets the network message type of this client message.

Returns:

The message type.

getTargetJobID

JobID getTargetJobID()

Gets the target job id for this client message.

Returns:

The target job id.

setTargetJobID

void setTargetJobID(JobID jobID)

Sets the target job id for this client message.

Parameters:

jobID - The target job id.

getSourceJobID

JobID getSourceJobID()

Gets the source job id for this client message.

Returns:

The source job id.

setSourceJobID

void setSourceJobID(JobID jobID)

Sets the source job id for this client message.

Parameters:

jobID - The source job id.

serialize

byte[] serialize()

serializes this client message instance to a byte array.

Returns:

Data representing a client message.

deserialize

void deserialize(byte[] data)

Initializes this client message by deserializing the specified data.

Parameters:

data - The data representing a client message.