uk.co.thomasc.steamkit.base

Class PacketClientGCMsg

java.lang.Object

uk.co.thomasc.steamkit.base.PacketClientGCMsg

All Implemented Interfaces:

IPacketGCMsg

public final class PacketClientGCMsg
extends Object
implements IPacketGCMsg

Represents a packet message with extended header information.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getData() Gets the underlying data that represents this packet 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.gc.IPacketGCMsg

getMsgType, getSourceJobID, getTargetJobID, setSourceJobID, setTargetJobID

Field Detail

msgType

private final int msgType

Gets the network message type of this packet message.

targetJobID

private JobID targetJobID

Gets the target job id for this packet message.

sourceJobID

private JobID sourceJobID

Gets the source job id for this packet message.

payload

byte[] payload

Constructor Detail

PacketClientGCMsg

public PacketClientGCMsg(int eMsg,
                 byte[] data)

Initializes a new instance of the PacketClientGCMsg 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 IPacketGCMsg

getData

public byte[] getData()

Gets the underlying data that represents this packet message.

Specified by:

getData in interface IPacketGCMsg

Returns:

The data.