Module org.refcodes.serial

Package org.refcodes.serial

Class AbstractReadyToReceiveTransmissionDecorator<DECORATEE extends Transmission>

java.lang.Object

org.refcodes.serial.AbstractReadyToReceiveTransmissionDecorator<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.mixin.Schemable, EnquiryStandbyTimeMillisAccessor, ReadyToReceiveMagicBytesAccessor, ReadyToReceiveRetryNumberAccessor, ReadyToReceiveSegmentPackagerAccessor, ReadyToReceiveTimeoutMillisAccessor, ReadyToReceiveTransmission, Transmission, Transmission.TransmissionMixin

Direct Known Subclasses:

ReadyToReceiveSectionDecorator, ReadyToReceiveSegmentDecorator

public abstract class AbstractReadyToReceiveTransmissionDecorator<DECORATEE extends Transmission>
extends Object
implements ReadyToReceiveTransmission, Transmission.TransmissionMixin, org.refcodes.mixin.DecorateeAccessor<DECORATEE>

The AbstractReadyToReceiveTransmissionDecorator class implements a decorator providing ReadyToReceiveTransmission functionality for a Transmission.

See Also:

• Serialized Form

Nested Class Summary

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.serial.EnquiryStandbyTimeMillisAccessor

EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisBuilder<B extends EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisBuilder<B>>, EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisMutator, EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisProperty

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

ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<B extends ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<B>>, ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesMutator, ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesProperty

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

ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<B extends ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<B>>, ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberMutator, ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberProperty

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

ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B extends ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B>>, ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerMutator, ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerProperty

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

ReadyToReceiveTimeoutMillisAccessor.ReadyToReceiveTimeoutMillisBuilder<B extends ReadyToReceiveTimeoutMillisAccessor.ReadyToReceiveTimeoutMillisBuilder<B>>, ReadyToReceiveTimeoutMillisAccessor.ReadyToReceiveTimeoutMillisMutator, ReadyToReceiveTimeoutMillisAccessor.ReadyToReceiveTimeoutMillisProperty

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

Transmission.TransmissionMixin

Field Summary

Fields

Modifier and Type	Field	Description
protected DECORATEE	_decoratee
protected long	_enquiryStandbyTimeInMs
protected byte[]	_readyToReceiveMagicBytes
protected MagicBytesSegment	_readyToReceiveMagicByteSegment
protected int	_readyToReceiveRetryNumber
protected Segment	_readyToReceiveSegment
protected SegmentPackager	_readyToReceiveSegmentPackager
protected long	_readyToReceiveTimeoutInMs
static final String	RTR_MAGIC_BYTES
static final String	RTR_RETRY_NUMBER
static final String	RTR_TIMEOUT_IN_MS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractReadyToReceiveTransmissionDecorator()	Instantiates a new abstract ready to receive transmission decorator.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToReceiveTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
	AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)	Constructs an according control-flow decorator instance wrapping the given decoratee.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
DECORATEE	getDecoratee()
long	getEnquiryStandbyTimeMillis()	The ENQ ("enquiry") timeout attribute in milliseconds.
int	getLength()	Determines the overall length of this Transmission.
byte[]	getReadyToReceiveMagicBytes()	Retrieves the magic bytes from the RTR ("ready-to-receive") magic bytes property.
int	getReadyToReceiveRetryNumber()	Retrieves the number of retries from the RTR ("ready-to-receive") retry number.
SegmentPackager	getReadyToReceiveSegmentPackager()	Retrieves the SegmentPackager RTR ("ready-to-receive") property.
long	getReadyToReceiveTimeoutMillis()	The RTR ("ready-to-receive") timeout attribute in milliseconds.
int	hashCode()
SerialSchema	toSchema()
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 Details

RTR_MAGIC_BYTES

public static final String RTR_MAGIC_BYTES

See Also:

• Constant Field Values

RTR_TIMEOUT_IN_MS

public static final String RTR_TIMEOUT_IN_MS

See Also:

• Constant Field Values

RTR_RETRY_NUMBER

public static final String RTR_RETRY_NUMBER

See Also:

• Constant Field Values

_decoratee

protected DECORATEE extends Transmission _decoratee

_enquiryStandbyTimeInMs

protected long _enquiryStandbyTimeInMs

_readyToReceiveTimeoutInMs

protected long _readyToReceiveTimeoutInMs

_readyToReceiveMagicBytes

protected byte[] _readyToReceiveMagicBytes

_readyToReceiveSegmentPackager

protected SegmentPackager _readyToReceiveSegmentPackager

_readyToReceiveRetryNumber

protected int _readyToReceiveRetryNumber

_readyToReceiveMagicByteSegment

protected MagicBytesSegment _readyToReceiveMagicByteSegment

_readyToReceiveSegment

