Uses of Interface
org.refcodes.serial.Segment

Uses of Segment in org.refcodes.serial

Classes in org.refcodes.serial with type parameters of type Segment

Modifier and Type	Class	Description
class	AbstractSegmentDecorator<SEGMENT extends Segment>	Convenience class for easily decorating a Segment.
interface	ArraySegment<SEGMENT extends Segment>	A ArraySegment is a Segment with array Segment elements as of ArrayTransmission.
class	AssertMagicBytesSegmentDecorator<DECORATEE extends Segment>	The AssertMagicBytesSegmentDecorator extends the MagicBytesSegmentDecorator and enforces the configured magic bytes to match the received magic bytes (as of fromTransmission(Sequence) and AssertMagicBytesSegmentDecorator.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like).
class	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.
class	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.
class	CrcSegmentDecorator<DECORATEE extends Segment>	A CrcSegmentDecorator wraps a Segment instance and enriches the Segment with a CRC checksum.
class	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).
class	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.
class	LengthSegmentDecoratorSegment<DECORATEE extends Segment>	An LengthSegmentDecoratorSegment enriches a Segment with an allocation declaration being prefixed to the enriched Segment.
class	MagicBytesSegmentDecorator<DECORATEE extends Segment>	Magic bytes are usually found (somewhere) at the beginning of a file or a stream.
class	ReadyToReceiveSegmentDecorator<DECORATEE extends Segment>	The ReadyToReceiveSegmentDecorator class implements a decorator providing ReadyToReceiveTransmission functionality for a Segment.
static final class	ReadyToReceiveSegmentDecorator.Builder<DECORATEE extends Segment>	Builder to build ReadyToReceiveSegmentDecorator instances .
class	ReadyToSendSegmentDecorator<DECORATEE extends Segment>	The ReadyToSendSegmentDecorator class implements a decorator providing ReadyToSendTransmission functionality for a Segment.
static final class	ReadyToSendSegmentDecorator.Builder<DECORATEE extends Segment>	Builder to build ReadyToSendSegmentDecorator instances.
class	ReceiveSegmentConsumerDaemon<SEGMENT extends Segment>	A daemon handling SegmentReceiver.onReceiveSegment(Segment, SegmentConsumer) asynchronous calls.
class	ReceiveSegmentResultDaemon<SEGMENT extends Segment>	A daemon handling SegmentReceiver.onReceiveSegment(Segment) asynchronous calls.
class	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).
class	SegmentComposite<CHILD extends Segment>	The SegmentComposite is a Segment composed of multiple child Segment elements.
interface	SegmentConsumer<SEGMENT extends Segment>	A SegmentConsumer consumes a Segment and is used to create lambda expressions used for asynchronous callback.
class	SegmentResult<SEGMENT extends Segment>	A SegmentResult instance is issued by the SerialReceiver to receive a Transmission's data asynchronously.
class	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.
static final class	StopAndWaitPacketStreamSegmentDecorator.Builder<DECORATEE extends Segment>	Builder to build StopAndWaitSegmentDecorator instances.
class	StopAndWaitSegmentDecorator<DECORATEE extends Segment>	The StopAndWaitSegmentDecorator class implements a decorator providing StopAndWaitTransmission functionality for a Segment.
static final class	StopAndWaitSegmentDecorator.Builder<DECORATEE extends Segment>	Builder to build StopAndWaitSegmentDecorator instances.
class	TransmitSegmentConsumerDaemon<SEGMENT extends Segment>	A daemon handling SegmentTransmitter.doTransmitSegment(Segment, SegmentConsumer) asynchronous calls.
class	TransmitSegmentResultDaemon<SEGMENT extends Segment>	A daemon handling SegmentTransmitter.doTransmitSegment(Segment) asynchronous calls.

Subinterfaces of Segment in org.refcodes.serial

Modifier and Type	Interface	Description
interface	ArraySegment<SEGMENT extends Segment>	A ArraySegment is a Segment with array Segment elements as of ArrayTransmission.
interface	DecoratorSegment<DECORATEE extends Transmission>	The DecoratorSegment interface provided means to access a decorated Transmission with the means of a Segment.
interface	PayloadSegment<T>	The PayloadSegment interfaces defines a Segment with a payload.
static interface	Segment.SegmentMixin	Default implementation of the Segment interface providing an implementation of the Segment.SegmentMixin.receiveFrom(InputStream, OutputStream) method using the fromTransmission(Sequence) method or the fromTransmission(Sequence, int) method.

