com.captainalm.lib.calmnet.packet.core

Class NetworkIdentifierPacket

java.lang.Object

com.captainalm.lib.calmnet.packet.core.NetworkIdentifierPacket

All Implemented Interfaces:

IPacket

public class NetworkIdentifierPacket
extends java.lang.Object
implements IPacket

This class provides a packet that is used to identify the type of network client is using this library.

Major ID: 255 Minor ID: 255

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
NetworkIdentifierPacket(java.lang.String id) Constructs a new instance of NetworkIdentifierPacket with the specified ID.

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.
void	loadPayload(byte[] packetData) Loads the packet payload from save data.
byte[]	savePayload() Saves the packet payload to a byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkIdentifierPacket

public NetworkIdentifierPacket(java.lang.String id)

Constructs a new instance of NetworkIdentifierPacket with the specified ID.

Parameters:

id - The network ID of the client.

Method Detail

isValid

public boolean isValid()

Gets if the packet is valid.

Specified by:

isValid in interface IPacket

Returns:

Is the packet valid?

getProtocol

public PacketProtocolInformation getProtocol()

Gets the protocol information.

Specified by:

getProtocol in interface IPacket

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

Returns:

The packet payload data.

Throws:

PacketException - An Exception has occurred.

loadPayload

public void loadPayload(byte[] packetData)
                 throws PacketException

Loads the packet payload from save data.

Specified by:

loadPayload in interface IPacket

Parameters:

packetData - The packet payload data.

Throws:

java.lang.NullPointerException - The new store data is null.

PacketException - An Exception has occurred.