DECORATEE
- The decoratee type describing the according subclass to be
enriched.Serializable
, org.refcodes.mixin.DecorateeAccessor<DECORATEE>
, org.refcodes.mixin.LengthAccessor
, EnquiryStandbyTimeInMsAccessor
, ReadyToReceiveMagicBytesAccessor
, ReadyToReceiveRetryNumberAccessor
, ReadyToReceiveSegmentPackagerAccessor
, ReadyToReceiveTimeoutInMsAccessor
, ReadyToReceiveTransmission
, Transmission
, Transmission.TransmissionMixin
ReadyToReceiveSectionDecorator
, ReadyToReceiveSegmentDecorator
public abstract class AbstractReadyToReceiveTransmissionDecorator<DECORATEE extends Transmission> extends Object implements ReadyToReceiveTransmission, Transmission.TransmissionMixin, org.refcodes.mixin.DecorateeAccessor<DECORATEE>
AbstractReadyToReceiveTransmissionDecorator
class implements a
decorator providing ReadyToReceiveTransmission
functionality for a
Transmission
.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>
EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsBuilder<B extends EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsBuilder<B>>, EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsMutator, EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsProperty
org.refcodes.mixin.LengthAccessor.LengthBuilder<B extends org.refcodes.mixin.LengthAccessor.LengthBuilder<B>>, org.refcodes.mixin.LengthAccessor.LengthMutator, org.refcodes.mixin.LengthAccessor.LengthProperty
ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<B extends ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<B>>, ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesMutator, ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesProperty
ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<B extends ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<B>>, ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberMutator, ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberProperty
ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B extends ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B>>, ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerMutator, ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerProperty
ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsBuilder<B extends ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsBuilder<B>>, ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsMutator, ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsProperty
Transmission.TransmissionMixin
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 String |
RTR_MAGIC_BYTES |
|
static String |
RTR_RETRY_NUMBER |
|
static String |
RTR_TIMEOUT_IN_MS |
Modifier | Constructor | Description |
---|---|---|
protected |
AbstractReadyToReceiveTransmissionDecorator() |
|
|
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.
|
Modifier and Type | Method | Description |
---|---|---|
boolean |
equals(Object obj) |
|
DECORATEE |
getDecoratee() |
|
long |
getEnquiryStandbyTimeInMs() |
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 |
getReadyToReceiveTimeoutInMs() |
The RTR ("ready-to-receive") timeout attribute in milliseconds.
|
int |
hashCode() |
|
Schema |
toSchema() |
Retrieves the
Schema representing the Transmission . |
org.refcodes.struct.SimpleTypeMap |
toSimpleTypeMap() |
Returns the
SimpleTypeMap representation of this
Transmission . |
String |
toString() |
|
Sequence |
toTransmission() |
Provides the
Sequence representation of this
Transmission . |
void |
transmitTo(OutputStream aOutputStream,
InputStream aReturnStream) |
Transmits the
Sequence representing the implementing type's
instance to the given OutputStream . |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
fromInputStream, transmitTo, transmitTo
public static final String RTR_MAGIC_BYTES
public static final String RTR_TIMEOUT_IN_MS
public static final String RTR_RETRY_NUMBER
protected DECORATEE extends Transmission _decoratee
protected long _enquiryStandbyTimeInMs
protected long _readyToReceiveTimeoutInMs
protected byte[] _readyToReceiveMagicBytes
protected SegmentPackager _readyToReceiveSegmentPackager
protected int _readyToReceiveRetryNumber
protected MagicBytesSegment _readyToReceiveMagicByteSegment
protected Segment _readyToReceiveSegment
protected AbstractReadyToReceiveTransmissionDecorator()
public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
TransmissionMetrics
configuration object, though only those
attributes are supported which are also supported by the other
constructors!aDecoratee
- The decoratee to be wrapped by the control-flow
decorator.aTransmissionMetrics
- The TransmissionMetrics
to be used
for configuring this instance.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aReadyToReceiveMagicBytes
- The RTR character to be used to signal a
RTR.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToReceiveTimeoutInMs)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
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.public AbstractReadyToReceiveTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
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.public void transmitTo(OutputStream aOutputStream, InputStream aReturnStream) throws IOException
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.transmitTo
in interface Transmission
transmitTo
in interface Transmission.TransmissionMixin
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.IOException
- thrown in case writing data to the
OutputStream
caused problems.public Schema toSchema()
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
.toSchema
in interface Transmission
Schema
representation of the implementing type for
debugging and verification (or documentation) purposes.public long getEnquiryStandbyTimeInMs()
getEnquiryStandbyTimeInMs
in interface EnquiryStandbyTimeInMsAccessor
public long getReadyToReceiveTimeoutInMs()
getReadyToReceiveTimeoutInMs
in interface ReadyToReceiveTimeoutInMsAccessor
public byte[] getReadyToReceiveMagicBytes()
getReadyToReceiveMagicBytes
in interface ReadyToReceiveMagicBytesAccessor
public int getReadyToReceiveRetryNumber()
getReadyToReceiveRetryNumber
in interface ReadyToReceiveRetryNumberAccessor
public SegmentPackager getReadyToReceiveSegmentPackager()
SegmentPackager
RTR ("ready-to-receive") property.getReadyToReceiveSegmentPackager
in interface ReadyToReceiveSegmentPackagerAccessor
SegmentPackager
stored by the RTR
("ready-to-receive") SegmentPackager
property.public int getLength()
Transmission
. In case of
nested Transmission
instances, all length values from all
sub-segments are accumulated to the result as well.getLength
in interface org.refcodes.mixin.LengthAccessor
getLength
in interface Transmission
Transmission
(including any
sub-segments).public Sequence toTransmission()
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.toTransmission
in interface Transmission
Sequence
.public DECORATEE getDecoratee()
getDecoratee
in interface org.refcodes.mixin.DecorateeAccessor<DECORATEE extends Transmission>
public org.refcodes.struct.SimpleTypeMap toSimpleTypeMap()
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.toSimpleTypeMap
in interface Transmission
SimpleTypeMap
representing this Transmission
and (if any) its children, with the according aliases forming the
paths to the Transmission
's values.Copyright © 2021. All rights reserved.