Classes in org.refcodes.serial that implement Segment

Modifier and Type	Class	Description
class	AbstractLengthDecoratorSegment<DECORATEE extends Transmission>	The AbstractLengthDecoratorSegment decorates a decoratee with a length prefix.
class	AbstractPayloadSegment<T>	An abstract implementation of a Segment with payload.
class	AbstractReferenceeLengthSegment<REFERENCEE extends Transmission>	The AbstractReferenceeLengthSegment represents a allocated length value as of the referenced Transmission element's length.
class	AbstractSegmentDecorator<SEGMENT extends Segment>	Convenience class for easily decorating a Segment.
class	AllocSectionDecoratorSegment<DECORATEE extends Section>	An AllocSectionDecoratorSegment enriches an Section with an allocation declaration being prefixed to the enriched Section.
class	AllocSegmentBody<DECORATEE extends Section>	An AllocSegmentBody provides an Segment with an allocation length.
class	AllocSegmentHead	An AllocSegmentHead provides the allocation length for a AllocSegmentBody.
class	AsciizArraySegment	The AsciizArraySegment is an implementation of a Section carrying a String array as payload.
class	AsciizSegment	The AsciizSegment is an implementation of a Segment carrying an ASCII encoded String as payload, terminated by a 0 ("zero") indicating its end.
class	AssertMagicBytesSegment	The AssertMagicBytesSegment extends the MagicBytesSegment and enforces the configured magic bytes to match the received magic bytes (as of fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like).
class	AssertMagicBytesSegmentDecorator<DECORATEE extends Segment>	The AssertMagicBytesSegmentDecorator extends the MagicBytesSegmentDecorator and enforces the configured magic bytes to match the received magic bytes (as of fromTransmission(Sequence) and AssertMagicBytesSegmentDecorator.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like).
class	BooleanSegment	The BooleanSegment is an implementation of a Segment carrying in boolean value as value.
class	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.
class	ByteSegment	The ByteSegment is an implementation of a Segment carrying in byte value as payload.
class	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.
class	ComplexTypeSegment<T>	A ComplexTypeSegment takes a POJO (a data structure) and creates from its content a Segment representing the POJO's structure.
class	CrcSegmentDecorator<DECORATEE extends Segment>	A CrcSegmentDecorator wraps a Segment instance and enriches the Segment with a CRC checksum.
class	DoubleSegment	The DoubleSegment is an implementation of a Segment carrying in double value as payload.
class	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.
class	EnumSegment<E extends Enum<E>>	The EnumSegment is an implementation of a Segment carrying an enumeration value as payload.
class	FixedLengthSequenceSegment	The FixedLengthSequenceSegment is a Segment representing a Sequence of a fixed length (as of the arguments passed to one of its constructors).
class	FloatSegment	The FloatSegment is an implementation of a Segment carrying in float value as payload.
class	IntSegment	The IntSegment is an implementation of a Segment carrying an integer value as payload.
class	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.
class	LengthSegment<REFERENCEE extends Transmission>	An LengthSegment enriches a Segment with an allocation declaration computed from the referenced Transmission.
class	LengthSegmentDecoratorSegment<DECORATEE extends Segment>	An LengthSegmentDecoratorSegment enriches a Segment with an allocation declaration being prefixed to the enriched Segment.
class	LongSegment	The LongSegment is an implementation of a Segment carrying in long value as payload.
class	MagicBytesSegment	Magic bytes are usually found (somewhere) at the beginning of a file or a stream.
class	MagicBytesSegmentDecorator<DECORATEE extends Segment>	Magic bytes are usually found (somewhere) at the beginning of a file or a stream.
class	MagicBytesSegmentMultiplexer	THe MagicBytesSegmentMultiplexer dispatches a transmission to one of the aggregated Segment instances depending on the magic number provided by the transmission.
class	NullSegment	The NullSegment represents a no-operation Segment, useful as placeholder in a SegmentComposite.
class	NumberSegment	The NumberSegment is an implementation of a Segment carrying an integer value with a configurable width (in bytes) as payload.
class	ReadyToReceiveSegmentDecorator<DECORATEE extends Segment>	The ReadyToReceiveSegmentDecorator class implements a decorator providing ReadyToReceiveTransmission functionality for a Segment.
class	ReadyToSendSegmentDecorator<DECORATEE extends Segment>	The ReadyToSendSegmentDecorator class implements a decorator providing ReadyToSendTransmission functionality for a Segment.
class	SegmentComposite<CHILD extends Segment>	The SegmentComposite is a Segment composed of multiple child Segment elements.
class	SequenceNumberSegment	Convenience class for the NumberSegment using TransmissionMetrics sequence number related properties to configure the SequenceNumberSegment (being an accordingly configured NumberSegment).
class	ShortSegment	The ShortSegment is an implementation of a Segment carrying in short value as payload.
class	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.
class	StopAndWaitSegmentDecorator<DECORATEE extends Segment>	The StopAndWaitSegmentDecorator class implements a decorator providing StopAndWaitTransmission functionality for a Segment.
class	StringSegment	The StringSegment is an implementation of a Section carrying a String as payload.

