Package in.dragonbra.javasteam.base
Interface IClientMsg
-
- All Known Implementing Classes:
AClientMsgProtobuf,ClientMsg,ClientMsgProtobuf,Msg,MsgBase
public interface IClientMsgRepresents a unified interface into client messages.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voiddeserialize(byte[] data)Initializes this client message by deserializing the specified data.EMsggetMsgType()Gets the network message type of this client message.intgetSessionID()Gets the session id for this client message.JobIDgetSourceJobID()Gets the source job id for this client message.SteamIDgetSteamID()Gets theSteamIDfor this client message.JobIDgetTargetJobID()Gets the target job id for this client message.booleanisProto()Gets a value indicating whether this client message is protobuf backed.byte[]serialize()serializes this client message instance to a byte array.voidsetSessionID(int sessionID)Sets the session id for this client message.voidsetSourceJobID(JobID jobID)Sets the source job id for this client message.voidsetSteamID(SteamID steamID)Sets theSteamIDfor this client message.voidsetTargetJobID(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
EMsg getMsgType()
Gets the network message type of this client message.- Returns:
- The message type.
-
getSessionID
int getSessionID()
Gets the session id for this client message.- Returns:
- The session id.
-
setSessionID
void setSessionID(int sessionID)
Sets the session id for this client message.- Parameters:
sessionID- The session id.
-
setSteamID
void setSteamID(SteamID steamID)
Sets theSteamIDfor this client message.- Parameters:
steamID- TheSteamID.
-
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.
-
-