DECORATEE
- The decoratee type describing the according subclass to be
enriched.Serializable
, org.refcodes.mixin.DecorateeAccessor<DECORATEE>
, org.refcodes.mixin.LengthAccessor
, ClearToSendMagicBytesAccessor
, ClearToSendSegmentPackagerAccessor
, ClearToSendTimeoutInMsAccessor
, EnquiryStandbyTimeInMsAccessor
, ReadyToSendMagicBytesAccessor
, ReadyToSendRetryNumberAccessor
, ReadyToSendSegmentPackagerAccessor
, ReadyToSendTimeoutInMsAccessor
, ReadyToSendTransmission
, Transmission
, Transmission.TransmissionMixin
ReadyToSendSectionDecorator
, ReadyToSendSegmentDecorator
public abstract class AbstractReadyToSendTransmissionDecorator<DECORATEE extends Transmission> extends Object implements ReadyToSendTransmission, Transmission.TransmissionMixin, org.refcodes.mixin.DecorateeAccessor<DECORATEE>
AbstractReadyToSendTransmissionDecorator
class implements a
decorator providing ReadyToSendTransmission
functionality for a
Transmission
.ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<B extends ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<B>>, ClearToSendMagicBytesAccessor.ClearToSendMagicBytesMutator, ClearToSendMagicBytesAccessor.ClearToSendMagicBytesProperty
ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B extends ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B>>, ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerMutator, ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerProperty
ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsBuilder<B extends ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsBuilder<B>>, ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsMutator, ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsProperty
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
ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<B extends ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<B>>, ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesMutator, ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesProperty
ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<B extends ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<B>>, ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberMutator, ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberProperty
ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B extends ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B>>, ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerMutator, ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerProperty
ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsBuilder<B extends ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsBuilder<B>>, ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsMutator, ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsProperty
Transmission.TransmissionMixin
Modifier and Type | Field | Description |
---|---|---|
protected byte[] |
_clearToSendMagicBytes |
|
protected MagicBytesSegment |
_clearToSendMagicBytesSegment |
|
protected Segment |
_clearToSendSegment |
|
protected SegmentPackager |
_clearToSendSegmentPackager |
|
protected long |
_clearToSendTimeoutInMs |
|
protected DECORATEE |
_decoratee |
|
protected long |
_enquiryStandbyTimeInMs |
|
protected byte[] |
_readyToSendMagicBytes |
|
protected MagicBytesSegment |
_readyToSendMagicBytesSegment |
|
protected int |
_readyToSendRetryNumber |
|
protected Segment |
_readyToSendSegment |
|
protected SegmentPackager |
_readyToSendSegmentPackager |
|
protected long |
_readyToSendTimeoutInMs |
|
static String |
CTS_MAGIC_BYTES |
|
static String |
CTS_TIMEOUT_IN_MS |
|
static String |
RTS_MAGIC_BYTES |
|
static String |
RTS_RETRY_NUMBER |
|
static String |
RTS_TIMEOUT_IN_MS |
Modifier | Constructor | Description |
---|---|---|
protected |
AbstractReadyToSendTransmissionDecorator() |
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
byte[] aReadyToSendMagicBytes,
byte[] aClearToSendMagicBytes) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
byte[] aReadyToSendMagicBytes,
int aReadyToSendRetryNumber,
byte[] aClearToSendMagicBytes) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
byte[] aReadyToSendMagicBytes,
int aReadyToSendRetryNumber,
long aReadyToSendTimeoutInMs,
SegmentPackager aReadyToSendSegmentPackager,
byte[] aClearToSendMagicBytes,
long aClearToSendTimeoutInMs,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
byte[] aReadyToSendMagicBytes,
int aReadyToSendRetryNumber,
SegmentPackager aReadyToSendSegmentPackager,
byte[] aClearToSendMagicBytes,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
byte[] aReadyToSendMagicBytes,
long aReadyToSendTimeoutInMs,
byte[] aClearToSendMagicBytes,
long aClearToSendTimeoutInMs) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
byte[] aReadyToSendMagicBytes,
long aReadyToSendTimeoutInMs,
SegmentPackager aReadyToSendSegmentPackager,
byte[] aClearToSendMagicBytes,
long aClearToSendTimeoutInMs,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
byte[] aReadyToSendMagicBytes,
SegmentPackager aReadyToSendSegmentPackager,
byte[] aClearToSendMagicBytes,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
int aReadyToSendRetryNumber,
long aReadyToSendTimeoutInMs,
long aClearToSendTimeoutInMs) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
int aReadyToSendRetryNumber,
long aReadyToSendTimeoutInMs,
SegmentPackager aReadyToSendSegmentPackager,
long aClearToSendTimeoutInMs,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs,
byte[] aReadyToSendMagicBytes,
byte[] aClearToSendMagicBytes) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs,
byte[] aReadyToSendMagicBytes,
int aReadyToSendRetryNumber,
byte[] aClearToSendMagicBytes) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs,
byte[] aReadyToSendMagicBytes,
int aReadyToSendRetryNumber,
long aReadyToSendTimeoutInMs,
SegmentPackager aReadyToSendSegmentPackager,
byte[] aClearToSendMagicBytes,
long aClearToSendTimeoutInMs,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs,
byte[] aReadyToSendMagicBytes,
int aReadyToSendRetryNumber,
SegmentPackager aReadyToSendSegmentPackager,
byte[] aClearToSendMagicBytes,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs,
byte[] aReadyToSendMagicBytes,
long aReadyToSendTimeoutInMs,
byte[] aClearToSendMagicBytes,
long aClearToSendTimeoutInMs) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs,
byte[] aReadyToSendMagicBytes,
long aReadyToSendTimeoutInMs,
SegmentPackager aReadyToSendSegmentPackager,
byte[] aClearToSendMagicBytes,
long aClearToSendTimeoutInMs,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs,
byte[] aReadyToSendMagicBytes,
SegmentPackager aReadyToSendSegmentPackager,
byte[] aClearToSendMagicBytes,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs,
int aReadyToSendRetryNumber,
long aReadyToSendTimeoutInMs,
long aClearToSendTimeoutInMs) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs,
int aReadyToSendRetryNumber,
long aReadyToSendTimeoutInMs,
SegmentPackager aReadyToSendSegmentPackager,
long aClearToSendTimeoutInMs,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs,
long aReadyToSendTimeoutInMs,
long aClearToSendTimeoutInMs) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aEnquiryStandbyTimeInMs,
long aReadyToSendTimeoutInMs,
SegmentPackager aReadyToSendSegmentPackager,
long aClearToSendTimeoutInMs,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
long aReadyToSendTimeoutInMs,
SegmentPackager aReadyToSendSegmentPackager,
long aClearToSendTimeoutInMs,
SegmentPackager aClearToSendSegmentPackager) |
Constructs an according flow-control decorator instance wrapping the
given decoratee.
|
|
AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee,
TransmissionMetrics aTransmissionMetrics) |
Constructs an according control-flow decorator instance wrapping the
given decoratee.
|
Modifier and Type | Method | Description |
---|---|---|
boolean |
equals(Object obj) |
|
byte[] |
getClearToSendMagicBytes() |
Retrieves the magic bytes from the CTS ("clear-to-send") magic bytes
property.
|
SegmentPackager |
getClearToSendSegmentPackager() |
Retrieves the
SegmentPackager CTS ("clear-to-send") property. |
long |
getClearToSendTimeoutInMs() |
The CTS ("clear-to-send") timeout attribute in milliseconds.
|
DECORATEE |
getDecoratee() |
|
long |
getEnquiryStandbyTimeInMs() |
The ENQ ("enquiry") timeout attribute in milliseconds.
|
int |
getLength() |
Determines the overall length of this
Transmission . |
byte[] |
getReadyToSendMagicBytes() |
Retrieves the magic bytes from the RTS ("ready-to-send") magic bytes
property.
|
int |
getReadyToSendRetryNumber() |
Retrieves the number of retries from the RTS ("ready-to-send") retry
number.
|
SegmentPackager |
getReadyToSendSegmentPackager() |
Retrieves the
SegmentPackager RTS ("ready-to-send") property. |
long |
getReadyToSendTimeoutInMs() |
The RTS ("ready-to-send") timeout attribute in milliseconds.
|
int |
hashCode() |
|
protected void |
receiveCtsTransmitTo(OutputStream aOutputStream,
InputStream aReturnStream) |
|
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 RTS_MAGIC_BYTES
public static final String RTS_TIMEOUT_IN_MS
public static final String RTS_RETRY_NUMBER
public static final String CTS_MAGIC_BYTES
public static final String CTS_TIMEOUT_IN_MS
protected DECORATEE extends Transmission _decoratee
protected long _enquiryStandbyTimeInMs
protected long _clearToSendTimeoutInMs
protected byte[] _clearToSendMagicBytes
protected MagicBytesSegment _clearToSendMagicBytesSegment
protected Segment _clearToSendSegment
protected SegmentPackager _clearToSendSegmentPackager
protected long _readyToSendTimeoutInMs
protected byte[] _readyToSendMagicBytes
protected SegmentPackager _readyToSendSegmentPackager
protected int _readyToSendRetryNumber
protected MagicBytesSegment _readyToSendMagicBytesSegment
protected Segment _readyToSendSegment
protected AbstractReadyToSendTransmissionDecorator()
public AbstractReadyToSendTransmissionDecorator(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 AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, byte[] aClearToSendMagicBytes)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
no timeout (blocking mode).public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS responses.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS responses.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, byte[] aClearToSendMagicBytes)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendRetryNumber
- The number of retries sending an RTS over
the payload (data) channel.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aReadyToSendRetryNumber
- The number of retries sending an RTS over
the payload (data) channel.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendRetryNumber
- The number of retries sending an RTS over
the payload (data) channel.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS responses.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aReadyToSendRetryNumber
- The number of retries sending an RTS over
the payload (data) channel.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS responses.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS responses.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, byte[] aClearToSendMagicBytes)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
the timeout being disabled.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
the timeout being disabled.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
the timeout being disabled.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS responses.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
the timeout being disabled.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS responses.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, byte[] aClearToSendMagicBytes)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
the timeout being disabled.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendRetryNumber
- The number of retries sending an RTS over
the payload (data) channel.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
the timeout being disabled.aReadyToSendRetryNumber
- The number of retries sending an RTS over
the payload (data) channel.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
the timeout being disabled.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendRetryNumber
- The number of retries sending an RTS over
the payload (data) channel.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS responses.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
the timeout being disabled.aReadyToSendRetryNumber
- The number of retries sending an RTS over
the payload (data) channel.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS responses.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
the timeout being disabled.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
the timeout being disabled.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS responses.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendRetryNumber
- The number of retries sending an RTS over
the payload (data) channel.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
RTS ("ready-to-receive") to the transmitter.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS responses.public AbstractReadyToSendTransmissionDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
aDecoratee
- The decoratee to be wrapped by the flow-control
decorator.aEnquiryStandbyTimeInMs
- The timeout in milliseconds to wait for an
RTS request (receiver) from the transmitter. A value of -1 denotes
the timeout being disabled.aReadyToSendMagicBytes
- The RTS characters to be used to signal a
RTS.aReadyToSendRetryNumber
- The number of retries sending an RTS over
the payload (data) channel.aReadyToSendTimeoutInMs
- The timeout in milliseconds to wait for a
CTS response (transmitter) from the receiver after signaling a RTS
("ready-to-send") to the receiver.aReadyToSendSegmentPackager
- The RTS SegmentPackager
for
packaging RTS responses.aClearToSendMagicBytes
- The CTS characters to be used to signal a
CTS.aClearToSendTimeoutInMs
- The timeout in milliseconds to wait for a
payload response (receiver) from the transmitter after signaling a
CTS ("ready-to-receive") to the transmitter.aClearToSendSegmentPackager
- The CTS SegmentPackager
for
packaging CTS 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.protected void receiveCtsTransmitTo(OutputStream aOutputStream, InputStream aReturnStream) throws IOException, TransmissionException, FlowControlTimeoutException
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 getReadyToSendTimeoutInMs()
getReadyToSendTimeoutInMs
in interface ReadyToSendTimeoutInMsAccessor
public byte[] getReadyToSendMagicBytes()
getReadyToSendMagicBytes
in interface ReadyToSendMagicBytesAccessor
public int getReadyToSendRetryNumber()
getReadyToSendRetryNumber
in interface ReadyToSendRetryNumberAccessor
public SegmentPackager getReadyToSendSegmentPackager()
SegmentPackager
RTS ("ready-to-send") property.getReadyToSendSegmentPackager
in interface ReadyToSendSegmentPackagerAccessor
SegmentPackager
stored by the RTS ("ready-to-send")
SegmentPackager
property.public byte[] getClearToSendMagicBytes()
getClearToSendMagicBytes
in interface ClearToSendMagicBytesAccessor
public long getClearToSendTimeoutInMs()
getClearToSendTimeoutInMs
in interface ClearToSendTimeoutInMsAccessor
public SegmentPackager getClearToSendSegmentPackager()
SegmentPackager
CTS ("clear-to-send") property.getClearToSendSegmentPackager
in interface ClearToSendSegmentPackagerAccessor
SegmentPackager
stored by the CTS ("clear-to-send")
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.