Index
All Classes and Interfaces|All Packages
A
- ACKNOWLEDGE - Enum constant in enum class org.refcodes.serial.ext.handshake.AcknowledgeType
-
Sent when a transmission was received.
- ACKNOWLEDGEABLE_REQUEST - Enum constant in enum class org.refcodes.serial.ext.handshake.TransmissionType
-
Identifies a request expecting an acknowledgeable response (acknowledge to be sent sent for the succeeding response).
- ACKNOWLEDGEABLE_RESPONSE - Enum constant in enum class org.refcodes.serial.ext.handshake.TransmissionType
-
Identifies an acknowledgeable response in reply to a request (acknowledge to be sent for the response).
- ACKNOWLEDGEABLE_TRANSMISSION - Enum constant in enum class org.refcodes.serial.ext.handshake.TransmissionType
-
Identifies an acknowledgeable transmission (acknowledge to be sent).
- acknowledgeableRequestMagicBytes - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- acknowledgeableResponseMagicBytes - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- acknowledgeableTransmissionMagicBytes - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- ACKNOWLEDGED - Enum constant in enum class org.refcodes.serial.ext.handshake.AcknowledgeMode
-
A transmission is acknowledged, e.g. directly or the response of a request.
- AcknowledgeMode - Enum Class in org.refcodes.serial.ext.handshake
-
The
AcknowledgeMode
defines the mode of transmission, e.g. - AcknowledgeType - Enum Class in org.refcodes.serial.ext.handshake
-
The
AcknowledgeType
defines the type of anAcknowledgeMessage
confirmation mode in response to aTransmissionMessage
. - AcknowledgeTypeAccessor - Interface in org.refcodes.serial.ext.handshake
-
Provides an accessor for a
AcknowledgeType
property. - AcknowledgeTypeAccessor.AcknowledgeTypeBuilder<B extends AcknowledgeTypeAccessor.AcknowledgeTypeBuilder<B>> - Interface in org.refcodes.serial.ext.handshake
-
Provides a builder method for a
AcknowledgeType
property returning the builder for applying multiple build operations. - AcknowledgeTypeAccessor.AcknowledgeTypeMutator - Interface in org.refcodes.serial.ext.handshake
-
Provides a mutator for a
AcknowledgeType
property. - AcknowledgeTypeAccessor.AcknowledgeTypeProperty - Interface in org.refcodes.serial.ext.handshake
-
Provides a
AcknowledgeType
property. - available() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
B
- build() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
-
Builds the.
- build() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Builds the
HandshakeTransmissionMetrics
instance from this builder's settings. - builder() - Static method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Creates builder to build
HandshakePortController
. - builder() - Static method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Creates builder to build
TransmissionMetrics
. - Builder() - Constructor for class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Instantiates a new builder.
C
- close() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
D
- DEFAULT_REPLY_RETRY_NUMBER - Static variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
- DEFAULT_REPLY_TIMEOUT_IN_MS - Static variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
- doTransmitSegment(SEGMENT) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- doTransmitSegment(SEGMENT, SegmentConsumer<SEGMENT>) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
G
- getAcknowledgeableRequestMagicBytes() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Retrieves the according magic bytes.
- getAcknowledgeableResponseMagicBytes() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Retrieves the according magic bytes.
- getAcknowledgeableTransmissionMagicBytes() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Retrieves the according magic bytes.
- getAcknowledgeMagicBytes() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- getAcknowledgeRetryNumber() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- getAcknowledgeTimeoutMillis() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- getAcknowledgeType() - Method in interface org.refcodes.serial.ext.handshake.AcknowledgeTypeAccessor
-
Retrieves the
AcknowledgeType
from theAcknowledgeType
property. - getChecksumValidationMode() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- getCrcAlgorithm() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- getEndianess() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- getInputStream() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- getInputStream(long) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- getReplyRetryNumber() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Retrieves the number of retries from the reply retry number.
- getReplyRetryNumber() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Retrieves the number of retries from the reply retry number.
- getReplyRetryNumber() - Method in interface org.refcodes.serial.ext.handshake.ReplyRetryNumberAccessor
-
Retrieves the number of retries from the reply retry number.
- getReplyTimeoutMillis() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
The reply timeout attribute in milliseconds.
- getReplyTimeoutMillis() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
The reply timeout attribute in milliseconds.
- getReplyTimeoutMillis() - Method in interface org.refcodes.serial.ext.handshake.ReplyTimeoutMillisAccessor
-
The reply timeout attribute in milliseconds.
- getRequestDismissedMagicBytes() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Retrieves the according magic bytes.
- getRequestMagicBytes() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Retrieves the according magic bytes.
- getResponseAcknowledgeMagicBytes() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Retrieves the according magic bytes.
- getResponseMagicBytes() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Retrieves the according magic bytes.
- getSequenceNumber() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- getSequenceNumberInitValue() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- getSequenceNumberWidth() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- getTransmissionDismissedMagicBytes() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Retrieves the according magic bytes.
- getTransmissionMagicBytes() - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Retrieves the according magic bytes.
- getTransmissionType() - Method in interface org.refcodes.serial.ext.handshake.TransmissionTypeAccessor
-
Retrieves the
TransmissionType
from theTransmissionType
property.
H
- handshakePortController(Port<PM>) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality. - handshakePortController(Port<PM>, ExecutorService) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality. - handshakePortController(Port<PM>, Endianess, byte[], byte[], byte[], byte[], CrcAlgorithm) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - handshakePortController(Port<PM>, Endianess, byte[], byte[], byte[], byte[], CrcAlgorithm, ExecutorService) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - handshakePortController(Port<PM>, Endianess, byte[], byte[], byte[], byte[], CrcAlgorithm, ChecksumValidationMode) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - handshakePortController(Port<PM>, Endianess, byte[], byte[], byte[], byte[], CrcAlgorithm, ChecksumValidationMode, ExecutorService) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - handshakePortController(Port<PM>, Endianess, CrcAlgorithm) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - handshakePortController(Port<PM>, Endianess, CrcAlgorithm, ExecutorService) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - handshakePortController(Port<PM>, Endianess, CrcAlgorithm, ChecksumValidationMode) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - handshakePortController(Port<PM>, Endianess, CrcAlgorithm, ChecksumValidationMode, ExecutorService) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - handshakePortController(Port<PM>, HandshakeTransmissionMetrics) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - handshakePortController(Port<PM>, HandshakeTransmissionMetrics, ExecutorService) - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController<PM extends org.refcodes.serial.PortMetrics> - Class in org.refcodes.serial.ext.handshake
-
A
HandshakePortController
decorates aPort
for its usage in Full-Duplex mode regarding the transmission ofSegment
messages (or any transmission finished off by callingAbstractPortDecorator.flush()
). - HandshakePortController(Port<PM>) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality. - HandshakePortController(Port<PM>, int) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality. - HandshakePortController(Port<PM>, int, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality. - HandshakePortController(Port<PM>, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality. - HandshakePortController(Port<PM>, Endianess, int, long, int, long, int, int, CrcAlgorithm, ChecksumValidationMode) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, int, long, int, long, int, int, CrcAlgorithm, ChecksumValidationMode, int) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, int, long, int, long, int, int, CrcAlgorithm, ChecksumValidationMode, int, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, int, long, int, long, int, int, CrcAlgorithm, ChecksumValidationMode, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, int, long, int, long, int, CrcAlgorithm, ChecksumValidationMode) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, int, long, int, long, int, CrcAlgorithm, ChecksumValidationMode, int) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, int, long, int, long, int, CrcAlgorithm, ChecksumValidationMode, int, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, int, long, int, long, int, CrcAlgorithm, ChecksumValidationMode, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, CrcAlgorithm) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, CrcAlgorithm, int) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, CrcAlgorithm, int, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, CrcAlgorithm, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, CrcAlgorithm, ChecksumValidationMode) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, CrcAlgorithm, ChecksumValidationMode, int) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, CrcAlgorithm, ChecksumValidationMode, int, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, Endianess, CrcAlgorithm, ChecksumValidationMode, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, HandshakeTransmissionMetrics) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, HandshakeTransmissionMetrics, int) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, HandshakeTransmissionMetrics, int, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController(Port<PM>, HandshakeTransmissionMetrics, ExecutorService) - Constructor for class org.refcodes.serial.ext.handshake.HandshakePortController
-
Decorates the given
Port
with full duplexSegment
multiplexer functionality as of the given arguments. - HandshakePortController.Builder<PM extends org.refcodes.serial.PortMetrics> - Class in org.refcodes.serial.ext.handshake
-
Builder for building
HandshakePortController
instances. - handshakePortControllerBuilder() - Static method in class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Constructs a builder to build an according
HandshakePortController
instance. - HandshakeTransmissionMetrics - Class in org.refcodes.serial.ext.handshake
-
The
HandshakeTransmissionMetrics
extend theTransmissionMetrics
with handshake specific metrics. - HandshakeTransmissionMetrics() - Constructor for class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Creates an instance of the
HandshakeTransmissionMetrics
with default values being applied as defined in theHandshakeTransmissionMetrics
type. - HandshakeTransmissionMetrics(HandshakeTransmissionMetrics.Builder) - Constructor for class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Instantiates a new handshake transmission metrics.
- HandshakeTransmissionMetrics.Builder - Class in org.refcodes.serial.ext.handshake
-
Builder to build
TransmissionMetrics
.
I
- isAcknowledgeable() - Method in enum class org.refcodes.serial.ext.handshake.TransmissionType
-
Determines whether the
TransmissionType
expects an acknowledge.
L
- letAcknowledgeType(AcknowledgeType) - Method in interface org.refcodes.serial.ext.handshake.AcknowledgeTypeAccessor.AcknowledgeTypeProperty
-
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given
AcknowledgeType
(setter) as ofAcknowledgeTypeAccessor.AcknowledgeTypeMutator.setAcknowledgeType(AcknowledgeType)
and returns the very same value (getter). - letReplyRetryNumber(int) - Method in interface org.refcodes.serial.ext.handshake.ReplyRetryNumberAccessor.ReplyRetryNumberProperty
-
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given integer (setter) as of
ReplyRetryNumberAccessor.ReplyRetryNumberMutator.setReplyRetryNumber(int)
and returns the very same value (getter). - letReplyTimeoutMillis(long) - Method in interface org.refcodes.serial.ext.handshake.ReplyTimeoutMillisAccessor.ReplyTimeoutMillisProperty
-
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given long (setter) as of
ReplyTimeoutMillisAccessor.ReplyTimeoutMillisMutator.setReplyTimeoutMillis(long)
and returns the very same value (getter). - letTransmissionType(TransmissionType) - Method in interface org.refcodes.serial.ext.handshake.TransmissionTypeAccessor.TransmissionTypeProperty
-
This method stores and passes through the given argument, which is very useful for builder APIs: Sets the given
TransmissionType
(setter) as ofTransmissionTypeAccessor.TransmissionTypeMutator.setTransmissionType(TransmissionType)
and returns the very same value (getter).
N
- NOT_ACKNOWLEDGED - Enum constant in enum class org.refcodes.serial.ext.handshake.AcknowledgeMode
-
A transmission is not acknowledged, e.g.
O
- onPing(Runnable) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Registers a handler invoked upon incoming remote ping requests (via a remote's invocation of
HandshakePortController.ping()
or similar). - onReceiveSegment(SEGMENT) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- onReceiveSegment(SEGMENT, SegmentConsumer<SEGMENT>) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- onRequest(REQUEST) - Method in interface org.refcodes.serial.ext.handshake.RequestHandler
-
The
RequestHandler.onRequest(Segment)
method processes a request and produces a response. - onRequest(REQUEST, RequestHandler<REQUEST>) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Adds a
RequestHandler
for processing requests issued as ofHandshakePortController.requestSegment(Segment, Segment)
(and the like methods). - onSegment(SEGMENT, SegmentConsumer<SEGMENT>) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Adds a
SegmentConsumer
for receiving and handling transmissions. - open() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- open(PM) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- org.refcodes.serial.ext.handshake - module org.refcodes.serial.ext.handshake
- org.refcodes.serial.ext.handshake - package org.refcodes.serial.ext.handshake
-
This artifact extends the refcodes-serial artifact with handshake functionality as of the HandshakePortController type.
P
- ping() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Probes the connection by sending a "ping" to the attached remote station (
HandshakePortController
) expecting a "pong" reply within a timeout (shorter than the timeout of usual transmissions). - PING - Enum constant in enum class org.refcodes.serial.ext.handshake.TransmissionType
-
Identifies a simple ping request to be responded by a fire-and-forget pong (not to be acknowledged).
- pingWithin(long, int) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Probes the connection by sending a "ping" to the attached remote station (
HandshakePortController
) expecting a "pong" reply within a timeout (shorter than the timeout of usual transmissions). - PONG - Enum constant in enum class org.refcodes.serial.ext.handshake.AcknowledgeType
-
Identifies a a fire-and-forget pong (not to be acknowledged) reply in response to a simple ping request.
R
- receiveByte() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- receiveSegment(SEGMENT) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- receiveSegmentWithin(long, SEGMENT) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- replyRetryNumber - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- ReplyRetryNumberAccessor - Interface in org.refcodes.serial.ext.handshake
-
Provides an accessor for a reply retry number.
- ReplyRetryNumberAccessor.ReplyRetryNumberBuilder<B extends ReplyRetryNumberAccessor.ReplyRetryNumberBuilder<B>> - Interface in org.refcodes.serial.ext.handshake
-
Provides a builder method for a reply retry number returning the builder for applying multiple build operations.
- ReplyRetryNumberAccessor.ReplyRetryNumberMutator - Interface in org.refcodes.serial.ext.handshake
-
Provides a mutator for a reply retry number.
- ReplyRetryNumberAccessor.ReplyRetryNumberProperty - Interface in org.refcodes.serial.ext.handshake
-
Provides a reply retry number.A reply retry number is the overall number of retries to use when counting retries.
- replyTimeoutInMs - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- ReplyTimeoutMillisAccessor - Interface in org.refcodes.serial.ext.handshake
-
Provides an accessor for a reply timeout in milliseconds property.
- ReplyTimeoutMillisAccessor.ReplyTimeoutMillisBuilder<B extends ReplyTimeoutMillisAccessor.ReplyTimeoutMillisBuilder<B>> - Interface in org.refcodes.serial.ext.handshake
-
Provides a builder method for the reply timeout property returning the builder for applying multiple build operations.
- ReplyTimeoutMillisAccessor.ReplyTimeoutMillisMutator - Interface in org.refcodes.serial.ext.handshake
-
Provides a mutator for a reply timeout in milliseconds property.
- ReplyTimeoutMillisAccessor.ReplyTimeoutMillisProperty - Interface in org.refcodes.serial.ext.handshake
-
Provides a reply timeout in milliseconds property.
- REQUEST - Enum constant in enum class org.refcodes.serial.ext.handshake.TransmissionType
-
Identifies a request expecting a fire-and-forget response (no acknowledge to be sent for the succeeding response).
- REQUEST_DISMISSED - Enum constant in enum class org.refcodes.serial.ext.handshake.AcknowledgeType
-
Sent when a request was received but dismissed by a receiver .
- requestDismissedMagicBytes - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- RequestHandler<REQUEST extends org.refcodes.serial.Segment> - Interface in org.refcodes.serial.ext.handshake
-
A
RequestHandler
provides means to construct a responseSegment
in response to an incoming requestSegment
. - requestMagicBytes - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- requestSegment(REQUEST, RESPONSE) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Sends a request expecting a response.
- requestSegment(REQUEST, RESPONSE, boolean) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Sends a request expecting a response.
- requestSegmentWithin(long, REQUEST, RESPONSE) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Sends a request expecting a response.
- requestSegmentWithin(long, REQUEST, RESPONSE, boolean) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Sends a request expecting a response.
- RESPONSE - Enum constant in enum class org.refcodes.serial.ext.handshake.AcknowledgeType
-
A request is acknowledged by a response which in turn is acknowledged.
- RESPONSE - Enum constant in enum class org.refcodes.serial.ext.handshake.TransmissionType
-
Identifies a fire-and-forget response in reply to a request (no acknowledge to be sent for the response).
- responseAcknowledgeMagicBytes - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- responseMagicBytes - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
S
- SerialHandshakeSugar - Class in org.refcodes.serial.ext.handshake
-
Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the construction of various serial types such as
Segment
orSection
type instances (and the like). - SerialHandshakeSugar() - Constructor for class org.refcodes.serial.ext.handshake.SerialHandshakeSugar
-
Instantiates a new serial sugar.
- setAcknowledgeType(AcknowledgeType) - Method in interface org.refcodes.serial.ext.handshake.AcknowledgeTypeAccessor.AcknowledgeTypeMutator
-
Sets the
AcknowledgeType
for theAcknowledgeType
property. - setReplyRetryNumber(int) - Method in interface org.refcodes.serial.ext.handshake.ReplyRetryNumberAccessor.ReplyRetryNumberMutator
-
Sets the number of retries for the reply retry number.
- setReplyTimeoutMillis(long) - Method in interface org.refcodes.serial.ext.handshake.ReplyTimeoutMillisAccessor.ReplyTimeoutMillisMutator
-
The reply timeout attribute in milliseconds.
- setTransmissionType(TransmissionType) - Method in interface org.refcodes.serial.ext.handshake.TransmissionTypeAccessor.TransmissionTypeMutator
-
Sets the
TransmissionType
for theTransmissionType
property.
T
- toAcknowledgeType(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Determines the
AcknowledgeType
from the provided magic bytes. - toMagicBytes(AcknowledgeType) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Determines the magic bytes for the given
AcknowledgeType
. - toMagicBytes(TransmissionType) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Determines the magic bytes for the given
TransmissionType
. - toTransmissionType(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
-
Determines the
TransmissionType
from the provided magic bytes. - TRANSMISSION - Enum constant in enum class org.refcodes.serial.ext.handshake.TransmissionType
-
Identifies a fire-and-forget transmission (no acknowledge sent).
- TRANSMISSION_DISMISSED - Enum constant in enum class org.refcodes.serial.ext.handshake.AcknowledgeType
-
Sent in case a transmission was received and dismissed by a receiver.
- transmissionDismissedMagicBytes - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- transmissionMagicBytes - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- TransmissionType - Enum Class in org.refcodes.serial.ext.handshake
-
The
TransmissionType
defines the type of aTransmissionMessage
and therewith the mode of operation of a transmission process. - TransmissionTypeAccessor - Interface in org.refcodes.serial.ext.handshake
-
Provides an accessor for a
TransmissionType
property. - TransmissionTypeAccessor.TransmissionTypeBuilder<B extends TransmissionTypeAccessor.TransmissionTypeBuilder<B>> - Interface in org.refcodes.serial.ext.handshake
-
Provides a builder method for a
TransmissionType
property returning the builder for applying multiple build operations. - TransmissionTypeAccessor.TransmissionTypeMutator - Interface in org.refcodes.serial.ext.handshake
-
Provides a mutator for a
TransmissionType
property. - TransmissionTypeAccessor.TransmissionTypeProperty - Interface in org.refcodes.serial.ext.handshake
-
Provides a
TransmissionType
property. - transmitByte(byte) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- transmitBytes(byte[], int, int) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- transmitSegment(SEGMENT) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- transmitSegment(SEGMENT, boolean) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Transmits a
Segment
(and blocks this thread) till all it'sSequence
data (as ofTransmission.toSequence()
) has been sent. - transmitSegmentWithin(long, int, SEGMENT) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Transmits a
Segment
(and blocks this thread) till all it'sSequence
data (as ofTransmission.toSequence()
) has been sent. - transmitSequence(Sequence) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- transmitSequence(Sequence, boolean) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Transmits a
Sequence
(and blocks this thread) till all it's data (as ofTransmission.toSequence()
) has been sent. - transmitSequenceWithin(long, int, Sequence) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
-
Transmits a
Sequence
(and blocks this thread) till all it's data (as ofTransmission.toSequence()
) has been sent.
V
- valueOf(String) - Static method in enum class org.refcodes.serial.ext.handshake.AcknowledgeMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.refcodes.serial.ext.handshake.AcknowledgeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.refcodes.serial.ext.handshake.TransmissionType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.refcodes.serial.ext.handshake.AcknowledgeMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.refcodes.serial.ext.handshake.AcknowledgeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.refcodes.serial.ext.handshake.TransmissionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- withAcknowledgeableRequestMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Sets the according magic bytes.
- withAcknowledgeableResponseMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Sets the according magic bytes.
- withAcknowledgeableTransmissionMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Sets the according magic bytes.
- withAcknowledgeMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withAcknowledgeRetryNumber(int) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
- withAcknowledgeRetryNumber(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withAcknowledgeSegmentPackager(SegmentPackager) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withAcknowledgeTimeoutMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
- withAcknowledgeTimeoutMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withAcknowledgeType(AcknowledgeType) - Method in interface org.refcodes.serial.ext.handshake.AcknowledgeTypeAccessor.AcknowledgeTypeBuilder
-
Sets the
AcknowledgeType
for theAcknowledgeType
property. - withBlockSize(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withChecksumValidationMode(ChecksumValidationMode) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
- withChecksumValidationMode(ChecksumValidationMode) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withClearToSendMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withClearToSendSegmentPackager(SegmentPackager) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withClearToSendTimeoutMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withCrcAlgorithm(CrcAlgorithm) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
- withCrcAlgorithm(CrcAlgorithm) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withCrcChecksumConcatenateMode(ConcatenateMode) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withEncoding(Charset) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withEndianess(Endianess) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
- withEndianess(Endianess) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withEndOfStringByte(byte) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withEnquiryStandbyTimeMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withExecutorService(ExecutorService) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
-
Sets the according property for configuring the
HandshakePortController
upon invokingHandshakePortController.Builder.build()
. - withInboundQueueCapacity(int) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
-
Sets the queue capacity of unprocessed inbound messages.
- withIoHeuristicsTimeToLiveMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withLengthWidth(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withMagicBytesLength(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withOpen() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- withOpen(PM) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- withOpenUnchecked() - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- withOpenUnchecked(PM) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController
- withPacketLengthWidth(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
With packet length width.
- withPacketMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withPacketSegmentPackager(SegmentPackager) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withPingMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withPingRetryNumber(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withPingTimeoutMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withPongMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withPort(Port<PM>) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
-
Sets the according property for configuring the
HandshakePortController
upon invokingHandshakePortController.Builder.build()
. - withReadTimeoutMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withReadyToReceiveMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withReadyToReceiveRetryNumber(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withReadyToReceiveSegmentPackager(SegmentPackager) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withReadyToReceiveTimeoutMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withReadyToSendMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withReadyToSendRetryNumber(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withReadyToSendSegmentPackager(SegmentPackager) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withReadyToSendTimeoutMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withReplyRetryNumber(int) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
-
Sets the number of retries for the reply retry number.
- withReplyRetryNumber(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Sets the number of retries for the reply retry number.
- withReplyRetryNumber(int) - Method in interface org.refcodes.serial.ext.handshake.ReplyRetryNumberAccessor.ReplyRetryNumberBuilder
-
Sets the number of retries for the reply retry number.
- withReplyTimeoutMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
-
Sets the number for the reply timeout property.
- withReplyTimeoutMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Sets the number for the reply timeout property.
- withReplyTimeoutMillis(long) - Method in interface org.refcodes.serial.ext.handshake.ReplyTimeoutMillisAccessor.ReplyTimeoutMillisBuilder
-
Sets the number for the reply timeout property.
- withRequestDismissedMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Sets the according magic bytes.
- withRequestMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Sets the according magic bytes.
- withResponseAcknowledgeMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Sets the according magic bytes.
- withResponseMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Sets the according magic bytes.
- withSequenceNumberConcatenateMode(ConcatenateMode) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withSequenceNumberInitValue(int) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
- withSequenceNumberInitValue(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withSequenceNumberWidth(int) - Method in class org.refcodes.serial.ext.handshake.HandshakePortController.Builder
- withSequenceNumberWidth(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withTransmissionDismissedMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Sets the according magic bytes.
- withTransmissionMagicBytes(byte[]) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
-
Sets the according magic bytes.
- withTransmissionRetryNumber(int) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withTransmissionTimeoutMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
- withTransmissionType(TransmissionType) - Method in interface org.refcodes.serial.ext.handshake.TransmissionTypeAccessor.TransmissionTypeBuilder
-
Sets the
TransmissionType
for theTransmissionType
property. - withWriteTimeoutMillis(long) - Method in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics.Builder
_
- _replyRetryNumber - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
- _replyTimeoutInMs - Variable in class org.refcodes.serial.ext.handshake.HandshakeTransmissionMetrics
All Classes and Interfaces|All Packages