uk.co.thomasc.steamkit.networking.steam3

Class UdpPacket

java.lang.Object

uk.co.thomasc.steamkit.networking.steam3.UdpPacket

 class UdpPacket
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
private UdpHeader	header
static int	MAX_PAYLOAD
private BinaryReader	payload

Constructor Summary

Constructors

Constructor and Description
UdpPacket(BinaryReader ms) Initializes a new instance of the UdpPacket class with information from the memory stream.
UdpPacket(EUdpPacketType type) Initializes a new instance of the UdpPacket class, with no payload.
UdpPacket(EUdpPacketType type, BinaryReader reader) Initializes a new instance of the UdpPacket class, of the specified type containing the specified payload.
UdpPacket(EUdpPacketType type, BinaryReader payload, int length) Initializes a new instance of the UdpPacket class, of the specified type containing the first 'length' bytes of specified payload.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getData() Serializes the UdpPacket.
boolean	isValid() Gets a value indicating whether this instance is valid.
void	setPayload(BinaryReader ms) Sets the payload
void	setPayload(BinaryReader ms, int length) Sets the payload.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_PAYLOAD

public static final int MAX_PAYLOAD

See Also:

Constant Field Values

header

private UdpHeader header

payload

private BinaryReader payload

Constructor Detail

UdpPacket

public UdpPacket(BinaryReader ms)

Initializes a new instance of the UdpPacket class with information from the memory stream. Header is populated from the MemoryStream

Parameters:

ms - The stream containing the packet and it's payload data.

UdpPacket

public UdpPacket(EUdpPacketType type)

Initializes a new instance of the UdpPacket class, with no payload. Header must be populated manually.

Parameters:

type - The type.

UdpPacket

public UdpPacket(EUdpPacketType type,
         BinaryReader reader)

Initializes a new instance of the UdpPacket class, of the specified type containing the specified payload. Header must be populated manually.

Parameters:

type - The type.

reader - The payload.

UdpPacket

public UdpPacket(EUdpPacketType type,
         BinaryReader payload,
         int length)

Initializes a new instance of the UdpPacket class, of the specified type containing the first 'length' bytes of specified payload. Header must be populated manually.

Parameters:

type - The type.

payload - The payload.

length - The length.

Method Detail

isValid

public boolean isValid()

Gets a value indicating whether this instance is valid.

Returns:

true if this instance is valid; otherwise, false.

setPayload

public void setPayload(BinaryReader ms)

Sets the payload

Parameters:

ms - The payload to copy.

setPayload

public void setPayload(BinaryReader ms,
              int length)

Sets the payload.

Parameters:

ms - The payload.

length - The length.

getData

public byte[] getData()

Serializes the UdpPacket.

Returns:

The serialized packet.