An abstract implementation of bijective and inverse functions applied to the
decoratee's transmitting and receiving methods.
An abstract implementation of bijective and inverse functions applied to the
decoratee's transmitting and receiving methods.
Magic bytes are usually found (somewhere) at the beginning of a file or a
stream.
Magic bytes are usually found (somewhere) at the beginning of a file or a
stream.
An abstract implementation of a
Section
with payload.
An abstract implementation of a
Segment
with payload.
Provides an accessor for a acknowledge magic bytes property.
Provides a builder method for a acknowledge magic bytes property
returning the builder for applying multiple build operations.
Provides a mutator for a acknowledge magic bytes property.
Provides an accessor for a acknowledge retry number.
Provides a builder method for a acknowledge retry number returning the
builder for applying multiple build operations.
Provides a mutator for a acknowledge retry number.
Provides a builder method for a
SegmentPackager
ACK property
returning the builder for applying multiple build operations.
Provides an accessor for a acknowledge timeout in milliseconds property.
Provides a builder method for the acknowledge timeout property returning
the builder for applying multiple build operations.
Provides a mutator for a acknowledge timeout in milliseconds property.
Provides an accessor for a allocation length property.
Provides a builder method for a allocation length property returning the
builder for applying multiple build operations.
Provides a mutator for a allocation length property.
Provides a allocation length property.
The
AsciizSegment
is an implementation of a
Segment
carrying
an ASCII encoded
String
as payload, terminated by a 0 ("zero")
indicating its end.
Thrown in case a transmission's CRC checksum did not match the according
calculated CRC checksum.
Thrown in case a
Sequence
CRC checksum did not match the according
calculated CRC checksum.
A
ByteArraySequence
implements the
Sequence
interface by
using chunks of byte arrays, therewith reducing array copy operations when
working with byte fields.
Provides an accessor for a CTS ("clear-to-send") magic bytes property.
Provides a builder method for a CTS ("clear-to-send") magic bytes
property returning the builder for applying multiple build operations.
Provides a mutator for a CTS ("clear-to-send") magic bytes property.
Provides an accessor for a CTS ("clear-to-send") retry number.
Provides a builder method for a CTS ("clear-to-send") retry number
returning the builder for applying multiple build operations.
Provides a mutator for a CTS ("clear-to-send") retry number.
Provides a builder method for a
SegmentPackager
CTS
("clear-to-send") property returning the builder for applying multiple
build operations.
Provides an accessor for a CTS ("clear-to-send") timeout in milliseconds
property.
Provides a builder method for a the CTS ("clear-to-send") timeout
property returning the builder for applying multiple build operations.
Provides a mutator for a CTS ("clear-to-send") timeout in milliseconds
property.
A
ComplexTypeSegment
takes a POJO (a data structure) and creates from
its content a
Segment
representing the POJO's structure.
The
DynamicTypeSection
represents a
Section
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.
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.
he
DynamicTypeTransmission
represents a
Transmission
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.
Provides an accessor for a end of string byte property.
Provides a builder method for a end of string byte property returning the
builder for applying multiple build operations.
Provides a mutator for a end of string byte property.
Provides an accessor for a ENQ ("enquiry") timeout in milliseconds property.
Provides a builder method for a the ENQ ("enquiry") timeout property
returning the builder for applying multiple build operations.
Provides a mutator for a ENQ ("enquiry") timeout in milliseconds
property.
The
EnumSegment
is an implementation of a
Segment
carrying an
enumeration value as payload.
A
FileSection
represents a
File
on the file system and can be
used to receive or to transmit a
File
.
Thrown in case a flow control failed.
Thrown in case a flow control failed due t a timeout.
Defines the type of flow control.
Provides an accessor for a handshake magic bytes property.
Provides a builder method for a handshake magic bytes property returning
the builder for applying multiple build operations.
Provides a mutator for a handshake magic bytes property.
Enumeration with the various protocol settings when receiving a transmission.
Provides an accessor for an input return stream property.
Provides a mutator for an input return stream property.
Provides a mutator for an input return stream property.
The
IntSegment
is an implementation of a
Segment
carrying an
integer value as payload.
Provides an accessor for a IO heuristics TTL (time to live) in milliseconds
property.
Provides a builder method for the IO heuristics TTL (time to live)
property returning the builder for applying multiple build operations.
Provides a mutator for a IO heuristics TTL (time to live) in milliseconds
property.
Provides an accessor for a length width (in bytes) property.
Provides a builder method for a length width (in bytes) property
returning the builder for applying multiple build operations.
Provides a mutator for a length width (in bytes) property.
The
LoopbackPort
is an in-memory implementation of a
Port
which loops its output directly back to its input.
The
MagicBytes
enumeration provides various predefined magic bytes
for common use cases.
Provides an accessor for a magic byte array property.
Provides a builder method for a magic byte array property returning the
builder for applying multiple build operations.
Provides a mutator for a magic byte array property.
Provides a magic byte array property.
Provides an accessor for a magic bytes length property.
Provides a builder method for a magic bytes length property returning the
builder for applying multiple build operations.
Provides a mutator for a magic bytes length property.
Magic bytes are usually found (somewhere) at the beginning of a file or a
stream.
Magic bytes are usually found (somewhere) at the beginning of a file or a
stream.
Magic bytes are usually found (somewhere) at the beginning of a file or a
stream.
Thrown in case there is no such port found.
The
NumberSegment
is an implementation of a
Segment
carrying
in long an integer value with a configurable width (in bytes) as payload.
Provides an accessor for an output return stream property.
Provides a mutator for an output return stream property.
Provides a mutator for an output return stream property.
Provides an accessor for a packet length width (in bytes) property.
Provides a builder method for a packet length width (in bytes) property
returning the builder for applying multiple build operations.
Provides a mutator for a packet length width (in bytes) property.
Provides an accessor for a packet magic bytes property.
Provides a builder method for a packet magic bytes property returning the
builder for applying multiple build operations.
Provides a mutator for a packet magic bytes property.
The
PacketOutputStream
wraps an
OutputStream
and chunks any
data to be written into packets with a sequence number, a block of data and a
CRC checksum.
Provides a builder method for a packet
SegmentPackager
property
returning the builder for applying multiple build operations.
Provides an accessor for a ping magic bytes property.
Provides a builder method for a ping magic bytes property returning the
builder for applying multiple build operations.
Provides a mutator for a ping magic bytes property.
Provides an accessor for a ping retry number.
Provides a builder method for a ping retry number returning the builder
for applying multiple build operations.
Provides a mutator for a ping retry number.
Provides an accessor for a ping timeout in milliseconds property.
Provides a builder method for the ping timeout property returning the
builder for applying multiple build operations.
Provides a mutator for a ping timeout in milliseconds property.
Provides an accessor for a pong magic bytes property.
Provides a builder method for a pong magic bytes property returning the
builder for applying multiple build operations.
Provides a mutator for a pong magic bytes property.
A
PortHub
implementation is used to retrieve
Port
instances
of a given type (e.g.
Provides a builder method for a
PortMetrics
property returning
the builder for applying multiple build operations.
Provides an accessor for a RTR ("ready-to-receive") magic bytes property.
Provides a builder method for a RTR ("ready-to-receive") magic bytes
property returning the builder for applying multiple build operations.
Provides a mutator for a RTR ("ready-to-receive") magic bytes property.
Provides an accessor for a RTR ("ready-to-receive") retry number.
Provides a builder method for a RTR ("ready-to-receive") retry number
returning the builder for applying multiple build operations.
Provides a mutator for a RTR ("ready-to-receive") retry number.
Provides an accessor for a
SegmentPackager
RTR ("ready-to-receive")
property.
Provides a builder method for a
SegmentPackager
RTR
("ready-to-receive") property returning the builder for applying multiple
build operations.
Provides a mutator for a
SegmentPackager
RTR ("ready-to-receive")
property.
Provides an accessor for a RTR ("ready-to-receive") timeout in milliseconds
property.
Provides a builder method for a the RTR ("ready-to-receive") timeout
property returning the builder for applying multiple build operations.
Provides a mutator for a RTR ("ready-to-receive") timeout in milliseconds
property.
The
ReadyToReceiveTransmission
interface defines functionality for
achieving a RTR "software" handshake between a receiver having the active RTR
("ready-to-receive") role and a transmitter being CTS ("clear-to-send") where
the transmitter waits for a RTR signal from the receiver (the receiver
signals to be ready for receiving data by issuing an RTR signal to the
transmitter):
TRANSMITTER RECEIVER
| |
Wait till enquiry-timeout | | Send RTR magic-bytes
for RTR magic-bytes |←-----RTR------| Try RTR retry-number of times
| | Wait till RTR retry-timeout/retry
Send payload upon RTR | |
magic-bytes or break-out |----PAYLOAD---→| Receive payload
upon enquiry-timeout | |
Handshake specific signals are only transmitted through the return
channel, the data channel is only used indirectly for handshaking by
transporting the payload data in response to the return channel signals.
Provides an accessor for a RTS ("ready-to-send") magic bytes property.
Provides a builder method for a RTS ("ready-to-send") magic bytes
property returning the builder for applying multiple build operations.
Provides a mutator for a RTS ("ready-to-send") magic bytes property.
Provides an accessor for a RTS ("ready-to-send") retry number.
Provides a builder method for a RTS ("ready-to-send") retry number
returning the builder for applying multiple build operations.
Provides a mutator for a RTS ("ready-to-send") retry number.
Provides a builder method for a
SegmentPackager
RTS
("ready-to-send") property returning the builder for applying multiple
build operations.
Provides an accessor for a RTS ("ready-to-send") timeout in milliseconds
property.
Provides a builder method for a the RTS ("ready-to-send") timeout
property returning the builder for applying multiple build operations.
Provides a mutator for a RTS ("ready-to-send") timeout in milliseconds
property.
The
ReadyToSendTransmission
interface defines functionality for
achieving an RTS "software" handshake between a transmitter having the active
RTS ("ready-to-send") role and a receiver confirming being CTS
("clear-to-send") where the receiver waits for a RTS signal from the
transmitter (the transmitter signals to be ready for sending data by issuing
an RTS signal to the receiver).
A
Sequence
abstracts a byte field providing means to applying complex
operations on that byte field.
Provides an accessor for a
Sequence
property.
Provides a builder method for a segment property returning the builder
for applying multiple build operations.
Provides a mutator for a segment property.
Provides an accessor for a sequence number property.
Provides a builder method for a sequence number property returning the
builder for applying multiple build operations.
Provides a mutator for a sequence number property.
Provides an accessor for a ConcatenateMode
property.
Provides a builder method for a sequence number ConcatenateMode
property returning the builder for applying multiple build operations.
Provides a mutator for a sequence number ConcatenateMode
property.
Provides an accessor for a sequence number initial value property.
Provides a builder method for a sequence number initial value property
returning the builder for applying multiple build operations.
Provides a mutator for a sequence number initial value property.
Provides an accessor for a sequence number width (in bytes) property.
Provides a builder method for a sequence number width (in bytes) property
returning the builder for applying multiple build operations.
Provides a mutator for a sequence number width (in bytes) property.
Base exception for this package.
The purpose of a
SerialSchema
is to automatically outline and
generate documentation of serial data (structures).
Provides an accessor for a
Transmission
property (as of the decorator
pattern).
Provides a builder method for a
Transmission
property returning
the builder for applying multiple build operations.
The
TransmissionMetrics
interface represents common parameters
required when configuring a transmission.
Provides a builder method for a
TransmissionMetrics
property
returning the builder for applying multiple build operations.
Provides an accessor for a transmission retry number.
Provides a builder method for a transmission retry number returning the
builder for applying multiple build operations.
Provides a mutator for a transmission retry number.
Thrown in case a given
Sequence
cannot be processed.
Provides an accessor for a transmission timeout in milliseconds property.
Provides a builder method for the transmission timeout property returning
the builder for applying multiple build operations.
Provides a mutator for a transmission timeout in milliseconds property.