Module org.refcodes.serial

Package org.refcodes.serial

Class AbstractStopAndWaitTransmissionDecorator<DECORATEE extends Transmission>

java.lang.Object

org.refcodes.serial.AbstractErrorCorrectionTransmissionDecorator<DECORATEE>

org.refcodes.serial.AbstractStopAndWaitTransmissionDecorator<DECORATEE>

Type Parameters:

DECORATEE - The decoratee type describing the according subclass to be enriched.

All Implemented Interfaces:

Serializable, org.refcodes.mixin.DecorateeAccessor<DECORATEE>, org.refcodes.mixin.LengthAccessor, org.refcodes.numerical.EndianessAccessor, AcknowledgeMagicBytesAccessor, AcknowledgeRetryNumberAccessor, AcknowledgeSegmentPackagerAccessor, AcknowledgeTimeoutInMsAccessor, ErrorCorrectionTransmission, SequenceNumberAccessor, StopAndWaitTransmission, Transmission, Transmission.TransmissionMixin

Direct Known Subclasses:

StopAndWaitSectionDecorator, StopAndWaitSegmentDecorator

public abstract class AbstractStopAndWaitTransmissionDecorator<DECORATEE extends Transmission>
extends AbstractErrorCorrectionTransmissionDecorator<DECORATEE>
implements StopAndWaitTransmission, Transmission.TransmissionMixin, org.refcodes.numerical.EndianessAccessor, SequenceNumberAccessor

The AbstractStopAndWaitTransmissionDecorator class implements a decorator providing StopAndWaitTransmission functionality for a Transmission.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.serial.AcknowledgeMagicBytesAccessor

AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<B extends AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<B>>, AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesMutator, AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesProperty

Nested classes/interfaces inherited from interface org.refcodes.serial.AcknowledgeRetryNumberAccessor

AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<B extends AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<B>>, AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberMutator, AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberProperty

Nested classes/interfaces inherited from interface org.refcodes.serial.AcknowledgeSegmentPackagerAccessor

AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<B extends AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<B>>, AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerMutator, AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerProperty

Nested classes/interfaces inherited from interface org.refcodes.serial.AcknowledgeTimeoutInMsAccessor

AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsBuilder<B extends AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsBuilder<B>>, AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsMutator, AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.DecorateeAccessor

org.refcodes.mixin.DecorateeAccessor.DecorateeBuilder<DECORATEE extends Object,B extends org.refcodes.mixin.DecorateeAccessor.DecorateeBuilder<DECORATEE,B>>, org.refcodes.mixin.DecorateeAccessor.DecorateeMutator<DECORATEE extends Object>, org.refcodes.mixin.DecorateeAccessor.DecorateeProperty<DECORATEE extends Object>

Nested classes/interfaces inherited from interface org.refcodes.numerical.EndianessAccessor

org.refcodes.numerical.EndianessAccessor.EndianessBuilder<B extends org.refcodes.numerical.EndianessAccessor.EndianessBuilder<B>>, org.refcodes.numerical.EndianessAccessor.EndianessMutator, org.refcodes.numerical.EndianessAccessor.EndianessProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.LengthAccessor

org.refcodes.mixin.LengthAccessor.LengthBuilder<B extends org.refcodes.mixin.LengthAccessor.LengthBuilder<B>>, org.refcodes.mixin.LengthAccessor.LengthMutator, org.refcodes.mixin.LengthAccessor.LengthProperty

Nested classes/interfaces inherited from interface org.refcodes.serial.SequenceNumberAccessor

SequenceNumberAccessor.SequenceNumberBuilder<B extends SequenceNumberAccessor.SequenceNumberBuilder<B>>, SequenceNumberAccessor.SequenceNumberMutator, SequenceNumberAccessor.SequenceNumberProperty

Nested classes/interfaces inherited from interface org.refcodes.serial.Transmission

Transmission.TransmissionMixin

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	_acknowledgeMagicBytes
protected MagicBytesSegment	_acknowledgeMagicBytesSegment
protected Segment	_acknowledgeSegment
protected SegmentPackager	_acknowledgeSegmentPackager
protected NumberSegment	_acknowledgeSequenceNumberSegment
protected org.refcodes.numerical.Endianess	_endianess
protected int	_sequenceNumber
protected org.refcodes.mixin.ConcatenateMode	_sequenceNumberConcatenateMode
protected int	_sequenceNumberInitValue
protected int	_sequenceNumberWidth
static String	ACK_MAGIC_BYTES

Fields inherited from class org.refcodes.serial.AbstractErrorCorrectionTransmissionDecorator

_acknowledgeRetryNumber, _acknowledgeTimeoutInMs, _decoratee, ACK_RETRY_NUMBER, ACK_TIMEOUT_IN_MS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractStopAndWaitTransmissionDecorator()	Instantiates a new abstract stop and wait transmission decorator.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, SegmentPackager aAckSegmentPackager)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
	AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
