com.captainalm.lib.calmnet.packet.fragment

Class FragmentSender

java.lang.Object

com.captainalm.lib.calmnet.packet.fragment.FragmentSender

public final class FragmentSender
extends java.lang.Object

This class provides the ability to create packets for com.captainalm.lib.calmnet.packet.fragment.

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
FragmentSender(PacketLoader loader) Constructs a new FragmentSender with the specified PacketLoader.
FragmentSender(PacketLoader loader, int newSize) Constructs a new FragmentSender with the specified PacketLoader and packet split size in bytes.

Method Summary

Modifier and Type	Method and Description
boolean	areFinishedIDsWaiting() Gets whether finished IDs are waiting for obtaining.
boolean	arePacketsWaiting() Gets whether packets are waiting for allocation.
void	clearLastIDFinished() Clears all the last finished packet IDs.
void	clearRegistry() Clears the registry.
void	clearWaitingPackets() Clears the currently waiting packets.
void	deletePacketFromRegistry(int id) Deletes a packet from the registry.
int	getLastIDFinished() Gets the last finished packet ID.
PacketLoader	getPacketLoader() Gets the PacketLoader in use.
int	getSplitSize() Gets the current packet split size in bytes.
java.lang.Integer	pollLastIDFinished() Polls the last finished packet ID.
boolean	receivePacket(IPacket packetIn) Receives a IPacket into the FragmentSender.
IPacket[]	sendPacket() Sends the current IPackets from the FragmentSender.
void	sendPacket(IPacket packetIn) Sends a IPacket using this FragmentSender.
void	setPacketLoader(PacketLoader loader) Sets the PacketLoader to use.
void	setResponseVerification(boolean state) Sets whether responses should be verified by checking if they are equal.
void	setSentDataWillBeAllVerified(boolean state) Gets whether all sent fragments are verified via resend checks for equality.
void	setSplitSize(int newSize) Sets the packet split size in bytes.
boolean	shouldSentDataBeAllVerified() Gets whether all sent fragments are verified via resend checks for equality.
boolean	shouldVerifyResponses() Gets whether responses should be verified by checking if they are equal.
void	stopAllDataVerificationAndCompleteSend() Stops data verification for all packets being sent when shouldSentDataBeAllVerified() is true.
void	stopDataVerificationAndCompleteSend(int id) Stops data verification for the specified Packet ID when shouldSentDataBeAllVerified() is true.

Methods inherited from class java.lang.Object

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

Constructor Detail

FragmentSender

public FragmentSender(PacketLoader loader)

Constructs a new FragmentSender with the specified PacketLoader.

Parameters:

loader - The packet loader to use.

Throws:

java.lang.NullPointerException - loader is null.

FragmentSender

public FragmentSender(PacketLoader loader,
                      int newSize)

Constructs a new FragmentSender with the specified PacketLoader and packet split size in bytes.

Parameters:

loader - The packet loader to use.

newSize - The new split size.

Throws:

java.lang.NullPointerException - loader is null.

java.lang.IllegalArgumentException - newSize is less than 1.

Method Detail

sendPacket

public void sendPacket(IPacket packetIn)

Sends a IPacket using this FragmentSender.

Parameters:

packetIn - The packet to fragment and send.

sendPacket

public IPacket[] sendPacket()
                     throws PacketException

Sends the current IPackets from the FragmentSender.

Returns:

The packets to send.

Throws:

PacketException - A Packet Exception has occurred.

receivePacket

public boolean receivePacket(IPacket packetIn)
                      throws PacketException

Receives a IPacket into the FragmentSender.

Parameters:

packetIn - The packet to receive.

Returns:

If the received packet was a fragment packet.

Throws:

PacketException - A Packet Exception has occurred.

arePacketsWaiting

public boolean arePacketsWaiting()

Gets whether packets are waiting for allocation.

Returns:

If packets are waiting for allocation.

clearWaitingPackets

public void clearWaitingPackets()

Clears the currently waiting packets.

deletePacketFromRegistry

public void deletePacketFromRegistry(int id)

Deletes a packet from the registry.

Parameters:

id - The ID of the packet to remove.

clearRegistry

public void clearRegistry()

Clears the registry. NOTE: Do NOT do this unless you are finished with the FragmentSender.

areFinishedIDsWaiting

public boolean areFinishedIDsWaiting()

Gets whether finished IDs are waiting for obtaining.

Returns:

If finished IDs are waiting for obtaining.

getLastIDFinished

public int getLastIDFinished()
                      throws java.lang.InterruptedException

Gets the last finished packet ID. This method blocks until a packet finishes processing.

Returns:

The last finished packet ID.

Throws:

java.lang.InterruptedException - The Thread was Interrupted.

pollLastIDFinished

public java.lang.Integer pollLastIDFinished()

Polls the last finished packet ID.

Returns:

The last finished packet ID.

clearLastIDFinished

public void clearLastIDFinished()

Clears all the last finished packet IDs.

getSplitSize

public int getSplitSize()

Gets the current packet split size in bytes.

Returns:

The current packet split size.

setSplitSize

public void setSplitSize(int newSize)

Sets the packet split size in bytes.

Parameters:

newSize - The new packet split size.

Throws:

java.lang.IllegalArgumentException - newSize is less than 1.

getPacketLoader

public PacketLoader getPacketLoader()

Gets the PacketLoader in use.

Returns:

The PacketLoader in use.

setPacketLoader

public void setPacketLoader(PacketLoader loader)

Sets the PacketLoader to use.

Parameters:

loader - The packet loader to use.

Throws:

java.lang.NullPointerException - loader is null.

shouldVerifyResponses

public boolean shouldVerifyResponses()

Gets whether responses should be verified by checking if they are equal.

Returns:

Should responses be verified.

setResponseVerification

public void setResponseVerification(boolean state)

Sets whether responses should be verified by checking if they are equal. If set to false, setSentDataWillBeAllVerified(boolean) will be set to false too.

Parameters:

state - If responses should be verified.

shouldSentDataBeAllVerified

public boolean shouldSentDataBeAllVerified()

Gets whether all sent fragments are verified via resend checks for equality.

Returns:

If all sent fragments will be verified via resend checks for equality.

setSentDataWillBeAllVerified

public void setSentDataWillBeAllVerified(boolean state)

Gets whether all sent fragments are verified via resend checks for equality. Requires setResponseVerification(boolean) set to true.

Parameters:

state - If all sent fragments will be verified via resend checks for equality.

stopDataVerificationAndCompleteSend

public void stopDataVerificationAndCompleteSend(int id)

Stops data verification for the specified Packet ID when shouldSentDataBeAllVerified() is true.

Parameters:

id - The PacketID to act on.

stopAllDataVerificationAndCompleteSend

public void stopAllDataVerificationAndCompleteSend()

Stops data verification for all packets being sent when shouldSentDataBeAllVerified() is true.