com.captainalm.lib.calmnet.packet.fragment

Class FragmentReceiver

java.lang.Object

com.captainalm.lib.calmnet.packet.fragment.FragmentReceiver

public final class FragmentReceiver
extends java.lang.Object

This class provides the ability to re-construct packets from com.captainalm.lib.calmnet.packet.fragment.

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
FragmentReceiver(PacketLoader loader, IPacketFactory factory) Constructs a new FragmentReceiver with the specified PacketLoader and IPacketFactory.

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 to be received.
void	clearLastIDFinished() Clears all the last finished packet IDs.
void	clearRegistry() Clears the registry (And requests the sender to stop sending).
void	clearWaitingPackets() Clears the currently waiting packets.
void	deletePacketFromRegistry(int id) Deletes a packet from the registry and requests the sender to stop sending.
int	getLastIDFinished() Gets the last finished packet ID.
int	getNumberOfEmptySendsTillForcedCompleteOrResend() Gets the number of sendPacket() calls, that return null, to a registry entry are made before the FragmentSendCompletePacket or FragmentRetrySendPacket packets are sent.
IPacketFactory	getPacketFactory() Gets the IPacketFactory in use.
PacketLoader	getPacketLoader() Gets the PacketLoader in use.
java.lang.Integer	pollLastIDFinished() Polls the last finished packet ID.
IPacket	receivePacket() Receives a IPacket from the FragmentReceiver.
boolean	receivePacket(IPacket packetIn) Receives a IPacket into the FragmentReceiver.
IPacket	receivePacketPolling() Receives a IPacket from the FragmentReceiver.
IPacket[]	sendPacket() Sends the current IPackets from the FragmentReceiver.
void	setNumberOfEmptySendsTillForcedCompleteOrResend(int numberOfEmptySends) Sets the number of sendPacket() calls, that return null, to a registry entry are made before the FragmentSendCompletePacket or FragmentRetrySendPacket packets are sent.
void	setPacketFactory(IPacketFactory factory) Sets the IPacketFactory to use.
void	setPacketLoader(PacketLoader loader) Sets the PacketLoader to use.
void	setResponseVerification(boolean state) Sets whether responses should be verified by sending back the payload to be verified.
void	setSentDataWillBeAllVerified(boolean state) Gets whether all sent fragments are expected to be verified.
boolean	shouldSentDataBeAllVerified() Gets whether all sent fragments are expected to be verified.
boolean	shouldVerifyResponses() Gets whether responses should be verified by sending back the payload to be verified.
void	stopAllDataVerificationAndCompleteReceive() Stops data verification for all packets being received when shouldSentDataBeAllVerified() is true.
void	stopDataVerificationAndCompleteReceive(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

FragmentReceiver

public FragmentReceiver(PacketLoader loader,
                        IPacketFactory factory)

Constructs a new FragmentReceiver with the specified PacketLoader and IPacketFactory.

Parameters:

loader - The packet loader to use.

factory - The packet factory to use.

Throws:

java.lang.NullPointerException - loader or factory is null.

Method Detail

receivePacket

public IPacket receivePacket()
                      throws java.lang.InterruptedException

Receives a IPacket from the FragmentReceiver. This method blocks until a packet can be received.

Returns:

The received packet.

Throws:

java.lang.InterruptedException - The Thread was Interrupted.

receivePacketPolling

public IPacket receivePacketPolling()

Receives a IPacket from the FragmentReceiver.

Returns:

The received packet or null.

sendPacket

public IPacket[] sendPacket()
                     throws PacketException

Sends the current IPackets from the FragmentReceiver.

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 FragmentReceiver.

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 to be received.

Returns:

If packets are waiting to be received.

clearWaitingPackets

public void clearWaitingPackets()

Clears the currently waiting packets.

deletePacketFromRegistry

public void deletePacketFromRegistry(int id)

Deletes a packet from the registry and requests the sender to stop sending.

Parameters:

id - The ID of the packet to remove.

clearRegistry

public void clearRegistry()

Clears the registry (And requests the sender to stop sending). NOTE: Do NOT do this unless you are finished with the FragmentReceiver.

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.

getPacketFactory

public IPacketFactory getPacketFactory()

Gets the IPacketFactory in use.

Returns:

The PacketFactory in use.

setPacketFactory

public void setPacketFactory(IPacketFactory factory)

Sets the IPacketFactory to use.

Parameters:

factory - The packet factory to use.

Throws:

java.lang.NullPointerException - factory is null.

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 sending back the payload to be verified.

Returns:

Should responses be verified by sending back the payload.

setResponseVerification

public void setResponseVerification(boolean state)

Sets whether responses should be verified by sending back the payload to be verified. If set to false, setSentDataWillBeAllVerified(boolean) will be set to false too.

Parameters:

state - If responses should be verified by sending back the payload.

shouldSentDataBeAllVerified

public boolean shouldSentDataBeAllVerified()

Gets whether all sent fragments are expected to be verified.

Returns:

If all sent fragments are expected to be verified.

setSentDataWillBeAllVerified

public void setSentDataWillBeAllVerified(boolean state)

Gets whether all sent fragments are expected to be verified. Requires setResponseVerification(boolean) set to true.

Parameters:

state - If all sent fragments are expected to be verified.

getNumberOfEmptySendsTillForcedCompleteOrResend

public int getNumberOfEmptySendsTillForcedCompleteOrResend()

Gets the number of sendPacket() calls, that return null, to a registry entry are made before the FragmentSendCompletePacket or FragmentRetrySendPacket packets are sent. A FragmentSendCompletePacket is sent if completely received and a FragmentRetrySendPacket is sent if not completely received. This excludes empty packets due to shouldSentDataBeAllVerified().

Returns:

The number of send packet calls before a completion or restart is forced.

setNumberOfEmptySendsTillForcedCompleteOrResend

public void setNumberOfEmptySendsTillForcedCompleteOrResend(int numberOfEmptySends)

Sets the number of sendPacket() calls, that return null, to a registry entry are made before the FragmentSendCompletePacket or FragmentRetrySendPacket packets are sent. A FragmentSendCompletePacket is sent if completely received and a FragmentRetrySendPacket is sent if not completely received. This excludes empty packets due to shouldSentDataBeAllVerified().

Parameters:

numberOfEmptySends - The number of empty sends to allow.

Throws:

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

stopDataVerificationAndCompleteReceive

public void stopDataVerificationAndCompleteReceive(int id)

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

Parameters:

id - The PacketID to act on.

stopAllDataVerificationAndCompleteReceive

public void stopAllDataVerificationAndCompleteReceive()

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