Fields in org.refcodes.serial declared as Segment

Modifier and Type	Field	Description
protected Segment	AbstractStopAndWaitTransmissionDecorator._acknowledgeSegment
protected Segment	AbstractReadyToSendTransmissionDecorator._clearToSendSegment
protected Segment	PacketInputStream._packetSegment
protected Segment	PacketOutputStream._packetSegment
protected Segment	AbstractReadyToReceiveTransmissionDecorator._readyToReceiveSegment
protected Segment	AbstractReadyToSendTransmissionDecorator._readyToSendSegment

Methods in org.refcodes.serial with type parameters of type Segment

Modifier and Type	Method	Description
static <ARRAY extends Segment> SegmentArraySection<ARRAY>	SerialSugar.arraySection(ARRAY... aSegmentArray)	Constructs a SegmentArraySection with the given Segment elements.
static <ARRAY extends Segment> SegmentArraySection<ARRAY>	SerialSugar.arraySection(Class<ARRAY> aSegmentClass)	Constructs a SegmentArraySection with instances of the array being created using the provided Class instance.
static <ARRAY extends Segment> SegmentArraySection<ARRAY>	SerialSugar.arraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory)	Constructs a SegmentArraySection with instances of the array being created using the provided TypeFactory instance.
static <ARRAY extends Segment> SegmentArraySection<ARRAY>	SerialSugar.arraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegmentArray)	Constructs a SegmentArraySection with the given elements.
static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE>	SerialSugar.assertMagicBytesSegment(DECORATEE aDecoratee, byte... aMagicBytes)	Enriches the provided Segment with the given magic bytes being prefixed.
static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE>	SerialSugar.assertMagicBytesSegment(DECORATEE aDecoratee, String aMagicBytes)	Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE>	SerialSugar.assertMagicBytesSegment(DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)	Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE>	SerialSugar.assertMagicBytesSegment(String aAlias, DECORATEE aDecoratee, byte... aMagicBytes)	Enriches the provided Segment with the given magic bytes being prefixed.
static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE>	SerialSugar.assertMagicBytesSegment(String aAlias, DECORATEE aDecoratee, String aMagicBytes)	Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE>	SerialSugar.assertMagicBytesSegment(String aAlias, DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)	Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
static <DECORATEE extends Segment> BreakerSegmentDecorator<DECORATEE>	SerialSugar.breakerSegment(DECORATEE aDecoratee, int aBreakNumber)	Constructs a BreakerSegmentDecorator instance with the given decoratee breaking deserialization of the decorated segments by the given number of times.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator.Builder<DECORATEE>	ReadyToReceiveSegmentDecorator.builder()	Creates builder to build ReadyToReceiveSegmentDecorator.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator.Builder<DECORATEE>	ReadyToSendSegmentDecorator.builder()	Creates builder to build ReadyToSendSegmentDecorator.
static <DECORATEE extends Segment> StopAndWaitPacketStreamSegmentDecorator.Builder<DECORATEE>	StopAndWaitPacketStreamSegmentDecorator.builder()	Creates builder to build StopAndWaitPacketStreamSegmentDecorator.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator.Builder<DECORATEE>	StopAndWaitSegmentDecorator.builder()	Creates builder to build StopAndWaitSegmentDecorator.
static <DECORATEE extends Segment> CipherSegmentDecorator<DECORATEE>	SerialSugar.cipherSegment(DECORATEE aDecoratee, Cipher aCipher)	Constructs a Cipher transmission decorator applying bijective and inverse functions upon the delegated methods.
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcPrefixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)	Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcPrefixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)	Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcPrefixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)	Constructs a CrcSegmentDecorator wrapping the given Segment.
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcPrefixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)	Constructs a CrcSegmentDecorator wrapping the given Segment.
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcPrefixSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)	Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)	Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)	Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)	Constructs a CrcSegmentDecorator wrapping the given Segment.
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs a CrcSegmentDecorator wrapping the given Segment.
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)	Constructs a CrcSegmentDecorator wrapping the given Segment.
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcSuffixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)	Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcSuffixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)	Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcSuffixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)	Constructs a CrcSegmentDecorator wrapping the given Segment.
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcSuffixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)	Constructs a CrcSegmentDecorator wrapping the given Segment.
static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE>	SerialSugar.crcSuffixSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)	Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
<SEGMENT extends Segment> SegmentResult<SEGMENT>	AbstractPort.doTransmitSegment(SEGMENT aSegment)	Asynchronously sends a Segment's Sequence data (does not block this thread).
<SEGMENT extends Segment> void	AbstractPort.doTransmitSegment(SEGMENT aSegment, SegmentConsumer<SEGMENT> aSegmentConsumer)	Asynchronously sends a Segment's Sequence data (does not block this thread).
<SEGMENT extends Segment> SegmentResult<SEGMENT>	AbstractPortDecorator.doTransmitSegment(SEGMENT aSegment)	Asynchronously sends a Segment's Sequence data (does not block this thread).
<SEGMENT extends Segment> void	AbstractPortDecorator.doTransmitSegment(SEGMENT aSegment, SegmentConsumer<SEGMENT> aSegmentConsumer)	Asynchronously sends a Segment's Sequence data (does not block this thread).
<SEGMENT extends Segment> SegmentResult<SEGMENT>	SegmentTransmitter.doTransmitSegment(SEGMENT aSegment)	Asynchronously sends a Segment's Sequence data (does not block this thread).
<SEGMENT extends Segment> void	SegmentTransmitter.doTransmitSegment(SEGMENT aSegment, SegmentConsumer<SEGMENT> aSegmentConsumer)	Asynchronously sends a Segment's Sequence data (does not block this thread).
static <ARRAY extends Segment> FixedSegmentArraySection<ARRAY>	SerialSugar.fixedSegmentArraySection(ARRAY... aSegmentArray)	Constructs a FixedSegmentArraySection with the given Segment elements.
static <ARRAY extends Segment> FixedSegmentArraySection<ARRAY>	SerialSugar.fixedSegmentArraySection(Class<ARRAY> aSegmentClass)	Constructs a FixedSegmentArraySection with instances of the array being created using the provided Class instance.
static <ARRAY extends Segment> FixedSegmentArraySection<ARRAY>	SerialSugar.fixedSegmentArraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory)	Constructs a FixedSegmentArraySection with instances of the array being created using the provided TypeFactory instance.
static <ARRAY extends Segment> FixedSegmentArraySection<ARRAY>	SerialSugar.fixedSegmentArraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegmentArray)	Constructs a FixedSegmentArraySection with the given elements.
static <DECORATEE extends Segment> InvertibleSegmentDecorator<DECORATEE>	SerialSugar.invertibleSegment(DECORATEE aDecoratee, org.refcodes.numerical.BijectiveFunction<Byte,Byte> aBijectiveFunction, org.refcodes.numerical.InverseFunction<Byte,Byte> aInverseFunction)	Constructs an invertible transmission decorator applying bijective and inverse functions upon the delegated methods.
static <DECORATEE extends Segment> InvertibleSegmentDecorator<DECORATEE>	SerialSugar.invertibleSegment(DECORATEE aDecoratee, org.refcodes.numerical.Invertible<Byte,Byte> aInvertible)	Constructs an invertible transmission decorator applying bijective and inverse functions upon the delegated methods.
static <DECORATEE extends Segment> LengthSegmentDecoratorSegment<DECORATEE>	SerialSugar.lengthSegment(DECORATEE aSegment)	Constructs a LengthSegmentDecoratorSegment with the given decoratee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.
static <DECORATEE extends Segment> LengthSegmentDecoratorSegment<DECORATEE>	SerialSugar.lengthSegment(DECORATEE aSegment, int aLengthWidth)	Constructs a LengthSegmentDecoratorSegment with the given decoratee and with the given number of bytes used to specify the decoratee's length and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.
static <DECORATEE extends Segment> LengthSegmentDecoratorSegment<DECORATEE>	SerialSugar.lengthSegment(DECORATEE aSegment, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)	Constructs a LengthSegmentDecoratorSegment with the given decoratee and with the given number of bytes used to specify the decoratee's length and the provided Endianess representation of the decoratee's length.
static <DECORATEE extends Segment> LengthSegmentDecoratorSegment<DECORATEE>	SerialSugar.lengthSegment(DECORATEE aSegment, org.refcodes.numerical.Endianess aEndianess)	Constructs a LengthSegmentDecoratorSegment with the given decoratee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length and the provided Endianess representation of the decoratee's length.
static <DECORATEE extends Segment> LengthSegmentDecoratorSegment<DECORATEE>	SerialSugar.lengthSegment(DECORATEE aSegment, TransmissionMetrics aTransmissionMetrics)	Constructs a LengthSegmentDecoratorSegment with the given decoratee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.
static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE>	SerialSugar.magicBytesSegment(DECORATEE aDecoratee, byte... aMagicBytes)	Enriches the provided Segment with the given magic bytes being prefixed.
static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE>	SerialSugar.magicBytesSegment(DECORATEE aDecoratee, int aMagicBytesLength)	Enriches the provided Segment with magic bytes of the given length to be prefixed.
static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE>	SerialSugar.magicBytesSegment(DECORATEE aDecoratee, String aMagicBytes)	Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE>	SerialSugar.magicBytesSegment(DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)	Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE>	SerialSugar.magicBytesSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)	Enriches the provided decoratee with magic bytes of the given length to be prefixed.
static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE>	SerialSugar.magicBytesSegment(String aAlias, DECORATEE aDecoratee, byte... aMagicBytes)	Enriches the provided Segment with the given magic bytes being prefixed.
static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE>	SerialSugar.magicBytesSegment(String aAlias, DECORATEE aDecoratee, int aMagicBytesLength)	Enriches the provided Segment with magic bytes of the given length to be prefixed.
static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE>	SerialSugar.magicBytesSegment(String aAlias, DECORATEE aDecoratee, String aMagicBytes)	Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE>	SerialSugar.magicBytesSegment(String aAlias, DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)	Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE>	SerialSugar.magicBytesSegment(String aAlias, DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)	Enriches the provided decoratee with magic bytes of the given length to be prefixed.
<SEGMENT extends Segment> SegmentResult<SEGMENT>	AbstractPort.onReceiveSegment(SEGMENT aSegment)	Asynchronously receives a Segment's Sequence data (does not block this thread) and updates the Segment by invoking fromTransmission(Sequence).
<SEGMENT extends Segment> void	AbstractPort.onReceiveSegment(SEGMENT aSegment, SegmentConsumer<SEGMENT> aSegmentConsumer)	Asynchronously receives a Segment's Sequence data (does not block this thread) and updates the Segment by invoking fromTransmission(Sequence), passing the result to the callback SegmentConsumer.onSegment(Segment).
<SEGMENT extends Segment> SegmentResult<SEGMENT>	AbstractPortDecorator.onReceiveSegment(SEGMENT aSegment)	Asynchronously receives a Segment's Sequence data (does not block this thread) and updates the Segment by invoking fromTransmission(Sequence).
<SEGMENT extends Segment> void	AbstractPortDecorator.onReceiveSegment(SEGMENT aSegment, SegmentConsumer<SEGMENT> aSegmentConsumer)	Asynchronously receives a Segment's Sequence data (does not block this thread) and updates the Segment by invoking fromTransmission(Sequence), passing the result to the callback SegmentConsumer.onSegment(Segment).
<SEGMENT extends Segment> SegmentResult<SEGMENT>	SegmentReceiver.onReceiveSegment(SEGMENT aSegment)	Asynchronously receives a Segment's Sequence data (does not block this thread) and updates the Segment by invoking fromTransmission(Sequence).
<SEGMENT extends Segment> void	SegmentReceiver.onReceiveSegment(SEGMENT aSegment, SegmentConsumer<SEGMENT> aSegmentConsumer)	Asynchronously receives a Segment's Sequence data (does not block this thread) and updates the Segment by invoking fromTransmission(Sequence), passing the result to the callback SegmentConsumer.onSegment(Segment).
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, long aReadyToReceiveTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE>	SerialSugar.readyToReceiveSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)	Constructs an according control-flow decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, byte[] aClearToSendMagicBytes)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, byte[] aClearToSendMagicBytes)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, byte[] aClearToSendMagicBytes)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, byte[] aClearToSendMagicBytes)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)	Constructs an according flow-control decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE>	SerialSugar.readyToSendSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)	Constructs an according control-flow decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator.Builder<DECORATEE>	SerialSugar.readyToSendSegmentBuilder()	Constructs a builder to build an according ReadyToSendSegmentDecorator instance.
<HEADER extends Segment> void	AbstractPort.receiveSegment(HEADER aSegment)	Receives a Segment (and blocks this thread) till all it's Sequence data has been received and updates the Segment by invoking fromTransmission(Sequence).
<SEGMENT extends Segment> void	AbstractPortDecorator.receiveSegment(SEGMENT aSegment)	Receives a Segment (and blocks this thread) till all it's Sequence data has been received and updates the Segment by invoking fromTransmission(Sequence).
<SEGMENT extends Segment> void	SegmentDestination.receiveSegment(SEGMENT aSegment)	Receives a Segment (and blocks this thread) till all it's Sequence data has been received and updates the Segment by invoking fromTransmission(Sequence).
default <SEGMENT extends Segment> void	SerialReceiver.receiveSegment(SEGMENT aSegment)	Receives a Segment (and blocks this thread) till all it's Sequence data has been received and updates the Segment by invoking fromTransmission(Sequence).
default <SEGMENT extends Segment> void	SerialTransceiver.receiveSegment(SEGMENT aSegment)	Receives a Segment (and blocks this thread) till all it's Sequence data has been received and updates the Segment by invoking fromTransmission(Sequence).
<SEGMENT extends Segment> void	AbstractPortDecorator.receiveSegmentWithin(long aTimeoutMillis, SEGMENT aSegment)	Receives a Segment (and blocks this thread) till all it's Sequence data has been received and updates the Segment by invoking fromTransmission(Sequence).
<SEGMENT extends Segment> void	SegmentReceiver.receiveSegmentWithin(long aTimeoutMillis, SEGMENT aSegment)	Receives a Segment (and blocks this thread) till all it's Sequence data has been received and updates the Segment by invoking fromTransmission(Sequence).
default <SEGMENT extends Segment> void	SerialReceiver.receiveSegmentWithin(long aTimeoutMillis, SEGMENT aSegment)	Receives a Segment (and blocks this thread) till all it's Sequence data has been received and updates the Segment by invoking fromTransmission(Sequence).
static <CHILD extends Segment> SegmentComposite<CHILD>	SerialSugar.segmentComposite(CHILD... aChildren)	Constructs a SegmentComposite containing the provided Segment elements.
static <CHILD extends Segment> SegmentComposite<CHILD>	SerialSugar.segmentComposite(Collection<CHILD> aChildren)	Constructs a SegmentComposite containing the provided Segment elements.
static <DECORATEE extends Segment> StopAndWaitPacketStreamSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitPacketStreamSegment(DECORATEE aDecoratee, int aBlockSize, int aPacketLengthWidth, byte[] aPacketMagicBytes, byte[] aLastPacketMagicBytes, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, SegmentPackager aPacketSegmentPackager, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)	Constructs an according packet-stream decorator instance wrapping the given OutputStream.
static <DECORATEE extends Segment> StopAndWaitPacketStreamSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitPacketStreamSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)	Constructs an according packet-stream decorator instance wrapping the given OutputStream.
static <DECORATEE extends Segment> StopAndWaitPacketStreamSegmentDecorator.Builder<DECORATEE>	SerialSugar.stopAndWaitPacketStreamSegmentBuilder()	Constructs a builder to build an according StopAndWaitPacketStreamSegmentDecorator instance.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, SegmentPackager aAckSegmentPackager)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE>	SerialSugar.stopAndWaitSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)	Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
static <DECORATEE extends Segment> StopAndWaitSegmentDecorator.Builder<DECORATEE>	SerialSugar.stopAndWaitSegmentBuilder()	Constructs a builder to build an according StopAndWaitSegmentDecorator instance.
<SEGMENT extends Segment> void	AbstractPortDecorator.transmitSegment(SEGMENT aSegment)	Transmits a Segment (and blocks this thread) till all it's Sequence data (as of Transmission.toSequence()) has been sent.
<SEGMENT extends Segment> void	SegmentSource.transmitSegment(SEGMENT aSegment)	Transmits a Segment (and blocks this thread) till all it's Sequence data (as of Transmission.toSequence()) has been sent.
default <SEGMENT extends Segment> void	SerialTransceiver.transmitSegment(SEGMENT aSegment)	Transmits a Segment (and blocks this thread) till all it's Sequence data (as of Transmission.toSequence()) has been sent.
default <SEGMENT extends Segment> void	SerialTransmitter.transmitSegment(SEGMENT aSegment)	Transmits a Segment (and blocks this thread) till all it's Sequence data (as of Transmission.toSequence()) has been sent.

