uk.co.thomasc.steamkit.base

Class PacketMsg

java.lang.Object

uk.co.thomasc.steamkit.base.PacketMsg

All Implemented Interfaces:

IPacketMsg

public final class PacketMsg
extends Object
implements IPacketMsg

Represents a packet message with basic header information.

Field Summary

Fields

Modifier and Type	Field and Description
private EMsg	msgType Gets the network message type of this packet message.
(package private) byte[]	payload
private long	sourceJobID Gets the source job id for this packet message.
private long	targetJobID Gets the target job id for this packet message.

Constructor Summary

Constructors

Constructor and Description
PacketMsg(EMsg eMsg, byte[] data) Initializes a new instance of the PacketMsg class.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getData() Gets the underlying data that represents this client message.
boolean	isProto() Gets a value indicating whether this packet message is protobuf backed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uk.co.thomasc.steamkit.base.IPacketMsg

getMsgType, getSourceJobID, getTargetJobID

Field Detail

msgType

private final EMsg msgType

Gets the network message type of this packet message.

targetJobID

private long targetJobID

Gets the target job id for this packet message.

sourceJobID

private long sourceJobID

Gets the source job id for this packet message.

payload

byte[] payload

Constructor Detail

PacketMsg

public PacketMsg(EMsg eMsg,
         byte[] data)

Initializes a new instance of the PacketMsg class.

Parameters:

eMsg - The network message type for this packet message.

data - The data.

Method Detail

isProto

public boolean isProto()

Gets a value indicating whether this packet message is protobuf backed. This type of message is never protobuf backed.

Specified by:

isProto in interface IPacketMsg

Returns:

true if this instance is protobuf backed; otherwise, false

getData

public byte[] getData()

Gets the underlying data that represents this client message.

Specified by:

getData in interface IPacketMsg

Returns:

The data.