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 aSegmentPackager
ACK property.AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<B extends AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<B>> Provides a builder method for aSegmentPackager
ACK property returning the builder for applying multiple build operations.AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerMutator Provides a mutator for aSegmentPackager
ACK property.AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerProperty Provides aSegmentPackager
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> ArraySegment<SEGMENT extends Segment> ArrayTransmission<ARRAY extends Transmission> 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 aSegmentPackager
CTS ("clear-to-send") property.ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B extends ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B>> Provides a builder method for aSegmentPackager
CTS ("clear-to-send") property returning the builder for applying multiple build operations.ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerMutator Provides a mutator for aSegmentPackager
CTS ("clear-to-send") property.ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerProperty Provides aSegmentPackager
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> TheDecoratorSection
interface provided means to access a decoratedTransmission
with the means of aSection
.DecoratorSegment<DECORATEE extends Transmission> TheDecoratorSegment
interface provided means to access a decoratedTransmission
with the means of aSegment
.DynamicTypeTransmission heDynamicTypeTransmission
represents aTransmission
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.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 TheErrorCorrectionTransmission
represents the base error correction transmission definition.HandshakeMagicBytesAccessor Provides an accessor for a handshake magic bytes property.HandshakeMagicBytesAccessor.HandshakeMagicBytesBuilder<B extends HandshakeMagicBytesAccessor.HandshakeMagicBytesBuilder<B>> Provides a builder method for a handshake magic bytes property returning the builder for applying multiple build operations.HandshakeMagicBytesAccessor.HandshakeMagicBytesMutator Provides a mutator for a handshake magic bytes property.HandshakeMagicBytesAccessor.HandshakeMagicBytesProperty Provides a handshake magic bytes property.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 packetSegmentPackager
property.PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<B extends PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<B>> Provides a builder method for a packetSegmentPackager
property returning the builder for applying multiple build operations.PacketSegmentPackagerAccessor.PacketSegmentPackagerMutator Provides a mutator for a packetSegmentPackager
property.PacketSegmentPackagerAccessor.PacketSegmentPackagerProperty Provides a packetSegmentPackager
property.PayloadSection<T> ThePayloadSection
interfaces defines aSection
with a payload.PayloadSegment<T> ThePayloadSegment
interfaces defines aSegment
with a payload.PayloadTransmission<T> APayloadTransmission
represents aTransmission
carrying a payload (value)Port<PM extends PortMetrics> APort
enriches aSerialTransceiver
withPortMetrics
describing theSerialTransceiver
's physical properties.PortHub<PORT extends Port<PM>,PM extends PortMetrics> PortMetrics ThePortMetrics
describe aPort
's properties.PortMetricsAccessor<PM extends PortMetrics> Provides an accessor for aPortMetrics
property.PortMetricsAccessor.PortMetricsBuilder<PM extends PortMetrics,B extends PortMetricsAccessor.PortMetricsBuilder<PM,B>> Provides a builder method for aPortMetrics
property returning the builder for applying multiple build operations.PortMetricsAccessor.PortMetricsMutator<PM extends PortMetrics> Provides a mutator for aPortMetrics
property.PortMetricsAccessor.PortMetricsProperty<PM extends PortMetrics> Provides aPortMetrics
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 aSegmentPackager
RTR ("ready-to-receive") property.ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B extends ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B>> Provides a builder method for aSegmentPackager
RTR ("ready-to-receive") property returning the builder for applying multiple build operations.ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerMutator Provides a mutator for aSegmentPackager
RTR ("ready-to-receive") property.ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerProperty Provides aSegmentPackager
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 TheReadyToReceiveTransmission
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 aSegmentPackager
RTS ("ready-to-send") property.ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B extends ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B>> Provides a builder method for aSegmentPackager
RTS ("ready-to-send") property returning the builder for applying multiple build operations.ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerMutator Provides a mutator for aSegmentPackager
RTS ("ready-to-send") property.ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerProperty Provides aSegmentPackager
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 TheReadyToSendTransmission
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 TheSection
interface enables an implementing type to provide aSequence
representation of itself or to transmit itsSequence
representation through anOutputStream
(with an optional feedbackInputStream
) as ofTransmission.transmitTo(OutputStream, InputStream)
and to initialize with aSequence
representation for itself or to receive aSequence
representation for itself through anInputStream
(with an optional feedbackOutputStream
) as ofSection.receiveFrom(InputStream, int, OutputStream)
.Section.SectionMixin Default implementation of theSection
interface providing an implementation of theSection.SectionMixin.receiveFrom(InputStream, int, OutputStream)
method using theSection.fromTransmission(Sequence, int)
method or theSection.fromTransmission(Sequence, int, int)
method..Segment TheSegment
interface enables an implementing type to provide aSequence
representation of itself or to transmit itsSequence
representation through anOutputStream
(with an optional feedbackInputStream
) as ofTransmission.transmitTo(OutputStream, InputStream)
and to initialize with aSequence
representation for itself or to receive aSequence
representation for itself through anInputStream
(with an optional feedbackOutputStream
) as ofSegment.receiveFrom(InputStream, OutputStream)
.Segment.SegmentMixin Default implementation of theSegment
interface providing an implementation of theSegment.SegmentMixin.receiveFrom(InputStream, OutputStream)
method using theSegment.fromTransmission(Sequence)
method or theSegment.fromTransmission(Sequence, int)
method.SegmentConsumer<SEGMENT extends Segment> ASegmentConsumer
consumes aSegment
and is used to create lambda expressions used for asynchronous callback.SegmentDestination TheSegmentDestination
is used to receiveSegment
instances in a unified way.SegmentPackager TheSegmentPackager
interface defines methods to package (wrap) aSegment
e.g. with aCrcSegmentDecorator
.SegmentReceiver TheSegmentReceiver
is used to receiveSegment
instances in a unified way.SegmentSource TheSegmentSource
is used to sendSegment
instances in a unified way.SegmentTransceiver Combines theSegmentTransmitter
andSegmentReceiver
functionality in a single interface to be implemented by a single class so thatSegmentTransmitter
andSegmentReceiver
functionality can be provided by a single instance.SegmentTransmitter TheSegmentTransmitter
is used to transmitSegment
instances in a unified way.Sequence ASequence
abstracts a byte field providing means to applying complex operations on that byte field.SequenceAccessor Provides an accessor for aSequence
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 ASequenceConsumer
consumes aSequence
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 aConcatenateMode
property.SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<B extends SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<B>> Provides a builder method for a sequence numberConcatenateMode
property returning the builder for applying multiple build operations.SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeMutator Provides a mutator for a sequence numberConcatenateMode
property.SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeProperty Provides a sequence numberConcatenateMode
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 ASerialReceiver
is used to read data from a serial port or the like.SerialTransceiver SerialTransmitter ASerialTransmitter
is used to write data to a serial port or the like.StopAndWaitPacketStreamTransmission TheStopAndWaitPacketStreamTransmission
interface defines the base functionality required by aTransmission
instance for providing block stream functionality.StopAndWaitTransmission TheStopAndWaitTransmission
is the most simple implementation of the ARQ (Automatic repeat request) protocol.Transmission TheTransmission
interface enables an implementing type to provide aSequence
representation of itself or to transmit itsSequence
representation through anOutputStream
(with an optional feedbackInputStream
) as ofTransmission.transmitTo(OutputStream, InputStream)
.Transmission.TransmissionMixin Default implementation of theTransmission
interface providing an implementation of theTransmission.TransmissionMixin.transmitTo(OutputStream, InputStream)
method using theTransmission.toSequence()
method.TransmissionAccessor<T extends Transmission> Provides an accessor for aTransmission
property (as of the decorator pattern).TransmissionAccessor.TransmissionBuilder<T,B extends TransmissionAccessor.TransmissionBuilder<T,B>> Provides a builder method for aTransmission
property returning the builder for applying multiple build operations.TransmissionAccessor.TransmissionMutator<T extends Transmission> Provides a mutator for aTransmission
property.TransmissionAccessor.TransmissionProperty<T extends Transmission> Provides aTransmission
property.TransmissionComposite<CHILD extends Transmission> TransmissionMetrics TheTransmissionMetrics
interface represents common parameters required when configuring a transmission.TransmissionMetricsAccessor Provides an accessor for aTransmissionMetrics
property.TransmissionMetricsAccessor.TransmissionMetricsBuilder<B extends TransmissionMetricsAccessor.TransmissionMetricsBuilder<B>> Provides a builder method for aTransmissionMetrics
property returning the builder for applying multiple build operations.TransmissionMetricsAccessor.TransmissionMetricsMutator Provides a mutator for aTransmissionMetrics
property.TransmissionMetricsAccessor.TransmissionMetricsProperty Provides aTransmissionMetrics
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> AnAbstractArrayTransmission
is aTransmission
consisting ofTransmission
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> AAbstractCrcTransmissionDecorator
wraps aTransmission
instance and enriches theTransmission
with a CRC checksum.AbstractErrorCorrectionTransmissionDecorator<DECORATEE extends Transmission> TheAbstractErrorCorrectionTransmissionDecorator
class implements a decorator providing base functionality for an error correctionTransmission
.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> TheAbstractLengthDecoratorSegment
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.AbstractMagicBytesTransmissionMultiplexer<CHILD extends Transmission> TheAbstractMagicBytesTransmissionMultiplexer
dispatches a transmission to one of the aggregatedTransmission
instances depending on the magic number provided by the transmission.AbstractPayloadSection<T> An abstract implementation of aSection
with payload.AbstractPayloadSegment<T> An abstract implementation of aSegment
with payload.AbstractPort<PM extends PortMetrics> AAbstractPort
is a basePort
implementationAbstractPortDecorator<PM extends PortMetrics> AbstractReadyToReceiveTransmissionDecorator<DECORATEE extends Transmission> TheAbstractReadyToReceiveTransmissionDecorator
class implements a decorator providingReadyToReceiveTransmission
functionality for aTransmission
.AbstractReadyToSendTransmissionDecorator<DECORATEE extends Transmission> TheAbstractReadyToSendTransmissionDecorator
class implements a decorator providingReadyToSendTransmission
functionality for aTransmission
.AbstractReferenceeLengthSegment<REFERENCEE extends Transmission> TheAbstractReferenceeLengthSegment
represents a allocated length value as of the referencedTransmission
element's length.AbstractSectionDecorator<SECTION extends Section> Convenience class for easily decorating aSection
.AbstractSegmentDecorator<SEGMENT extends Segment> Convenience class for easily decorating aSegment
.AbstractStopAndWaitPacketStreamTransmissionDecorator<DECORATEE extends Transmission> AAbstractStopAndWaitPacketStreamTransmissionDecorator
wraps aTransmission
instance and enriches theTransmission
with packet-stream functionality.AbstractStopAndWaitTransmissionDecorator<DECORATEE extends Transmission> TheAbstractStopAndWaitTransmissionDecorator
class implements a decorator providingStopAndWaitTransmission
functionality for aTransmission
.AbstractTransmissionComposite<CHILD extends Transmission> AAbstractTransmissionComposite
is aTransmission
consisting ofTransmission
elements with each element.AbstractTransmissionDecorator<DECORATEE extends Transmission> An abstract implementation of aTransmission
decorating anotherTransmission
.AllocSectionDecoratorSegment<DECORATEE extends Section> AnAllocSectionDecoratorSegment
enriches anSection
with an allocation declaration being prefixed to the enrichedSection
.AllocSegmentBody<DECORATEE extends Section> AnAllocSegmentBody
provides anSegment
with an allocation length.AllocSegmentHead AnAllocSegmentHead
provides the allocation length for aAllocSegmentBody
.AsciizArraySegment AsciizSegment TheAsciizSegment
is an implementation of aSegment
carrying an ASCII encodedString
as payload, terminated by a 0 ("zero") indicating its end.AssertMagicBytesSectionDecorator<DECORATEE extends Section> TheAssertMagicBytesSectionDecorator
extends theMagicBytesSectionDecorator
and enforces the configured magic bytes to match the received magic bytes (as ofAssertMagicBytesSectionDecorator.fromTransmission(Sequence, int, int)
andAssertMagicBytesSectionDecorator.receiveFrom(java.io.InputStream, int, java.io.OutputStream)
or the like).AssertMagicBytesSegment TheAssertMagicBytesSegment
extends theMagicBytesSegment
and enforces the configured magic bytes to match the received magic bytes (as ofSegment.fromTransmission(Sequence)
andSegment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream)
or the like).AssertMagicBytesSegmentDecorator<DECORATEE extends Segment> TheAssertMagicBytesSegmentDecorator
extends theMagicBytesSegmentDecorator
and enforces the configured magic bytes to match the received magic bytes (as ofSegment.fromTransmission(Sequence)
andAssertMagicBytesSegmentDecorator.receiveFrom(java.io.InputStream, java.io.OutputStream)
or the like).BooleanArraySection TheBooleanArraySection
is an implementation of aSection
carrying a boolean array as payload.BooleanSegment TheBooleanSegment
is an implementation of aSegment
carrying in boolean value as value.BoundedSequenceDecorator TheBoundedSequenceDecorator
decorates aSequence
whilst bounding its size to a given maximum size (to be set viaBoundedSequenceDecorator.setLength(int)
) .BreakerSectionDecorator<DECORATEE extends Section> TheBreakerSectionDecorator
is aDecoratorSection
build to test error detection and error correctionTransmission
implementations such as theCrcSectionDecorator
or theStopAndWaitSectionDecorator
.BreakerSegmentDecorator<DECORATEE extends Segment> TheBreakerSegmentDecorator
is aDecoratorSegment
build to test error detection and error correctionTransmission
implementations such as theCrcSegmentDecorator
or theStopAndWaitSegmentDecorator
.ByteArraySection TheByteArraySection
is an implementation of aSection
carrying a byte array as payload.ByteArraySequence AByteArraySequence
implements theSequence
interface by using chunks of byte arrays, therewith reducing array copy operations when working with byte fields.ByteSegment TheByteSegment
is an implementation of aSegment
carrying in byte value as payload.CharArraySection TheCharArraySection
is an implementation of aPayloadSection
carrying a char array as payload.CharSection TheCharSection
is an implementation of aSection
carrying a char value as payload.CipherSectionDecorator<DECORATEE extends Section> ACipherSectionDecorator
is a transmission applying anInvertible
on outgoing bytes (as ofTransmission.transmitTo(java.io.OutputStream)
or the like) and the inverse function on any incoming bytes.CipherSegmentDecorator<DECORATEE extends Segment> ACipherSegmentDecorator
is a transmission applying anInvertible
on outgoing bytes (as ofTransmission.transmitTo(java.io.OutputStream)
or the like) and the inverse function on any incoming bytes.ComplexTypeSegment<T> AComplexTypeSegment
takes a POJO (a data structure) and creates from its content aSegment
representing the POJO's structure.CrcSectionDecorator<DECORATEE extends Section> CrcSegmentDecorator<DECORATEE extends Segment> CrcSegmentPackager ACrcSegmentPackager
enriches aSegment
with a CRC checksum.CrossoverLoopbackPort TheCrossoverLoopbackPort
is an in-memory implementation of aPort
which loops its output directly to the "connected"LoopbackPort
counterpart ("other end of the wire").CrossoverLoopbackPortHub ACrossoverLoopbackPortHub
is an in-memory implementation of aPortHub
which'sPort
instances loop their output directly to the "connected"LoopbackPortHub
counterpartPort
instances ("other end of the wire").DoubleArraySection TheDoubleArraySection
is an implementation of aSection
carrying a double array as payload.DoubleSegment TheDoubleSegment
is an implementation of aSegment
carrying in double value as payload.DynamicTypeSection TheDynamicTypeSection
represents aSection
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.DynamicTypeSegment TheDynamicTypeSegment
represents aSegment
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 AFileSection
represents aFile
on the file system and can be used to receive or to transmit aFile
.FixedLengthSequenceSegment TheFixedLengthSequenceSegment
is aSegment
representing aSequence
of a fixed length (as of the arguments passed to one of its constructors).FixedSegmentArraySection<ARRAY extends Segment> AFixedSegmentArraySection
is aSection
consisting ofSegment
elements with each element of the same (uniform) length (in contrast to theSegmentArraySection
).FloatArraySection TheFloatArraySection
is an implementation of aSection
carrying a float array as payload.FloatSegment TheFloatSegment
is an implementation of aSegment
carrying in float value as payload.IntArraySection TheIntArraySection
is an implementation of aSection
carrying an integer array as payload.IntSegment TheIntSegment
is an implementation of aSegment
carrying in integer value as payload.InvertibleSectionDecorator<DECORATEE extends Section> AInvertibleSectionDecorator
is a transmission applying anInvertible
on outgoing bytes (as ofTransmission.transmitTo(java.io.OutputStream)
or the like) and the inverse function on any incoming bytes.InvertibleSegmentDecorator<DECORATEE extends Segment> AInvertibleSegmentDecorator
is a transmission applying anInvertible
on outgoing bytes (as ofTransmission.transmitTo(java.io.OutputStream)
or the like) and the inverse function on any incoming bytes.LengthSegment<REFERENCEE extends Transmission> AnLengthSegment
enriches aSegment
with an allocation declaration computed from the referencedTransmission
.LengthSegmentDecoratorSegment<DECORATEE extends Segment> AnLengthSegmentDecoratorSegment
enriches aSegment
with an allocation declaration being prefixed to the enrichedSegment
.LongArraySection TheLongArraySection
is an implementation of aSection
carrying a long array as payload.LongSegment TheLongSegment
is an implementation of aSegment
carrying in long value as payload.LoopbackPort TheLoopbackPort
is an in-memory implementation of aPort
which loops its output directly back to its input.LoopbackPortHub TheLoopbackPortHub
is a plain implementation of aPortHub
serving an infinite number ofLoopbackPort
instances: When callingLoopbackPortHub.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.MagicBytesSectionMultiplexer THeMagicBytesSectionMultiplexer
dispatches a transmission to one of the aggregatedSection
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.MagicBytesSegmentMultiplexer THeMagicBytesSegmentMultiplexer
dispatches a transmission to one of the aggregatedSegment
instances depending on the magic number provided by the transmission.NullSegment NumberSegment TheNumberSegment
is an implementation of aSegment
carrying in long an integer value with a configurable width (in bytes) as payload.PacketInputStream ThePacketInputStream
wraps anInputStream
and chunks any data to be written into packets with a sequence number and a block of data.PacketInputStream.Builder Builder to buildPacketInputStream
instances.PacketOutputStream ThePacketOutputStream
wraps anOutputStream
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 buildStopAndWaitPacketInputStream
instances.PropertiesSection ReadyToReceiveSectionDecorator<DECORATEE extends Section> TheReadyToReceiveSectionDecorator
class implements a decorator providingReadyToReceiveTransmission
functionality for aSegment
.ReadyToReceiveSectionDecorator.Builder<DECORATEE extends Section> Builder to buildReadyToReceiveSectionDecorator
.ReadyToReceiveSegmentDecorator<DECORATEE extends Segment> TheReadyToReceiveSegmentDecorator
class implements a decorator providingReadyToReceiveTransmission
functionality for aSegment
.ReadyToReceiveSegmentDecorator.Builder<DECORATEE extends Segment> Builder to buildReadyToReceiveSegmentDecorator
.ReadyToSendSectionDecorator<DECORATEE extends Section> TheReadyToSendSectionDecorator
class implements a decorator providingReadyToSendTransmission
functionality for aSegment
.ReadyToSendSectionDecorator.Builder<DECORATEE extends Section> Builder to buildReadyToSendSectionDecorator
.ReadyToSendSegmentDecorator<DECORATEE extends Segment> TheReadyToSendSegmentDecorator
class implements a decorator providingReadyToSendTransmission
functionality for aSegment
.ReadyToSendSegmentDecorator.Builder<DECORATEE extends Segment> Builder to buildReadyToSendSegmentDecorator
.ReceiveSegmentConsumerDaemon<SEGMENT extends Segment> A daemon handlingSegmentReceiver.onReceiveSegment(Segment, SegmentConsumer)
asynchronous calls.ReceiveSegmentResultDaemon<SEGMENT extends Segment> A daemon handlingSegmentReceiver.onReceiveSegment(Segment)
asynchronous calls.Schema The purpose of aSchema
is automatically generate documentation of serial data.SectionComposite<ALLOC extends AllocSectionDecoratorSegment<CHILD>,CHILD extends Section> ASectionComposite
is aSection
consisting ofSection
elements of a variable length each: EachSection
element in the composite need not be of the same size.SegmentArraySection<ARRAY extends Segment> ASegmentArraySection
is aSegment
consisting ofSegment
elements with each element of presumably different lengths ( in contrast to theFixedSegmentArraySection
).SegmentComposite<CHILD extends Segment> SegmentPackager.DummySegmentPackager Dummy implementation of aSegmentPackager
just passing through providedSegment
instances.SegmentResult<SEGMENT extends Segment> ASegmentResult
instance is issued by theSerialReceiver
to receive aTransmission
's data asynchronously.SequenceInputStream SequenceNumberSegment Convenience class for theNumberSegment
usingTransmissionMetrics
sequence number related properties to configure theSequenceNumberSegment
(being an accordingly configuredNumberSegment
).SequenceOutputStream SequenceSection SerialSugar ShortArraySection TheShortArraySection
is an implementation of aSection
carrying a short array as payload.ShortSegment TheShortSegment
is an implementation of aSegment
carrying in short value as payload.StopAndWaitPacketInputStream TheStopAndWaitPacketInputStream
wraps anInputStream
and chunks any data to be written into packets with a sequence number and a block of data.StopAndWaitPacketInputStream.Builder Builder to buildStopAndWaitPacketInputStream
instances.StopAndWaitPacketOutputStream TheStopAndWaitPacketOutputStream
wraps anOutputStream
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 buildStopAndWaitPacketInputStream
instances.StopAndWaitPacketStreamSectionDecorator<DECORATEE extends Section> AStopAndWaitPacketStreamSectionDecorator
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 buildStopAndWaitSegmentDecorator
.StopAndWaitPacketStreamSegmentDecorator<DECORATEE extends Segment> AStopAndWaitPacketStreamSegmentDecorator
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 buildStopAndWaitSegmentDecorator
.StopAndWaitSectionDecorator<DECORATEE extends Section> TheStopAndWaitSectionDecorator
class implements a decorator providingStopAndWaitTransmission
functionality for aSection
.StopAndWaitSectionDecorator.Builder<DECORATEE extends Section> Builder to buildStopAndWaitSegmentDecorator
.StopAndWaitSegmentDecorator<DECORATEE extends Segment> TheStopAndWaitSegmentDecorator
class implements a decorator providingStopAndWaitTransmission
functionality for aSegment
.StopAndWaitSegmentDecorator.Builder<DECORATEE extends Segment> Builder to buildStopAndWaitSegmentDecorator
.StringArraySection StringSection StringSegment StringSegment.Builder Builder to buildStringSegment
.TransmissionMetricsBuilder TheTransmissionMetricsBuilder
class implements theTransmissionMetrics
and enriches it with builder functionality as of the builder pattern.TransmissionMetricsImpl TheTransmissionMetricsImpl
class implements theTransmissionMetrics
and enriches it with builder functionality as of the builder pattern.TransmissionMetricsImpl.Builder Builder to buildTransmissionMetricsImpl
.TransmitSegmentConsumerDaemon<SEGMENT extends Segment> A daemon handlingSegmentTransmitter.doTransmitSegment(Segment, SegmentConsumer)
asynchronous calls.TransmitSegmentResultDaemon<SEGMENT extends Segment> A daemon handlingSegmentTransmitter.doTransmitSegment(Segment)
asynchronous calls. -
Enum Summary Enum Description FlowControlType Defines the type of flow control.HandshakeProtocol Enumeration with the various protocol settings when receiving a transmission.MagicBytes TheMagicBytes
enumeration provides various predefined magic bytes for common use cases. -
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 aSequence
CRC checksum did not match the according calculated CRC checksum.BadMagicBytesException ABadMagicBytesException
denotes bad (unexpected) magic bytes encountered while processing a transmission.BadMagicBytesSequenceException ABadMagicBytesSequenceException
denotes bad (unexpected) magic bytes encountered while processing a transmissionSequence
.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 givenTransmission
cannot be processed.TransmissionSequenceException Thrown in case a givenSequence
cannot be processed.