com.captainalm.lib.calmnet.packet.fragment

Class FragmentMessagePacket

java.lang.Object

com.captainalm.lib.calmnet.packet.fragment.FragmentPIDPacket

com.captainalm.lib.calmnet.packet.fragment.FragmentPIDMSGPacket

com.captainalm.lib.calmnet.packet.fragment.FragmentMessagePacket

All Implemented Interfaces:

IPacket

public class FragmentMessagePacket
extends FragmentPIDMSGPacket

This class provides a packet for sending a payload with a packetID and fragmentID. The response packet is: FragmentMessageResponsePacket.

Major ID: 254 Minor ID: 3

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
FragmentMessagePacket(java.lang.Integer packetID, java.lang.Integer fragmentID, byte[] payload) Constructs a new FragmentMessagePacket given the packet ID, fragment ID and payload.

Method Summary

Modifier and Type	Method and Description
PacketProtocolInformation	getProtocol() Gets the protocol information.
static PacketProtocolInformation	getTheProtocol() Gets the protocol information statically.
boolean	isValid() Gets if the packet is valid.
byte[]	savePayload() Saves the packet payload to a byte array.

Methods inherited from class com.captainalm.lib.calmnet.packet.fragment.FragmentPIDMSGPacket

getFragmentID, getFragmentMessage, loadPayload

Methods inherited from class com.captainalm.lib.calmnet.packet.fragment.FragmentPIDPacket

getPacketID

Methods inherited from class java.lang.Object

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

Constructor Detail

FragmentMessagePacket

public FragmentMessagePacket(java.lang.Integer packetID,
                             java.lang.Integer fragmentID,
                             byte[] payload)

Constructs a new FragmentMessagePacket given the packet ID, fragment ID and payload.

Parameters:

packetID - The packet ID.

fragmentID - The fragment ID.

payload - The payload to store.

Throws:

java.lang.IllegalArgumentException - packetID or fragmentID is less than 0.

Method Detail

isValid

public boolean isValid()

Gets if the packet is valid.

Specified by:

isValid in interface IPacket

Overrides:

isValid in class FragmentPIDMSGPacket

Returns:

Is the packet valid?

getProtocol

public PacketProtocolInformation getProtocol()

Gets the protocol information.

Returns:

The protocol information.

getTheProtocol

public static PacketProtocolInformation getTheProtocol()

Gets the protocol information statically.

Returns:

The protocol information.

savePayload

public byte[] savePayload()
                   throws PacketException

Saves the packet payload to a byte array.

Specified by:

savePayload in interface IPacket

Overrides:

savePayload in class FragmentPIDMSGPacket

Returns:

The packet payload data.

Throws:

PacketException - An Exception has occurred.