Methods in org.refcodes.serial that return Segment

Modifier and Type	Method	Description
Segment	CrcSegmentPackager.toPackaged(Segment aUnpacked)
Segment	SegmentPackager.DummySegmentPackager.toPackaged(Segment aUnpacked)
Segment	SegmentPackager.toPackaged(Segment aUnpacked)

Methods in org.refcodes.serial with parameters of type Segment

Modifier and Type	Method	Description
static <ARRAY extends Segment> SegmentArraySection<ARRAY>	SerialSugar.arraySection(ARRAY... aSegmentArray)	Constructs a SegmentArraySection with the given Segment elements.
static <ARRAY extends Segment> SegmentArraySection<ARRAY>	SerialSugar.arraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegmentArray)	Constructs a SegmentArraySection with the given elements.
static <ARRAY extends Segment> FixedSegmentArraySection<ARRAY>	SerialSugar.fixedSegmentArraySection(ARRAY... aSegmentArray)	Constructs a FixedSegmentArraySection with the given Segment elements.
static <ARRAY extends Segment> FixedSegmentArraySection<ARRAY>	SerialSugar.fixedSegmentArraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegmentArray)	Constructs a FixedSegmentArraySection with the given elements.
static MagicBytesSegmentMultiplexer	SerialSugar.magicBytesSegmentMultiplexer(int aReadLimit, Segment... aSegments)	Constructs a MagicBytesSegmentMultiplexer containing the provided Segment elements.
static MagicBytesSegmentMultiplexer	SerialSugar.magicBytesSegmentMultiplexer(Segment... aSegments)	Constructs a MagicBytesSegmentMultiplexer containing the provided Segment elements.
static <CHILD extends Segment> SegmentComposite<CHILD>	SerialSugar.segmentComposite(CHILD... aChildren)	Constructs a SegmentComposite containing the provided Segment elements.
Segment	CrcSegmentPackager.toPackaged(Segment aUnpacked)
Segment	SegmentPackager.DummySegmentPackager.toPackaged(Segment aUnpacked)
Segment	SegmentPackager.toPackaged(Segment aUnpacked)
FixedSegmentArraySection<ARRAY>	FixedSegmentArraySection.withArray(ARRAY[] aValue)
SegmentArraySection<ARRAY>	SegmentArraySection.withArray(ARRAY[] aValue)