byte[]	getAcknowledgeMagicBytes()	Returns the ACK bytes to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
int	getAcknowledgeRetryNumber()	Retrieves the number of retries from the acknowledge retry number.
SegmentPackager	getAcknowledgeSegmentPackager()	Retrieves the SegmentPackager ACK property.
long	getAcknowledgeTimeoutInMs()	The acknowledge timeout attribute in milliseconds.
DECORATEE	getDecoratee()
org.refcodes.numerical.Endianess	getEndianess()
int	getLength()	Determines the overall length of this Transmission.
int	getSequenceNumber()	Retrieves the sequence number from the sequence number property.
int	hashCode()
protected long	readSequenceNumber(InputStream aInputStream)	Reads a sequence number from the InputStream.
Schema	toSchema()	Retrieves the Schema representing the Transmission.
Sequence	toSequence()	Provides the Sequence representation of this Transmission.
org.refcodes.struct.SimpleTypeMap	toSimpleTypeMap()	Returns the SimpleTypeMap representation of this Transmission.
String	toString()
void	transmitTo(OutputStream aOutputStream, InputStream aReturnStream)	Transmits the Sequence representing the implementing type's instance to the given OutputStream.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.refcodes.serial.Transmission

transmitTo, transmitTo

Field Detail

ACK_MAGIC_BYTES

public static final String ACK_MAGIC_BYTES

See Also:

Constant Field Values

_acknowledgeMagicBytes

protected byte[] _acknowledgeMagicBytes

_sequenceNumber

protected int _sequenceNumber

_sequenceNumberWidth

protected int _sequenceNumberWidth

_sequenceNumberInitValue

protected int _sequenceNumberInitValue

_sequenceNumberConcatenateMode

protected org.refcodes.mixin.ConcatenateMode _sequenceNumberConcatenateMode

_endianess

protected org.refcodes.numerical.Endianess _endianess

_acknowledgeSegmentPackager

protected SegmentPackager _acknowledgeSegmentPackager

_acknowledgeSegment

protected Segment _acknowledgeSegment

_acknowledgeSequenceNumberSegment

protected NumberSegment _acknowledgeSequenceNumberSegment

_acknowledgeMagicBytesSegment

protected MagicBytesSegment _acknowledgeMagicBytesSegment

Constructor Detail

AbstractStopAndWaitTransmissionDecorator

protected AbstractStopAndWaitTransmissionDecorator()

Instantiates a new abstract stop and wait transmission decorator.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                TransmissionMetrics aTransmissionMetrics)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                int aSequenceNumberInitValue,
                                                int aSequenceNumberWidth,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.

aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                SegmentPackager aAckSegmentPackager)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aAckSegmentPackager - The ACK SegmentPackager for packaging ACK responses.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                SegmentPackager aAckSegmentPackager,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aAckSegmentPackager - The ACK SegmentPackager for packaging ACK responses.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                SegmentPackager aAckSegmentPackager,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aAckSegmentPackager - The ACK SegmentPackager for packaging ACK responses.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                int aSequenceNumberInitValue,
                                                int aSequenceNumberWidth,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.

aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                int aSequenceNumberInitValue,
                                                int aSequenceNumberWidth,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.

aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                int aSequenceNumberInitValue,
                                                int aSequenceNumberWidth,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.

aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                                                org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                                                org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                                                org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                int aSequenceNumberInitValue,
                                                int aSequenceNumberWidth,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm,
                                                org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode,
                                                org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.

aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.

aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.

aEndianess - The Endianess to use for integer (double) numbers and the like.

AbstractStopAndWaitTransmissionDecorator

public AbstractStopAndWaitTransmissionDecorator(DECORATEE aDecoratee,
                                                int aSequenceNumberInitValue,
                                                int aSequenceNumberWidth,
                                                org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                                byte[] aAcknowledgeMagicBytes,
                                                int aAckRetryNumber,
                                                long aAckTimeoutInMs,
                                                SegmentPackager aAckSegmentPackager,
                                                org.refcodes.numerical.Endianess aEndianess)

Constructs an according stop-and-wait decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.

aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.

aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

aAckRetryNumber - The number of retries waiting for an ACK from the return channel.

aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.

aAckSegmentPackager - The ACK SegmentPackager for packaging ACK responses.

aEndianess - The Endianess to use for integer (double) numbers and the like.

Method Detail

transmitTo

public void transmitTo(OutputStream aOutputStream,
                       InputStream aReturnStream)
                throws IOException

Transmits the Sequence representing the implementing type's instance to the given OutputStream. Implementations providing error correction methods use the provided feedback InputStream to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the transmitted data.