protected Segment _readyToReceiveSegment

Constructor Details

AbstractReadyToReceiveTransmissionDecorator

protected AbstractReadyToReceiveTransmissionDecorator()

Instantiates a new abstract ready to receive transmission decorator.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 TransmissionMetrics aTransmissionMetrics)

Constructs an according control-flow 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 control-flow decorator.

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

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 byte[] aReadyToReceiveMagicBytes)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 byte[] aReadyToReceiveMagicBytes,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aReadyToReceiveTimeoutInMs,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 byte[] aReadyToReceiveMagicBytes,
 int aReadyToReceiveRetryNumber)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 int aReadyToReceiveRetryNumber,
 long aReadyToReceiveTimeoutInMs)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 byte[] aReadyToReceiveMagicBytes,
 int aReadyToReceiveRetryNumber,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 int aReadyToReceiveRetryNumber,
 long aReadyToReceiveTimeoutInMs,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 byte[] aReadyToReceiveMagicBytes,
 long aReadyToReceiveTimeoutInMs)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 byte[] aReadyToReceiveMagicBytes,
 long aReadyToReceiveTimeoutInMs,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToReceiveMagicBytes)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 long aReadyToReceiveTimeoutInMs)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToReceiveMagicBytes,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 long aReadyToReceiveTimeoutInMs,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToReceiveMagicBytes,
 int aReadyToReceiveRetryNumber)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 int aReadyToReceiveRetryNumber,
 long aReadyToReceiveTimeoutInMs)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToReceiveMagicBytes,
 int aReadyToReceiveRetryNumber,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 int aReadyToReceiveRetryNumber,
 long aReadyToReceiveTimeoutInMs,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToReceiveMagicBytes,
 long aReadyToReceiveTimeoutInMs)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToReceiveMagicBytes,
 long aReadyToReceiveTimeoutInMs,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 byte[] aReadyToReceiveMagicBytes,
 int aReadyToReceiveRetryNumber,
 long aReadyToReceiveTimeoutInMs,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

AbstractReadyToReceiveTransmissionDecorator

public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToReceiveMagicBytes,
 int aReadyToReceiveRetryNumber,
 long aReadyToReceiveTimeoutInMs,
 SegmentPackager aReadyToReceiveSegmentPackager)

Constructs an according flow-control decorator instance wrapping the given decoratee.

Parameters:

aDecoratee - The decoratee to be wrapped by the flow-control decorator.

aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.

aReadyToReceiveMagicBytes - The RTR character to be used to signal a RTR.

aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.

aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-receive") to the transmitter.

aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.

Method Details

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 SerialSchema toSchema()

Specified by:

toSchema in interface org.refcodes.mixin.Schemable

Specified by:

toSchema in interface Transmission

getEnquiryStandbyTimeMillis

public long getEnquiryStandbyTimeMillis()

The ENQ ("enquiry") timeout attribute in milliseconds.

Specified by:

getEnquiryStandbyTimeMillis in interface EnquiryStandbyTimeMillisAccessor

Returns:

An integer with the ENQ ("enquiry") timeout in milliseconds.

getReadyToReceiveTimeoutMillis

public long getReadyToReceiveTimeoutMillis()

The RTR ("ready-to-receive") timeout attribute in milliseconds.

Specified by:

getReadyToReceiveTimeoutMillis in interface ReadyToReceiveTimeoutMillisAccessor

Returns:

An integer with the RTR ("ready-to-receive") timeout in milliseconds.

getReadyToReceiveMagicBytes

public byte[] getReadyToReceiveMagicBytes()

Retrieves the magic bytes from the RTR ("ready-to-receive") magic bytes property.

Specified by:

getReadyToReceiveMagicBytes in interface ReadyToReceiveMagicBytesAccessor

Returns:

The magic bytes stored by the RTR ("ready-to-receive") magic bytes property.

getReadyToReceiveRetryNumber

public int getReadyToReceiveRetryNumber()

Retrieves the number of retries from the RTR ("ready-to-receive") retry number. A RTR retry number is the overall number of retries to use when counting retries.

Specified by:

getReadyToReceiveRetryNumber in interface ReadyToReceiveRetryNumberAccessor

Returns:

The number of retries stored by the RTR ("ready-to-receive") retry number.

getReadyToReceiveSegmentPackager

public SegmentPackager getReadyToReceiveSegmentPackager()

Retrieves the SegmentPackager RTR ("ready-to-receive") property.

Specified by:

getReadyToReceiveSegmentPackager in interface ReadyToReceiveSegmentPackagerAccessor

Returns:

The SegmentPackager stored by the RTR ("ready-to-receive") 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

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

Returns:

The according instance's Sequence.

getDecoratee

public DECORATEE getDecoratee()

Specified by:

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

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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

Returns:

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