Module org.refcodes.serial

Package org.refcodes.serial

Interface ReadyToSendTransmission

All Superinterfaces:

ClearToSendMagicBytesAccessor, ClearToSendSegmentPackagerAccessor, ClearToSendTimeoutInMsAccessor, EnquiryStandbyTimeInMsAccessor, org.refcodes.mixin.LengthAccessor, ReadyToSendMagicBytesAccessor, ReadyToSendRetryNumberAccessor, ReadyToSendSegmentPackagerAccessor, ReadyToSendTimeoutInMsAccessor, Serializable, Transmission

All Known Implementing Classes:

AbstractReadyToSendTransmissionDecorator, ReadyToSendSectionDecorator, ReadyToSendSegmentDecorator

public interface ReadyToSendTransmission
extends EnquiryStandbyTimeInMsAccessor, ReadyToSendMagicBytesAccessor, ReadyToSendRetryNumberAccessor, ReadyToSendSegmentPackagerAccessor, ReadyToSendTimeoutInMsAccessor, ClearToSendMagicBytesAccessor, ClearToSendTimeoutInMsAccessor, ClearToSendSegmentPackagerAccessor, Transmission

The ReadyToSendTransmission interface defines functionality for achieving an RTS "software" handshake between a transmitter having the active RTS ("ready-to-send") role and a receiver confirming being CTS ("clear-to-send") where the receiver waits for a RTS signal from the transmitter (the transmitter signals to be ready for sending data by issuing an RTS signal to the receiver). Upon the receiver's CTS ("clear-to-send") acknowledgement, the transmitter starts sending: TRANSMITTER RECEIVER | | Send RTS magic-bytes | | Wait till enquiry-timeout Try RTS retry-number of times |------RTS-----→| for RTR magic-bytes Wait till RTS retry-timeout/retry | | | | | | Send CTS magic-bytes Send payload upon CTS |←-----CTS------| Wait till CTS timeout magic-bytes or break-out | | upon RTS retry-timeout x retries |----PAYLOAD---→| Receive payload | |

Nested Class Summary

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

ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<B extends ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<B>>, ClearToSendMagicBytesAccessor.ClearToSendMagicBytesMutator, ClearToSendMagicBytesAccessor.ClearToSendMagicBytesProperty

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

ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B extends ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B>>, ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerMutator, ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerProperty

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

ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsBuilder<B extends ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsBuilder<B>>, ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsMutator, ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsProperty

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

EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsBuilder<B extends EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsBuilder<B>>, EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsMutator, EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsProperty

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

ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<B extends ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<B>>, ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesMutator, ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesProperty

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

ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<B extends ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<B>>, ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberMutator, ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberProperty

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

ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B extends ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B>>, ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerMutator, ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerProperty

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

ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsBuilder<B extends ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsBuilder<B>>, ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsMutator, ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsProperty

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

Transmission.TransmissionMixin

Method Summary

Methods inherited from interface org.refcodes.serial.ClearToSendMagicBytesAccessor

getClearToSendMagicBytes

Methods inherited from interface org.refcodes.serial.ClearToSendSegmentPackagerAccessor

getClearToSendSegmentPackager

Methods inherited from interface org.refcodes.serial.ClearToSendTimeoutInMsAccessor

getClearToSendTimeoutInMs

Methods inherited from interface org.refcodes.serial.EnquiryStandbyTimeInMsAccessor

getEnquiryStandbyTimeInMs

Methods inherited from interface org.refcodes.serial.ReadyToSendMagicBytesAccessor

getReadyToSendMagicBytes

Methods inherited from interface org.refcodes.serial.ReadyToSendRetryNumberAccessor

getReadyToSendRetryNumber

Methods inherited from interface org.refcodes.serial.ReadyToSendSegmentPackagerAccessor

getReadyToSendSegmentPackager

Methods inherited from interface org.refcodes.serial.ReadyToSendTimeoutInMsAccessor

getReadyToSendTimeoutInMs

Methods inherited from interface org.refcodes.serial.Transmission

getLength, toSchema, toSequence, toSimpleTypeMap, transmitTo, transmitTo, transmitTo