Module org.refcodes.serial

Package org.refcodes.serial

Interface Summary

Interface	Description
AcknowledgeMagicBytesAccessor	Provides an accessor for a acknowledge magic bytes property.
AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<B extends AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<B>>	Provides a builder method for a acknowledge magic bytes property returning the builder for applying multiple build operations.
AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesMutator	Provides a mutator for a acknowledge magic bytes property.
AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesProperty	Provides a acknowledge magic bytes property.
AcknowledgeRetryNumberAccessor	Provides an accessor for a acknowledge retry number.
AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<B extends AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<B>>	Provides a builder method for a acknowledge retry number returning the builder for applying multiple build operations.
AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberMutator	Provides a mutator for a acknowledge retry number.
AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberProperty	Provides a acknowledge retry number.A acknowledge retry number is the overall number of retries to use when counting retries.
AcknowledgeSegmentPackagerAccessor	Provides an accessor for a SegmentPackager ACK property.
AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<B extends AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<B>>	Provides a builder method for a SegmentPackager ACK property returning the builder for applying multiple build operations.
AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerMutator	Provides a mutator for a SegmentPackager ACK property.
AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerProperty	Provides a SegmentPackager ACK property.
AcknowledgeTimeoutInMsAccessor	Provides an accessor for a acknowledge timeout in milliseconds property.
AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsBuilder<B extends AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsBuilder<B>>	Provides a builder method for the acknowledge timeout property returning the builder for applying multiple build operations.
AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsMutator	Provides a mutator for a acknowledge timeout in milliseconds property.
AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsProperty	Provides a acknowledge timeout in milliseconds property.
AllocLengthAccessor	Provides an accessor for a allocation length property.
AllocLengthAccessor.AllocLengthBuilder<B extends AllocLengthAccessor.AllocLengthBuilder<B>>	Provides a builder method for a allocation length property returning the builder for applying multiple build operations.
AllocLengthAccessor.AllocLengthMutator	Provides a mutator for a allocation length property.
AllocLengthAccessor.AllocLengthProperty	Provides a allocation length property.
ArraySection<ARRAY extends Transmission>	A ArraySection is a Section with array Transmission elements as of ArrayTransmission.
ArraySegment<SEGMENT extends Segment>	A ArraySegment is a Segment with array Segment elements as of ArrayTransmission.
ArrayTransmission<ARRAY extends Transmission>	A ArrayTransmission is a Transmission with array Transmission elements.
ClearToSendMagicBytesAccessor	Provides an accessor for a CTS ("clear-to-send") magic bytes property.
ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<B extends ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<B>>	Provides a builder method for a CTS ("clear-to-send") magic bytes property returning the builder for applying multiple build operations.
ClearToSendMagicBytesAccessor.ClearToSendMagicBytesMutator	Provides a mutator for a CTS ("clear-to-send") magic bytes property.
ClearToSendMagicBytesAccessor.ClearToSendMagicBytesProperty	Provides a CTS ("clear-to-send") magic bytes property.
ClearToSendRetryNumberAccessor	Provides an accessor for a CTS ("clear-to-send") retry number.
ClearToSendRetryNumberAccessor.ClearToSendRetryNumberBuilder<B extends ClearToSendRetryNumberAccessor.ClearToSendRetryNumberBuilder<B>>	Provides a builder method for a CTS ("clear-to-send") retry number returning the builder for applying multiple build operations.
ClearToSendRetryNumberAccessor.ClearToSendRetryNumberMutator	Provides a mutator for a CTS ("clear-to-send") retry number.
ClearToSendRetryNumberAccessor.ClearToSendRetryNumberProperty	Provides a CTS ("clear-to-send") retry number.A CTS ( "clear-to-send") retry number is the overall number of retries to use when counting retries.
ClearToSendSegmentPackagerAccessor	Provides an accessor for a SegmentPackager CTS ("clear-to-send") property.
ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B extends ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B>>	Provides a builder method for a SegmentPackager CTS ("clear-to-send") property returning the builder for applying multiple build operations.
ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerMutator	Provides a mutator for a SegmentPackager CTS ("clear-to-send") property.
ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerProperty	Provides a SegmentPackager CTS ("clear-to-send") property.
ClearToSendTimeoutInMsAccessor	Provides an accessor for a CTS ("clear-to-send") timeout in milliseconds property.
ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsBuilder<B extends ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsBuilder<B>>	Provides a builder method for a the CTS ("clear-to-send") timeout property returning the builder for applying multiple build operations.
ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsMutator	Provides a mutator for a CTS ("clear-to-send") timeout in milliseconds property.
ClearToSendTimeoutInMsAccessor.ClearToSendTimeoutInMsProperty	Provides a CTS ("clear-to-send") timeout in milliseconds property.
DecoratorSection<DECORATEE extends Transmission>	The DecoratorSection interface provided means to access a decorated Transmission with the means of a Section.
DecoratorSegment<DECORATEE extends Transmission>	The DecoratorSegment interface provided means to access a decorated Transmission with the means of a Segment.
EndOfStringByteAccessor	Provides an accessor for a end of string byte property.
EndOfStringByteAccessor.EndOfStringByteBuilder<B extends EndOfStringByteAccessor.EndOfStringByteBuilder<B>>	Provides a builder method for a end of string byte property returning the builder for applying multiple build operations.
EndOfStringByteAccessor.EndOfStringByteMutator	Provides a mutator for a end of string byte property.
EndOfStringByteAccessor.EndOfStringByteProperty	Provides a end of string byte property.
EnquiryStandbyTimeInMsAccessor	Provides an accessor for a ENQ ("enquiry") timeout in milliseconds property.
EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsBuilder<B extends EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsBuilder<B>>	Provides a builder method for a the ENQ ("enquiry") timeout property returning the builder for applying multiple build operations.
EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsMutator	Provides a mutator for a ENQ ("enquiry") timeout in milliseconds property.
EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsProperty	Provides a ENQ ("enquiry") timeout in milliseconds property.
ErrorCorrectionTransmission	The ErrorCorrectionTransmission represents the base error correction transmission definition.
InputReturnStreamAccessor	Provides an accessor for an input return stream property.
InputReturnStreamAccessor.InputReturnStreamBuilder<B extends InputReturnStreamAccessor.InputReturnStreamBuilder<?>>	Provides a mutator for an input return stream property.
InputReturnStreamAccessor.InputReturnStreamMutator	Provides a mutator for an input return stream property.
InputReturnStreamAccessor.InputReturnStreamProperty	Provides an input return stream property.
LengthWidthAccessor	Provides an accessor for a length width (in bytes) property.
LengthWidthAccessor.LengthWidthBuilder<B extends LengthWidthAccessor.LengthWidthBuilder<B>>	Provides a builder method for a length width (in bytes) property returning the builder for applying multiple build operations.
LengthWidthAccessor.LengthWidthMutator	Provides a mutator for a length width (in bytes) property.
LengthWidthAccessor.LengthWidthProperty	Provides a length width (in bytes) property.
MagicBytesAccessor	Provides an accessor for a magic byte array property.
MagicBytesAccessor.MagicBytesBuilder<B extends MagicBytesAccessor.MagicBytesBuilder<B>>	Provides a builder method for a magic byte array property returning the builder for applying multiple build operations.
MagicBytesAccessor.MagicBytesMutator	Provides a mutator for a magic byte array property.
MagicBytesAccessor.MagicBytesProperty	Provides a magic byte array property.
MagicBytesLengthAccessor	Provides an accessor for a magic bytes length property.
MagicBytesLengthAccessor.MagicBytesLengthBuilder<B extends MagicBytesLengthAccessor.MagicBytesLengthBuilder<B>>	Provides a builder method for a magic bytes length property returning the builder for applying multiple build operations.
MagicBytesLengthAccessor.MagicBytesLengthMutator	Provides a mutator for a magic bytes length property.
MagicBytesLengthAccessor.MagicBytesLengthProperty	Provides a magic bytes length property.
OutputReturnStreamAccessor	Provides an accessor for an output return stream property.
OutputReturnStreamAccessor.OutputReturnStreamBuilder<B extends OutputReturnStreamAccessor.OutputReturnStreamBuilder<?>>	Provides a mutator for an output return stream property.
OutputReturnStreamAccessor.OutputReturnStreamMutator	Provides a mutator for an output return stream property.
OutputReturnStreamAccessor.OutputReturnStreamProperty	Provides an output return stream property.
PacketLengthWidthAccessor	Provides an accessor for a packet length width (in bytes) property.
PacketLengthWidthAccessor.PacketLengthWidthBuilder<B extends PacketLengthWidthAccessor.PacketLengthWidthBuilder<B>>	Provides a builder method for a packet length width (in bytes) property returning the builder for applying multiple build operations.
PacketLengthWidthAccessor.PacketLengthWidthMutator	Provides a mutator for a packet length width (in bytes) property.
PacketLengthWidthAccessor.PacketLengthWidthProperty	Provides a packet length width (in bytes) property.
PacketMagicBytesAccessor	Provides an accessor for a packet magic bytes property.
PacketMagicBytesAccessor.PacketMagicBytesBuilder<B extends PacketMagicBytesAccessor.PacketMagicBytesBuilder<B>>	Provides a builder method for a packet magic bytes property returning the builder for applying multiple build operations.
PacketMagicBytesAccessor.PacketMagicBytesMutator	Provides a mutator for a packet magic bytes property.
PacketMagicBytesAccessor.PacketMagicBytesProperty	Provides a packet magic bytes property.
PacketSegmentPackagerAccessor	Provides an accessor for a packet SegmentPackager property.
PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<B extends PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<B>>	Provides a builder method for a packet SegmentPackager property returning the builder for applying multiple build operations.
PacketSegmentPackagerAccessor.PacketSegmentPackagerMutator	Provides a mutator for a packet SegmentPackager property.
PacketSegmentPackagerAccessor.PacketSegmentPackagerProperty	Provides a packet SegmentPackager property.
PayloadSection<T>	The PayloadSection interfaces defines a Section with a payload.
PayloadSegment<T>	The PayloadSegment interfaces defines a Segment with a payload.
PayloadTransmission<T>	A PayloadTransmission represents a Transmission carrying a payload (value)
Port<PM extends PortMetrics>	A Port enriches a SerialTransceiver with PortMetrics describing the SerialTransceiver's physical properties.
PortHub<PORT extends Port<PM>,PM extends PortMetrics>	A PortHub implementation is used to retrieve Port instances of a given type (e.g.
PortMetrics	The PortMetrics describe a Port's properties.
PortMetricsAccessor<PM extends PortMetrics>	Provides an accessor for a PortMetrics property.
PortMetricsAccessor.PortMetricsBuilder<PM extends PortMetrics,B extends PortMetricsAccessor.PortMetricsBuilder<PM,B>>	Provides a builder method for a PortMetrics property returning the builder for applying multiple build operations.
PortMetricsAccessor.PortMetricsMutator<PM extends PortMetrics>	Provides a mutator for a PortMetrics property.
PortMetricsAccessor.PortMetricsProperty<PM extends PortMetrics>	Provides a PortMetrics property.
ReadyToReceiveMagicBytesAccessor	Provides an accessor for a RTR ("ready-to-receive") magic bytes property.
ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<B extends ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<B>>	Provides a builder method for a RTR ("ready-to-receive") magic bytes property returning the builder for applying multiple build operations.
ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesMutator	Provides a mutator for a RTR ("ready-to-receive") magic bytes property.
ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesProperty	Provides a RTR ("ready-to-receive") magic bytes property.
ReadyToReceiveRetryNumberAccessor	Provides an accessor for a RTR ("ready-to-receive") retry number.
ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<B extends ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<B>>	Provides a builder method for a RTR ("ready-to-receive") retry number returning the builder for applying multiple build operations.
ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberMutator	Provides a mutator for a RTR ("ready-to-receive") retry number.
ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberProperty	Provides a RTR ("ready-to-receive") retry number.A RTR ( "ready-to-receive") retry number is the overall number of retries to use when counting retries.
ReadyToReceiveSegmentPackagerAccessor	Provides an accessor for a SegmentPackager RTR ("ready-to-receive") property.
ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B extends ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B>>	Provides a builder method for a SegmentPackager RTR ("ready-to-receive") property returning the builder for applying multiple build operations.
ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerMutator	Provides a mutator for a SegmentPackager RTR ("ready-to-receive") property.
ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerProperty	Provides a SegmentPackager RTR ("ready-to-receive") property.
ReadyToReceiveTimeoutInMsAccessor	Provides an accessor for a RTR ("ready-to-receive") timeout in milliseconds property.
ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsBuilder<B extends ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsBuilder<B>>	Provides a builder method for a the RTR ("ready-to-receive") timeout property returning the builder for applying multiple build operations.
ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsMutator	Provides a mutator for a RTR ("ready-to-receive") timeout in milliseconds property.
ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsProperty	Provides a RTR ("ready-to-receive") timeout in milliseconds property.
ReadyToReceiveTransmission	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.
ReadyToSendMagicBytesAccessor	Provides an accessor for a RTS ("ready-to-send") magic bytes property.
ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<B extends ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<B>>	Provides a builder method for a RTS ("ready-to-send") magic bytes property returning the builder for applying multiple build operations.
ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesMutator	Provides a mutator for a RTS ("ready-to-send") magic bytes property.
ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesProperty	Provides a RTS ("ready-to-send") magic bytes property.
ReadyToSendRetryNumberAccessor	Provides an accessor for a RTS ("ready-to-send") retry number.
ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<B extends ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<B>>	Provides a builder method for a RTS ("ready-to-send") retry number returning the builder for applying multiple build operations.
ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberMutator	Provides a mutator for a RTS ("ready-to-send") retry number.
ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberProperty	Provides a RTS ("ready-to-send") retry number.A RTS ( "ready-to-send") retry number is the overall number of retries to use when counting retries.
ReadyToSendSegmentPackagerAccessor	Provides an accessor for a SegmentPackager RTS ("ready-to-send") property.
ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B extends ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B>>	Provides a builder method for a SegmentPackager RTS ("ready-to-send") property returning the builder for applying multiple build operations.
ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerMutator	Provides a mutator for a SegmentPackager RTS ("ready-to-send") property.
ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerProperty	Provides a SegmentPackager RTS ("ready-to-send") property.
ReadyToSendTimeoutInMsAccessor	Provides an accessor for a RTS ("ready-to-send") timeout in milliseconds property.
ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsBuilder<B extends ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsBuilder<B>>	Provides a builder method for a the RTS ("ready-to-send") timeout property returning the builder for applying multiple build operations.
ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsMutator	Provides a mutator for a RTS ("ready-to-send") timeout in milliseconds property.
ReadyToSendTimeoutInMsAccessor.ReadyToSendTimeoutInMsProperty	Provides a RTS ("ready-to-send") timeout in milliseconds property.
ReadyToSendTransmission	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).
Section	The Section interface enables an implementing type to provide a Sequence representation of itself or to transmit its Sequence representation through an OutputStream (with an optional feedback InputStream) as of Transmission.transmitTo(OutputStream, InputStream) and to initialize with a Sequence representation for itself or to receive a Sequence representation for itself through an InputStream (with an optional feedback OutputStream) as of Section.receiveFrom(InputStream, int, OutputStream).
Section.SectionMixin	Default implementation of the Section interface providing an implementation of the Section.SectionMixin.receiveFrom(InputStream, int, OutputStream) method using the Section.fromTransmission(Sequence, int) method or the Section.fromTransmission(Sequence, int, int) method..
Segment	The Segment interface enables an implementing type to provide a Sequence representation of itself or to transmit its Sequence representation through an OutputStream (with an optional feedback InputStream) as of Transmission.transmitTo(OutputStream, InputStream) and to initialize with a Sequence representation for itself or to receive a Sequence representation for itself through an InputStream (with an optional feedback OutputStream) as of Segment.receiveFrom(InputStream, OutputStream).
Segment.SegmentMixin	Default implementation of the Segment interface providing an implementation of the Segment.SegmentMixin.receiveFrom(InputStream, OutputStream) method using the Segment.fromTransmission(Sequence) method or the Segment.fromTransmission(Sequence, int) method.
SegmentConsumer<SEGMENT extends Segment>	A SegmentConsumer consumes a Segment and is used to create lambda expressions used for asynchronous callback.
SegmentDestination	The SegmentDestination is used to receive Segment instances in a unified way.
SegmentPackager	The SegmentPackager interface defines methods to package (wrap) a Segment e.g. with a CrcSegmentDecorator.
SegmentReceiver	The SegmentReceiver is used to receive Segment instances in a unified way.
SegmentSource	The SegmentSource is used to send Segment instances in a unified way.
SegmentTransceiver	Combines the SegmentTransmitter and SegmentReceiver functionality in a single interface to be implemented by a single class so that SegmentTransmitter and SegmentReceiver functionality can be provided by a single instance.
SegmentTransmitter	The SegmentTransmitter is used to transmit Segment instances in a unified way.
Sequence	A Sequence abstracts a byte field providing means to applying complex operations on that byte field.
SequenceAccessor	Provides an accessor for a Sequence property.
SequenceAccessor.SequenceBuilder<B extends SequenceAccessor.SequenceBuilder<B>>	Provides a builder method for a segment property returning the builder for applying multiple build operations.
SequenceAccessor.SequenceMutator	Provides a mutator for a segment property.
SequenceAccessor.SequenceProperty	Provides a segment property.
SequenceConsumer	A SequenceConsumer consumes a Sequence and is used to create lambda expressions used for asynchronous callback.
SequenceNumberAccessor	Provides an accessor for a sequence number property.
SequenceNumberAccessor.SequenceNumberBuilder<B extends SequenceNumberAccessor.SequenceNumberBuilder<B>>	Provides a builder method for a sequence number property returning the builder for applying multiple build operations.
SequenceNumberAccessor.SequenceNumberMutator	Provides a mutator for a sequence number property.
SequenceNumberAccessor.SequenceNumberProperty	Provides a sequence number property.
SequenceNumberConcatenateModeAccessor	Provides an accessor for a ConcatenateMode property.
SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<B extends SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<B>>	Provides a builder method for a sequence number ConcatenateMode property returning the builder for applying multiple build operations.
SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeMutator	Provides a mutator for a sequence number ConcatenateMode property.
SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeProperty	Provides a sequence number ConcatenateMode property.
SequenceNumberInitValueAccessor	Provides an accessor for a sequence number initial value property.
SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<B extends SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<B>>	Provides a builder method for a sequence number initial value property returning the builder for applying multiple build operations.
SequenceNumberInitValueAccessor.SequenceNumberInitValueMutator	Provides a mutator for a sequence number initial value property.
SequenceNumberInitValueAccessor.SequenceNumberInitValueProperty	Provides a sequence number initial value property.
SequenceNumberWidthAccessor	Provides an accessor for a sequence number width (in bytes) property.
SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<B extends SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<B>>	Provides a builder method for a sequence number width (in bytes) property returning the builder for applying multiple build operations.
SequenceNumberWidthAccessor.SequenceNumberWidthMutator	Provides a mutator for a sequence number width (in bytes) property.
SequenceNumberWidthAccessor.SequenceNumberWidthProperty	Provides a sequence number width (in bytes) property.
SerialReceiver	A SerialReceiver is used to read data from a serial port or the like.
SerialTransceiver	A SerialTransceiver combines SerialReceiver and SerialTransmitter functionality.
SerialTransmitter	A SerialTransmitter is used to write data to a serial port or the like.
StopAndWaitPacketStreamTransmission	The StopAndWaitPacketStreamTransmission interface defines the base functionality required by a Transmission instance for providing block stream functionality.
StopAndWaitTransmission	The StopAndWaitTransmission is the most simple implementation of the ARQ (Automatic repeat request) protocol.
Transmission	The Transmission interface enables an implementing type to provide a Sequence representation of itself or to transmit its Sequence representation through an OutputStream (with an optional feedback InputStream) as of Transmission.transmitTo(OutputStream, InputStream).
Transmission.TransmissionMixin	Default implementation of the Transmission interface providing an implementation of the Transmission.TransmissionMixin.transmitTo(OutputStream, InputStream) method using the Transmission.toTransmission() method.
TransmissionAccessor<T extends Transmission>	Provides an accessor for a Transmission property (as of the decorator pattern).
TransmissionAccessor.TransmissionBuilder<T,B extends TransmissionAccessor.TransmissionBuilder<T,B>>	Provides a builder method for a Transmission property returning the builder for applying multiple build operations.
TransmissionAccessor.TransmissionMutator<T extends Transmission>	Provides a mutator for a Transmission property.
TransmissionAccessor.TransmissionProperty<T extends Transmission>	Provides a Transmission property.
TransmissionComposite<CHILD extends Transmission>	A TransmissionComposite is a Transmission with child Transmission elements.
TransmissionMagicBytesAccessor	Provides an accessor for a transmission magic bytes property.
TransmissionMagicBytesAccessor.TransmissionMagicBytesBuilder<B extends TransmissionMagicBytesAccessor.TransmissionMagicBytesBuilder<B>>	Provides a builder method for a transmission magic bytes property returning the builder for applying multiple build operations.
TransmissionMagicBytesAccessor.TransmissionMagicBytesMutator	Provides a mutator for a transmission magic bytes property.
TransmissionMagicBytesAccessor.TransmissionMagicBytesProperty	Provides a transmission magic bytes property.
TransmissionMetrics	The TransmissionMetrics interface represents common parameters required when configuring a transmission.
TransmissionMetricsAccessor	Provides an accessor for a TransmissionMetrics property.
TransmissionMetricsAccessor.TransmissionMetricsBuilder<B extends TransmissionMetricsAccessor.TransmissionMetricsBuilder<B>>	Provides a builder method for a TransmissionMetrics property returning the builder for applying multiple build operations.
TransmissionMetricsAccessor.TransmissionMetricsMutator	Provides a mutator for a TransmissionMetrics property.
TransmissionMetricsAccessor.TransmissionMetricsProperty	Provides a TransmissionMetrics property.
TransmissionRetryNumberAccessor	Provides an accessor for a transmission retry number.
TransmissionRetryNumberAccessor.TransmissionRetryNumberBuilder<B extends TransmissionRetryNumberAccessor.TransmissionRetryNumberBuilder<B>>	Provides a builder method for a transmission retry number returning the builder for applying multiple build operations.
TransmissionRetryNumberAccessor.TransmissionRetryNumberMutator	Provides a mutator for a transmission retry number.
TransmissionRetryNumberAccessor.TransmissionRetryNumberProperty	Provides a transmission retry number.A transmission retry number is the overall number of retries to use when counting retries.
TransmissionTimeoutInMsAccessor	Provides an accessor for a transmission timeout in milliseconds property.
TransmissionTimeoutInMsAccessor.TransmissionTimeoutInMsBuilder<B extends TransmissionTimeoutInMsAccessor.TransmissionTimeoutInMsBuilder<B>>	Provides a builder method for the transmission timeout property returning the builder for applying multiple build operations.
TransmissionTimeoutInMsAccessor.TransmissionTimeoutInMsMutator	Provides a mutator for a transmission timeout in milliseconds property.
TransmissionTimeoutInMsAccessor.TransmissionTimeoutInMsProperty	Provides a transmission timeout in milliseconds property.

