uk.co.thomasc.steamkit.base

Class ClientMsgProtobuf<U extends com.google.protobuf.GeneratedMessage.Builder<U>>

java.lang.Object

uk.co.thomasc.steamkit.base.AMsgBase

uk.co.thomasc.steamkit.base.MsgBase<MsgHdrProtoBuf>

uk.co.thomasc.steamkit.base.ClientMsgProtobuf<U>

Type Parameters:

U - The builder for T

All Implemented Interfaces:

IClientMsg

public final class ClientMsgProtobuf<U extends com.google.protobuf.GeneratedMessage.Builder<U>>
extends MsgBase<MsgHdrProtoBuf>

Represents a protobuf backed client message.

Field Summary

Fields

Modifier and Type	Field and Description
private U	body Gets the body structure of this message.
private Class<? extends com.google.protobuf.AbstractMessage>	clazz

Fields inherited from class uk.co.thomasc.steamkit.base.MsgBase

header, sessionID, sourceJobID, steamID, targetJobID

Constructor Summary

Constructors

Constructor and Description
ClientMsgProtobuf(Class<? extends com.google.protobuf.AbstractMessage> clazz, EMsg eMsg)
ClientMsgProtobuf(Class<? extends com.google.protobuf.AbstractMessage> clazz, EMsg eMsg, int payloadReserve) Initializes a new instance of the ClientMsgProtobuf class.
ClientMsgProtobuf(Class<? extends com.google.protobuf.AbstractMessage> clazz, EMsg eMsg, MsgBase<MsgHdrProtoBuf> msg)
ClientMsgProtobuf(Class<? extends com.google.protobuf.AbstractMessage> clazz, EMsg eMsg, MsgBase<MsgHdrProtoBuf> msg, int payloadReserve) Initializes a new instance of the ClientMsgProtobuf class.
ClientMsgProtobuf(Class<? extends com.google.protobuf.AbstractMessage> clazz, IPacketMsg msg) Initializes a new instance of the ClientMsgProtobuf class.

Method Summary

Methods

Modifier and Type	Method and Description
void	deSerialize(byte[] data) Initializes this client message by deserializing the specified data.
EMsg	getMsgType() Gets the network message type of this client message.
uk.co.thomasc.steamkit.base.generated.SteammessagesBase.CMsgProtoBufHeader.Builder	getProtoHeader() Shorthand accessor for the protobuf header.
int	getSessionID() Gets the session id for this client message.
JobID	getSourceJobID() Gets or sets the target job id for this client message.
SteamID	getSteamID() Gets the SteamID for this client message.
JobID	getTargetJobID() Gets or sets the target job id for this client message.
boolean	isProto() Client messages of this type are always protobuf backed.
byte[]	serialize() serializes this client message instance to a byte array.
void	setSessionID(int sessionID) Sets the session id for this client message.
void	setSourceJobID(JobID JobID) Sets the target job id for this client message.
void	setSteamID(SteamID steamID) Sets the SteamID for this client message.
void	setTargetJobID(JobID JobID) Sets the target job id for this client 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

body

private U extends com.google.protobuf.GeneratedMessage.Builder<U> body

Gets the body structure of this message.

clazz

private Class<? extends com.google.protobuf.AbstractMessage> clazz

Constructor Detail

ClientMsgProtobuf

public ClientMsgProtobuf(Class<? extends com.google.protobuf.AbstractMessage> clazz,
                 EMsg eMsg)

ClientMsgProtobuf

public ClientMsgProtobuf(Class<? extends com.google.protobuf.AbstractMessage> clazz,
                 EMsg eMsg,
                 int payloadReserve)

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

Parameters:

eMsg - The network message type this client message represents.

clazz - The class of T

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

ClientMsgProtobuf

public ClientMsgProtobuf(Class<? extends com.google.protobuf.AbstractMessage> clazz,
                 EMsg eMsg,
                 MsgBase<MsgHdrProtoBuf> msg)

ClientMsgProtobuf

public ClientMsgProtobuf(Class<? extends com.google.protobuf.AbstractMessage> clazz,
                 EMsg eMsg,
                 MsgBase<MsgHdrProtoBuf> msg,
                 int payloadReserve)

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

Parameters:

eMsg - The network message type this client message represents.

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

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

ClientMsgProtobuf

public ClientMsgProtobuf(Class<? extends com.google.protobuf.AbstractMessage> clazz,
                 IPacketMsg msg)

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

Parameters:

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

Method Detail

isProto

public boolean isProto()

Client messages of this type are always protobuf backed.

getMsgType

public EMsg getMsgType()

Gets the network message type of this client message.

getSessionID

public int getSessionID()

Gets the session id for this client message.

setSessionID

public void setSessionID(int sessionID)

Sets the session id for this client message.

getSteamID

public SteamID getSteamID()

Gets the SteamID for this client message.

setSteamID

public void setSteamID(SteamID steamID)

Sets the SteamID for this client message.

getTargetJobID

public JobID getTargetJobID()

Gets or sets the target job id for this client message.

setTargetJobID

public void setTargetJobID(JobID JobID)

Sets the target job id for this client message.

getSourceJobID

public JobID getSourceJobID()

Gets or sets the target job id for this client message.

setSourceJobID

public void setSourceJobID(JobID JobID)

Sets the target job id for this client message.

getProtoHeader

public uk.co.thomasc.steamkit.base.generated.SteammessagesBase.CMsgProtoBufHeader.Builder getProtoHeader()

Shorthand accessor for the protobuf header.

serialize

public byte[] serialize()
                 throws IOException

serializes this client message instance to a byte array.

Specified by:

serialize in interface IClientMsg

Specified by:

serialize in class MsgBase<MsgHdrProtoBuf>

Returns:

Data representing a client message.

Throws:

IOException

deSerialize

public void deSerialize(byte[] data)
                 throws IOException

Initializes this client message by deserializing the specified data.

Specified by:

deSerialize in interface IClientMsg

Specified by:

deSerialize in class MsgBase<MsgHdrProtoBuf>

Parameters:

data - The data representing a client message.

Throws:

IOException