Method parameters in org.refcodes.serial with type arguments of type Segment

Modifier and Type	Method	Description
static MagicBytesSegmentMultiplexer	SerialSugar.magicBytesSegmentMultiplexer(Collection<Segment> aSegments)	Constructs a MagicBytesSegmentMultiplexer containing the provided Segment elements.
static MagicBytesSegmentMultiplexer	SerialSugar.magicBytesSegmentMultiplexer(Collection<Segment> aSegments, int aReadLimit)	Constructs a MagicBytesSegmentMultiplexer containing the provided Segment elements.

Constructors in org.refcodes.serial with parameters of type Segment

Modifier	Constructor	Description
	FixedSegmentArraySection(ARRAY... aSegments)
	FixedSegmentArraySection(String aAlias, ARRAY... aSegments)
	FixedSegmentArraySection(String aAlias, org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegments)
	FixedSegmentArraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegments)
	MagicBytesSegmentMultiplexer(int aReadLimit, Segment... aSegments)
	MagicBytesSegmentMultiplexer(Segment... aSegments)
	SegmentArraySection(ARRAY... aSegments)
	SegmentArraySection(String aAlias, ARRAY... aSegments)
	SegmentArraySection(String aAlias, org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegments)
	SegmentArraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegments)
	SegmentComposite(CHILD... aSegments)

Constructor parameters in org.refcodes.serial with type arguments of type Segment

Modifier	Constructor	Description
	MagicBytesSegmentMultiplexer(Collection<Segment> aSegments)
	MagicBytesSegmentMultiplexer(Collection<Segment> aSegments, int aReadLimit)