javasteam/in.dragonbra.javasteam.base/MsgBase

MsgBase

abstract class MsgBase<HdrType : ISteamSerializable?> : AbstractMsgBase, IClientMsg

This is the abstract base class for all available client messages. It's used to maintain packet payloads and provide a header for all client messages.

Inheritors

Constructors

Link copied to clipboard
constructor(clazz: Class<HdrType>)
Initializes a new instance of the MsgBase class.
constructor(clazz: Class<HdrType>, payloadReserve: Int)
Initializes a new instance of the MsgBase class.

Properties

Link copied to clipboard
open val header: HdrType

Functions

Link copied to clipboard
abstract fun deserialize(data: Array<Byte>)
Initializes this client message by deserializing the specified data.
Link copied to clipboard
abstract fun getMsgType(): EMsg
Gets the network message type of this client message.
Link copied to clipboard
open fun getPayload(): MemoryStream
Link copied to clipboard
abstract fun getSessionID(): Int
Gets the session id for this client message.
Link copied to clipboard
abstract fun getSourceJobID(): JobID
Gets the source job id for this client message.
Link copied to clipboard
abstract fun getSteamID(): SteamID
Gets the SteamID for this client message.
Link copied to clipboard
abstract fun getTargetJobID(): JobID
Gets the target job id for this client message.
Link copied to clipboard
abstract fun isProto(): Boolean
Gets a value indicating whether this client message is protobuf backed.
Link copied to clipboard
open fun readByte(): Byte
Link copied to clipboard
open fun readBytes(numBytes: Int): Array<Byte>
Link copied to clipboard
open fun readDouble(): Double
Link copied to clipboard
open fun readFloat(): Float
Link copied to clipboard
open fun readInt(): Int
Link copied to clipboard
open fun readLong(): Long
Link copied to clipboard
open fun readNullTermString(): String
open fun readNullTermString(charset: Charset): String
Link copied to clipboard
open fun readShort(): Short
Link copied to clipboard
open fun seek(offset: Long, seekOrigin: SeekOrigin): Long
Seeks within the payload to the specified offset.
Link copied to clipboard
abstract fun serialize(): Array<Byte>
serializes this client message instance to a byte array.
Link copied to clipboard
abstract fun setSessionID(sessionID: Int)
Sets the session id for this client message.
Link copied to clipboard
abstract fun setSourceJobID(jobID: JobID)
Sets the source job id for this client message.
Link copied to clipboard
abstract fun setSteamID(steamID: SteamID)
Sets the SteamID for this client message.
Link copied to clipboard
abstract fun setTargetJobID(jobID: JobID)
Sets the target job id for this client message.
Link copied to clipboard
open fun write(data: Byte)
open fun write(data: Array<Byte>)
open fun write(data: Double)
open fun write(data: Float)
open fun write(data: Int)
open fun write(data: String)
open fun write(data: Long)
open fun write(data: Short)
open fun write(data: String, charset: Charset)
Link copied to clipboard
open fun writeNullTermString(data: String)
open fun writeNullTermString(data: String, charset: Charset)