Specified by:

transmitTo in interface Transmission

Specified by:

transmitTo in interface Transmission.TransmissionMixin

Parameters:

aOutputStream - The OutputStream where to write this instance's Sequence to.

aReturnStream - An InputStream being the return channel to handle "stop-and-wait ARQ" or the like in case of a bidirectional connection. Can be null in case we have a unidirectional connection.

Throws:

IOException - thrown in case writing data to the OutputStream caused problems.

toSchema

public Schema toSchema()

Retrieves the Schema representing the Transmission. Retrieving a Schema is useful when analyzing and debugging data structures such as a AllocSectionDecoratorSegment instance to help document, learn and verify on the structure (as well as the content) of that very AllocSectionDecoratorSegment.

Specified by:

toSchema in interface Transmission

Overrides:

toSchema in class AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission>

Returns:

The Schema representation of the implementing type for debugging and verification (or documentation) purposes.

getSequenceNumber

public int getSequenceNumber()

Retrieves the sequence number from the sequence number property.

Specified by:

getSequenceNumber in interface SequenceNumberAccessor

Returns:

The sequence number stored by the sequence number property.

getAcknowledgeRetryNumber

public int getAcknowledgeRetryNumber()

Retrieves the number of retries from the acknowledge retry number. A acknowledge retry number is the overall number of retries to use when counting retries.

Specified by:

getAcknowledgeRetryNumber in interface AcknowledgeRetryNumberAccessor

Overrides:

getAcknowledgeRetryNumber in class AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission>

Returns:

The number of retries stored by the acknowledge retry number.

getAcknowledgeTimeoutInMs

public long getAcknowledgeTimeoutInMs()

The acknowledge timeout attribute in milliseconds.

Specified by:

getAcknowledgeTimeoutInMs in interface AcknowledgeTimeoutInMsAccessor

Overrides:

getAcknowledgeTimeoutInMs in class AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission>

Returns:

An long integer with the timeout in milliseconds.

getAcknowledgeMagicBytes

public byte[] getAcknowledgeMagicBytes()

Returns the ACK bytes to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

Specified by:

getAcknowledgeMagicBytes in interface AcknowledgeMagicBytesAccessor

Specified by:

getAcknowledgeMagicBytes in interface StopAndWaitTransmission

Returns:

The ACK character.

getAcknowledgeSegmentPackager

public SegmentPackager getAcknowledgeSegmentPackager()

Retrieves the SegmentPackager ACK property.

Specified by:

getAcknowledgeSegmentPackager in interface AcknowledgeSegmentPackagerAccessor

Returns:

The SegmentPackager stored by the ACK SegmentPackager property.

getLength

public int getLength()

Determines the overall length of this Transmission. In case of nested Transmission instances, all length values from all sub-segments are accumulated to the result as well.

Specified by:

getLength in interface org.refcodes.mixin.LengthAccessor

Specified by:

getLength in interface Transmission

Overrides:

getLength in class AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission>

Returns:

The (overall) length of the Transmission (including any sub-segments).

toSequence

public Sequence toSequence()

Provides the Sequence representation of this Transmission. In case of nested Transmission instances, all Sequence representations from all sub-segments are accumulated to the result as well. Caution, the Transmission (or its nested Transmission instances) may be backed by the returned Sequence.

Specified by:

toSequence in interface Transmission

Overrides:

toSequence in class AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission>

Returns:

The according instance's Sequence.

getDecoratee

public DECORATEE getDecoratee()

Specified by:

getDecoratee in interface org.refcodes.mixin.DecorateeAccessor<DECORATEE extends Transmission>

Overrides:

getDecoratee in class AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission>

getEndianess

public org.refcodes.numerical.Endianess getEndianess()

Specified by:

getEndianess in interface org.refcodes.numerical.EndianessAccessor

toString

public String toString()

Overrides:

toString in class AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission>

toSimpleTypeMap

public org.refcodes.struct.SimpleTypeMap toSimpleTypeMap()

Returns the SimpleTypeMap representation of this Transmission. In case this Transmission has Transmission children, then the children are queried as well and contained in the resulting SimpleTypeMap. The aliases of the according Transmission instances represent the resulting path to a Transmission's final simple type.

Specified by:

toSimpleTypeMap in interface Transmission

Overrides:

toSimpleTypeMap in class AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission>

Returns:

The SimpleTypeMap representing this Transmission and (if any) its children, with the according aliases forming the paths to the Transmission's values.

readSequenceNumber

protected long readSequenceNumber(InputStream aInputStream)
                           throws IOException

Reads a sequence number from the InputStream.

Parameters:

aInputStream - The InputStream from which to read the sequence number.

Returns:

The accordingly read sequence number.

Throws:

IOException - thrown in case of I/O problems.