Module org.refcodes.serial

Package org.refcodes.serial

Interface ReadyToReceiveTransmission

All Superinterfaces:

EnquiryStandbyTimeInMsAccessor, org.refcodes.mixin.LengthAccessor, ReadyToReceiveMagicBytesAccessor, ReadyToReceiveRetryNumberAccessor, ReadyToReceiveSegmentPackagerAccessor, ReadyToReceiveTimeoutInMsAccessor, Serializable, Transmission

All Known Implementing Classes:

AbstractReadyToReceiveTransmissionDecorator, ReadyToReceiveSectionDecorator, ReadyToReceiveSegmentDecorator

public interface ReadyToReceiveTransmission
extends EnquiryStandbyTimeInMsAccessor, ReadyToReceiveMagicBytesAccessor, ReadyToReceiveRetryNumberAccessor, ReadyToReceiveSegmentPackagerAccessor, ReadyToReceiveTimeoutInMsAccessor, Transmission

The ReadyToReceiveTransmission interface defines functionality for achieving a RTR "software" handshake between a receiver having the active RTR ("ready-to-receive") role and a transmitter being CTS ("clear-to-send") where the transmitter waits for a RTR signal from the receiver (the receiver signals to be ready for receiving data by issuing an RTR signal to the transmitter): TRANSMITTER RECEIVER | | Wait till enquiry-timeout | | Send RTR magic-bytes for RTR magic-bytes |←-----RTR------| Try RTR retry-number of times | | Wait till RTR retry-timeout/retry Send payload upon RTR | | magic-bytes or break-out |----PAYLOAD---→| Receive payload upon enquiry-timeout | | Handshake specific signals are only transmitted through the return channel, the data channel is only used indirectly for handshaking by transporting the payload data in response to the return channel signals. No handshake specific signals are transmitted through the data channel, so in case there is no return channel, the ReadyToReceiveTransmission behaves invisible.

Nested Class Summary

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

ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsBuilder<B extends ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsBuilder<B>>, ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsMutator, ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsProperty

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

Transmission.TransmissionMixin

Method Summary

Methods inherited from interface org.refcodes.serial.EnquiryStandbyTimeInMsAccessor

getEnquiryStandbyTimeInMs

Methods inherited from interface org.refcodes.serial.ReadyToReceiveMagicBytesAccessor

getReadyToReceiveMagicBytes

Methods inherited from interface org.refcodes.serial.ReadyToReceiveRetryNumberAccessor

getReadyToReceiveRetryNumber

Methods inherited from interface org.refcodes.serial.ReadyToReceiveSegmentPackagerAccessor

getReadyToReceiveSegmentPackager

Methods inherited from interface org.refcodes.serial.ReadyToReceiveTimeoutInMsAccessor

getReadyToReceiveTimeoutInMs

Methods inherited from interface org.refcodes.serial.Transmission

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