Class Summary

Class	Description
AbstractArrayTransmission<ARRAY extends Transmission>	An AbstractArrayTransmission is a Transmission consisting of Transmission elements (an array of elements).
AbstractCipherTransmissionDecorator<DECORATEE extends Transmission>	An abstract implementation of bijective and inverse functions applied to the decoratee's transmitting and receiving methods.
AbstractCrcTransmissionDecorator<DECORATEE extends Transmission>	A AbstractCrcTransmissionDecorator wraps a Transmission instance and enriches the Transmission with a CRC checksum.
AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission>	The AbstractErrorCorrectionTransmissionDecorator class implements a decorator providing base functionality for an error correction Transmission.
AbstractInvertibleTransmissionDecorator<DECORATEE extends Transmission>	An abstract implementation of bijective and inverse functions applied to the decoratee's transmitting and receiving methods.
AbstractLengthDecoratorSegment<DECORATEE extends Transmission>	The AbstractLengthDecoratorSegment decorates a decoratee with a length prefix.
AbstractMagicBytesTransmission	Magic bytes are usually found (somewhere) at the beginning of a file or a stream.
AbstractMagicBytesTransmissionDecorator<DECORATEE extends Transmission>	Magic bytes are usually found (somewhere) at the beginning of a file or a stream.
AbstractMagicBytesTransmissionDispatcher<CHILD extends Transmission>	The AbstractMagicBytesTransmissionDispatcher dispatches a transmission to one of the aggregated Transmission instances depending on the magic number provided by the transmission.
AbstractPayloadSection<T>	An abstract implementation of a Section with payload.
AbstractPayloadSegment<T>	An abstract implementation of a Segment with payload.
AbstractPort<PM extends PortMetrics>	A AbstractPort is a base Port implementation
AbstractPortDecorator<PM extends PortMetrics>	The AbstractPortDecorator decorates a Port for sub-classes to enrich Port functionality.
AbstractReadyToReceiveTransmissionDecorator<DECORATEE extends Transmission>	The AbstractReadyToReceiveTransmissionDecorator class implements a decorator providing ReadyToReceiveTransmission functionality for a Transmission.
AbstractReadyToSendTransmissionDecorator<DECORATEE extends Transmission>	The AbstractReadyToSendTransmissionDecorator class implements a decorator providing ReadyToSendTransmission functionality for a Transmission.
AbstractReferenceeLengthSegment<REFERENCEE extends Transmission>	The AbstractReferenceeLengthSegment represents a allocated length value as of the referenced Transmission element's length.
AbstractSectionDecorator<SECTION extends Section>	Convenience class for easily decorating a Section.
AbstractSegmentDecorator<SEGMENT extends Segment>	Convenience class for easily decorating a Segment.
AbstractStopAndWaitPacketStreamTransmissionDecorator<DECORATEE extends Transmission>	A AbstractStopAndWaitPacketStreamTransmissionDecorator wraps a Transmission instance and enriches the Transmission with packet-stream functionality.
AbstractStopAndWaitTransmissionDecorator<DECORATEE extends Transmission>	The AbstractStopAndWaitTransmissionDecorator class implements a decorator providing StopAndWaitTransmission functionality for a Transmission.
AbstractTransmissionComposite<CHILD extends Transmission>	A AbstractTransmissionComposite is a Transmission consisting of Transmission elements with each element.
AbstractTransmissionDecorator<DECORATEE extends Transmission>	An abstract implementation of a Transmission decorating another Transmission.
AllocSectionDecoratorSegment<DECORATEE extends Section>	An AllocSectionDecoratorSegment enriches an Section with an allocation declaration being prefixed to the enriched Section.
AllocSegmentBody<DECORATEE extends Section>	An AllocSegmentBody provides an Segment with an allocation length.
AllocSegmentHead	An AllocSegmentHead provides the allocation length for a AllocSegmentBody.
AsciizArraySegment	The AsciizArraySegment is an implementation of a Section carrying a String array as payload.
AsciizSegment	The AsciizSegment is an implementation of a Segment carrying an ASCII encoded String as payload, terminated by a 0 ("zero") indicating its end.
AssertMagicBytesSectionDecorator<DECORATEE extends Section>	The AssertMagicBytesSectionDecorator extends the MagicBytesSectionDecorator and enforces the configured magic bytes to match the received magic bytes (as of AssertMagicBytesSectionDecorator.fromTransmission(Sequence, int, int) and AssertMagicBytesSectionDecorator.receiveFrom(java.io.InputStream, int, java.io.OutputStream) or the like).
AssertMagicBytesSegment	The AssertMagicBytesSegment extends the MagicBytesSegment and enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like).
AssertMagicBytesSegmentDecorator<DECORATEE extends Segment>	The AssertMagicBytesSegmentDecorator extends the MagicBytesSegmentDecorator and enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and AssertMagicBytesSegmentDecorator.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like).
BooleanArraySection	The BooleanArraySection is an implementation of a Section carrying a boolean array as payload.
BooleanSegment	The BooleanSegment is an implementation of a Segment carrying in boolean value as value.
BoundedSequenceDecorator	The BoundedSequenceDecorator decorates a Sequence whilst bounding its size to a given maximum size (to be set via BoundedSequenceDecorator.setLength(int)) .
BreakerSectionDecorator<DECORATEE extends Section>	The BreakerSectionDecorator is a DecoratorSection build to test error detection and error correction Transmission implementations such as the CrcSectionDecorator or the StopAndWaitSectionDecorator.
BreakerSegmentDecorator<DECORATEE extends Segment>	The BreakerSegmentDecorator is a DecoratorSegment build to test error detection and error correction Transmission implementations such as the CrcSegmentDecorator or the StopAndWaitSegmentDecorator.
ByteArraySection	The ByteArraySection is an implementation of a Section carrying a byte array as payload.
ByteSegment	The ByteSegment is an implementation of a Segment carrying in byte value as payload.
CharArraySection	The CharArraySection is an implementation of a PayloadSection carrying a char array as payload.
CharSection	The CharSection is an implementation of a Section carrying a char value as payload.
ChunkSequence	A ChunkSequence implements the Sequence interface by using chunks of byte arrays, therewith reducing array copy operations when working with byte fields.
CipherSectionDecorator<DECORATEE extends Section>	A CipherSectionDecorator is a transmission applying an Invertible on outgoing bytes (as of Transmission.transmitTo(java.io.OutputStream) or the like) and the inverse function on any incoming bytes.
CipherSegmentDecorator<DECORATEE extends Segment>	A CipherSegmentDecorator is a transmission applying an Invertible on outgoing bytes (as of Transmission.transmitTo(java.io.OutputStream) or the like) and the inverse function on any incoming bytes.
ComplexTypeSegment<T>	A ComplexTypeSegment takes a POJO (a data structure) and creates from its content a Segment representing the POJO's structure.
CrcSectionDecorator<DECORATEE extends Section>	A CrcSectionDecorator wraps a Section instance and enriches the the Section with a CRC checksum.
CrcSegmentDecorator<DECORATEE extends Segment>	A CrcSegmentDecorator wraps a Segment instance and enriches the Segment with a CRC checksum.
CrcSegmentPackager	A CrcSegmentPackager enriches a Segment with a CRC checksum.
CrossoverLoopbackPort	The CrossoverLoopbackPort is an in-memory implementation of a Port which loops its output directly to the "connected" LoopbackPort counterpart ("other end of the wire").
CrossoverLoopbackPortHub	A CrossoverLoopbackPortHub is an in-memory implementation of a PortHub which's Port instances loop their output directly to the "connected" LoopbackPortHub counterpart Port instances ("other end of the wire").
DoubleArraySection	The DoubleArraySection is an implementation of a Section carrying a double array as payload.
DoubleSegment	The DoubleSegment is an implementation of a Segment carrying in double value as payload.
DynamicTypeSegment	The DynamicTypeSegment represents a Segment which's internal raw data is created from provided types at runtime and which's internal raw data is used to create provided types at runtime.
FileSection	A FileSection represents a File on the file system and can be used to receive or to transmit a File.
FixedLengthSequenceSegment	The FixedLengthSequenceSegment is a Segment representing a Sequence of a fixed length (as of the arguments passed to one of its constructors).
FixedSegmentArraySection<ARRAY extends Segment>	A FixedSegmentArraySection is a Section consisting of Segment elements with each element of the same (uniform) length (in contrast to the SegmentArraySection).
FloatArraySection	The FloatArraySection is an implementation of a Section carrying a float array as payload.
FloatSegment	The FloatSegment is an implementation of a Segment carrying in float value as payload.
FullDuplexPacketPortDecorator<PM extends PortMetrics>	A FullDuplexPacketPortDecorator decorates a Port for its usage in Full-Duplex mode by chunking a transmission of Segment messages (or any transmission finished off by calling AbstractPortDecorator.flush()) into small packets.
FullDuplexPacketPortDecorator.Builder<PM extends PortMetrics>	Builder for building a FullDuplexPacketPortDecorator instance.
FullDuplexTxPortDecorator<PM extends PortMetrics>	A FullDuplexTxPortDecorator decorates a Port for its usage in Full-Duplex mode regarding the transmission of Segment messages (or any transmission finished off by calling AbstractPortDecorator.flush()).
FullDuplexTxPortDecorator.Builder<PM extends PortMetrics>	Builder for building a FullDuplexTxPortDecorator instance.
IntArraySection	The IntArraySection is an implementation of a Section carrying an integer array as payload.
IntSegment	The IntSegment is an implementation of a Segment carrying in integer value as payload.
InvertibleSectionDecorator<DECORATEE extends Section>	A InvertibleSectionDecorator is a transmission applying an Invertible on outgoing bytes (as of Transmission.transmitTo(java.io.OutputStream) or the like) and the inverse function on any incoming bytes.
InvertibleSegmentDecorator<DECORATEE extends Segment>	A InvertibleSegmentDecorator is a transmission applying an Invertible on outgoing bytes (as of Transmission.transmitTo(java.io.OutputStream) or the like) and the inverse function on any incoming bytes.
LengthDecoratorSegment<REFERENCEE extends Transmission>	An LengthDecoratorSegment enriches a Segment with an allocation declaration computed from the referenced Transmission.
LengthSegmentDecoratorSegment<DECORATEE extends Segment>	An LengthSegmentDecoratorSegment enriches a Segment with an allocation declaration being prefixed to the enriched Segment.
LongArraySection	The LongArraySection is an implementation of a Section carrying a long array as payload.
LongSegment	The LongSegment is an implementation of a Segment carrying in long value as payload.
LoopbackPort	The LoopbackPort is an in-memory implementation of a Port which loops its output directly back to its input.
LoopbackPortHub	The LoopbackPortHub is a plain implementation of a PortHub serving an infinite number of LoopbackPort instances: When calling LoopbackPortHub.toPort(String) and the such port is unknown, then it is created (and from then on known).
MagicBytesSectionDecorator<DECORATEE extends Section>	Magic bytes are usually found (somewhere) at the beginning of a file or a stream.
MagicBytesSectionDispatcher	THe MagicBytesSectionDispatcher dispatches a transmission to one of the aggregated Section instances depending on the magic number provided by the transmission.
MagicBytesSegment	Magic bytes are usually found (somewhere) at the beginning of a file or a stream.
MagicBytesSegmentDecorator<DECORATEE extends Segment>	Magic bytes are usually found (somewhere) at the beginning of a file or a stream.
MagicBytesSegmentDispatcher	THe MagicBytesSegmentDispatcher dispatches a transmission to one of the aggregated Segment instances depending on the magic number provided by the transmission.
NumberSegment	The NumberSegment is an implementation of a Segment carrying in long an integer value with a configurable width (in bytes) as payload.
PacketInputStream	The PacketInputStream wraps an InputStream and chunks any data to be written into packets with a sequence number and a block of data.
PacketInputStream.Builder	Builder to build PacketInputStream instances.
PacketOutputStream	The PacketOutputStream wraps an OutputStream and chunks any data to be written into packets with a sequence number, a block of data and a CRC checksum.
PacketOutputStream.Builder	Builder to build StopAndWaitPacketInputStream instances.
PropertiesSection	The PropertiesSection is an implementation of a Section carrying a String as payload.
ReadyToReceiveSectionDecorator<DECORATEE extends Section>	The ReadyToReceiveSectionDecorator class implements a decorator providing ReadyToReceiveTransmission functionality for a Segment.
ReadyToReceiveSectionDecorator.Builder<DECORATEE extends Section>	Builder to build ReadyToReceiveSectionDecorator.
ReadyToReceiveSegmentDecorator<DECORATEE extends Segment>	The ReadyToReceiveSegmentDecorator class implements a decorator providing ReadyToReceiveTransmission functionality for a Segment.
ReadyToReceiveSegmentDecorator.Builder<DECORATEE extends Segment>	Builder to build ReadyToReceiveSegmentDecorator.
ReadyToSendSectionDecorator<DECORATEE extends Section>	The ReadyToSendSectionDecorator class implements a decorator providing ReadyToSendTransmission functionality for a Segment.
ReadyToSendSectionDecorator.Builder<DECORATEE extends Section>	Builder to build ReadyToSendSectionDecorator.
ReadyToSendSegmentDecorator<DECORATEE extends Segment>	The ReadyToSendSegmentDecorator class implements a decorator providing ReadyToSendTransmission functionality for a Segment.
ReadyToSendSegmentDecorator.Builder<DECORATEE extends Segment>	Builder to build ReadyToSendSegmentDecorator.
Schema	The purpose of a Schema is automatically generate documentation of serial data.
SectionComposite<ALLOC extends AllocSectionDecoratorSegment<CHILD>,CHILD extends Section>	A SectionComposite is a Section consisting of Section elements of a variable length each: Each Section element in the composite need not be of the same size.
SegmentArraySection<ARRAY extends Segment>	A SegmentArraySection is a Segment consisting of Segment elements with each element of presumably different lengths ( in contrast to the FixedSegmentArraySection).
SegmentComposite<CHILD extends Segment>	The SegmentComposite is a Segment composed of multiple child Segment elements.
SegmentConsumer.ReceiveSegmentConsumerDaemon<SEGMENT extends Segment>	A daemon handling SegmentReceiver.onReceiveSegment(Segment, SegmentConsumer) asynchronous calls.
SegmentConsumer.TransmitSegmentConsumerDaemon<SEGMENT extends Segment>	A daemon handling SegmentTransmitter.doTransmitSegment(Segment, SegmentConsumer) asynchronous calls.
SegmentPackager.DummySegmentPackager	Dummy implementation of a SegmentPackager just passing through provided Segment instances.
SegmentResult<SEGMENT extends Segment>	A SegmentResult instance is issued by the SerialReceiver to receive a Transmission's data asynchronously.
SequenceInputStream	The SequenceInputStream constructs an InputStream from a Sequence.
SequenceNumberSegment	Convenience class for the NumberSegment using TransmissionMetrics sequence number related properties to configure the SequenceNumberSegment (being an accordingly configured NumberSegment).
SequenceOutputStream	The SequenceOutputStream constructs an OutputStream from a SerialTransmitter.
SequenceSection	The SequenceSection is a Section representing a Sequence.
SerialSugar	Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the construction of various serial types such as Segment or Section type instances (and the like).
ShortArraySection	The ShortArraySection is an implementation of a Section carrying a short array as payload.
ShortSegment	The ShortSegment is an implementation of a Segment carrying in short value as payload.
StopAndWaitPacketInputStream	The StopAndWaitPacketInputStream wraps an OutputStream and chunks any data to be written into packets with a sequence number and a block of data.
StopAndWaitPacketInputStream.Builder	Builder to build StopAndWaitPacketInputStream instances.
StopAndWaitPacketOutputStream	The StopAndWaitPacketOutputStream wraps an OutputStream and chunks any data to be written into packets with a sequence number, a block of data and a CRC checksum.
StopAndWaitPacketOutputStream.Builder	Builder to build StopAndWaitPacketInputStream instances.
StopAndWaitPacketStreamSectionDecorator<DECORATEE extends Section>	A StopAndWaitPacketStreamSectionDecorator chunks any outgoing stream (OutputStream) into blocks of definite length and reassembles any incoming streams (InputStream) from blocks of definite size into a contiguous stream.
StopAndWaitPacketStreamSectionDecorator.Builder<DECORATEE extends Section>	Builder to build StopAndWaitSegmentDecorator.
StopAndWaitPacketStreamSegmentDecorator<DECORATEE extends Segment>	A StopAndWaitPacketStreamSegmentDecorator chunks any outgoing stream (OutputStream) into blocks of definite length and reassembles any incoming streams (InputStream) from blocks of definite size into a contiguous stream.
StopAndWaitPacketStreamSegmentDecorator.Builder<DECORATEE extends Segment>	Builder to build StopAndWaitSegmentDecorator.
StopAndWaitSectionDecorator<DECORATEE extends Section>	The StopAndWaitSectionDecorator class implements a decorator providing StopAndWaitTransmission functionality for a Section.
StopAndWaitSectionDecorator.Builder<DECORATEE extends Section>	Builder to build StopAndWaitSegmentDecorator.
StopAndWaitSegmentDecorator<DECORATEE extends Segment>	The StopAndWaitSegmentDecorator class implements a decorator providing StopAndWaitTransmission functionality for a Segment.
StopAndWaitSegmentDecorator.Builder<DECORATEE extends Segment>	Builder to build StopAndWaitSegmentDecorator.
StringArraySection	The StringArraySection is an implementation of a Section carrying a String array as payload.
StringSection	The StringSection is an implementation of a Section carrying a String as payload.
StringSegment	The StringSegment is an implementation of a Section carrying a String as payload.
StringSegment.Builder	Builder to build StringSegment.
TransmissionMetricsBuilder	The TransmissionMetricsBuilder class implements the TransmissionMetrics and enriches it with builder functionality as of the builder pattern.
TtyPort	A Port is a Port implementation
TtyPortHub	The TtyPortHub implements the PortHub for TTY-/COM-Port hardware.
TtyPortMetrics	The TtyPortMetrics describe a COM or TTY serial Port on your computer.
TtyPortMetricsBuilder	The TtyPortMetricsBuilder enriches the TtyPortMetrics with builder functionality.

