com.captainalm.lib.calmnet.marshal

Class FragmentationOptions

java.lang.Object

com.captainalm.lib.calmnet.marshal.FragmentationOptions

public final class FragmentationOptions
extends java.lang.Object

This class provides fragmentation options for using FragmentSenders and FragmentReceivers in this package.

Author:

Captain ALM

Field Summary

Fields

Modifier and Type	Field and Description
int	emptySendsTillForced See: FragmentReceiver.setNumberOfEmptySendsTillForcedCompleteOrResend(int)
boolean	equalityVerifyFragments See: FragmentSender.setSentDataWillBeAllVerified(boolean) , FragmentReceiver.setSentDataWillBeAllVerified(boolean)
int	fragmentationSplitSize See: FragmentSender.setSplitSize(int)
int	maximumFragmentAge The maximum age of fragments for a specified packet in seconds before those fragments are purged.
boolean	verifyFragments See: FragmentSender.setResponseVerification(boolean) , FragmentReceiver.setResponseVerification(boolean)

Constructor Summary

Constructors

Constructor and Description
FragmentationOptions()
FragmentationOptions(FragmentationOptions toCopy) Creates a copy of the provided FragmentationOptions.

Method Summary

Modifier and Type	Method and Description
void	setupReceiver(FragmentReceiver receiver) Sets-up the provided FragmentReceiver with parameters.
void	setupSender(FragmentSender sender) Sets-up the provided FragmentSender with parameters.
void	validate() Validates the parameters within this structure.

Methods inherited from class java.lang.Object

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

Field Detail

maximumFragmentAge

public int maximumFragmentAge

The maximum age of fragments for a specified packet in seconds before those fragments are purged.

fragmentationSplitSize

public int fragmentationSplitSize

See: FragmentSender.setSplitSize(int)

emptySendsTillForced

public int emptySendsTillForced

See: FragmentReceiver.setNumberOfEmptySendsTillForcedCompleteOrResend(int)

verifyFragments

public boolean verifyFragments

See: FragmentSender.setResponseVerification(boolean) , FragmentReceiver.setResponseVerification(boolean)

equalityVerifyFragments

public boolean equalityVerifyFragments

See: FragmentSender.setSentDataWillBeAllVerified(boolean) , FragmentReceiver.setSentDataWillBeAllVerified(boolean)

Constructor Detail

FragmentationOptions

public FragmentationOptions()

FragmentationOptions

public FragmentationOptions(FragmentationOptions toCopy)

Creates a copy of the provided FragmentationOptions.

Parameters:

toCopy - The options to copy.

Throws:

java.lang.NullPointerException - toCopy is null.

Method Detail

validate

public void validate()

Validates the parameters within this structure.

Throws:

java.lang.IllegalArgumentException - maximumFragmentAge is less than 2, fragmentationSplitSize is less than 1 or emptySendsTillForced is less than 1.

setupSender

public void setupSender(FragmentSender sender)

Sets-up the provided FragmentSender with parameters.

Parameters:

sender - The sender to set up.

Throws:

java.lang.IllegalArgumentException - A parameter is incorrect.

setupReceiver

public void setupReceiver(FragmentReceiver receiver)

Sets-up the provided FragmentReceiver with parameters.

Parameters:

receiver - The receiver to set up.

Throws:

java.lang.IllegalArgumentException - A parameter is incorrect.