Enum Summary

Enum	Description
BaudRate	Defines some commonly used bits/second rates (BPS !
FlowControlType	Defines the type of flow control.
Handshake	The Handshake as of "https://en.wikipedia.org/wiki/Serial_port#Flow_control"
Parity	The Parity as of "https://en.wikipedia.org/wiki/Serial_port#Parity"
StopBits	Defines the number of valid TTY stop bits.

Exception Summary

Exception	Description
BadCrcChecksumException	Thrown in case a transmission's CRC checksum did not match the according calculated CRC checksum.
BadCrcChecksumSequenceException	Thrown in case a Sequence CRC checksum did not match the according calculated CRC checksum.
BadMagicBytesException	A BadMagicBytesException denotes bad (unexpected) magic bytes encountered while processing a transmission.
BadMagicBytesSequenceException	A BadMagicBytesSequenceException denotes bad (unexpected) magic bytes encountered while processing a transmission Sequence.
FlowControlException	Thrown in case a flow control failed.
FlowControlRetryException	Thrown in case a flow control failed due t a timeout.
FlowControlTimeoutException	Thrown in case a flow control failed due t a timeout.
NoSuchPortExcpetion	Thrown in case there is no such port found.
SerialException	Base exception for this package.
SerialRuntimeException	Base runtime exception for this package.
TransmissionException	Thrown in case a given transmission cannot be processed.
TransmissionSequenceException	Thrown in case a given Sequence cannot be processed.