java.lang.Object
org.refcodes.serial.TransmissionMetrics
- All Implemented Interfaces:
org.refcodes.mixin.BlockSizeAccessor
,org.refcodes.mixin.EncodingAccessor<Charset>
,org.refcodes.mixin.ReadTimeoutMillisAccessor
,org.refcodes.mixin.WriteTimeoutMillisAccessor
,org.refcodes.numerical.ChecksumValidationModeAccessor
,org.refcodes.numerical.CrcAlgorithmAccessor
,org.refcodes.numerical.CrcChecksumConcatenateModeAccessor
,org.refcodes.numerical.EndianessAccessor
,AcknowledgeMagicBytesAccessor
,AcknowledgeRetryNumberAccessor
,AcknowledgeSegmentPackagerAccessor
,AcknowledgeTimeoutMillisAccessor
,ClearToSendMagicBytesAccessor
,ClearToSendSegmentPackagerAccessor
,ClearToSendTimeoutMillisAccessor
,EndOfStringByteAccessor
,EnquiryStandbyTimeMillisAccessor
,IoHeuristicsTimeToLiveMillisAccessor
,LengthWidthAccessor
,MagicBytesLengthAccessor
,PacketLengthWidthAccessor
,PacketMagicBytesAccessor
,PacketSegmentPackagerAccessor
,PingMagicBytesAccessor
,PingRetryNumberAccessor
,PingTimeoutMillisAccessor
,PongMagicBytesAccessor
,ReadyToReceiveMagicBytesAccessor
,ReadyToReceiveRetryNumberAccessor
,ReadyToReceiveSegmentPackagerAccessor
,ReadyToReceiveTimeoutMillisAccessor
,ReadyToSendMagicBytesAccessor
,ReadyToSendRetryNumberAccessor
,ReadyToSendSegmentPackagerAccessor
,ReadyToSendTimeoutMillisAccessor
,SequenceNumberConcatenateModeAccessor
,SequenceNumberInitValueAccessor
,SequenceNumberWidthAccessor
,TransmissionRetryNumberAccessor
,TransmissionTimeoutMillisAccessor
public class TransmissionMetrics
extends Object
implements AcknowledgeMagicBytesAccessor, AcknowledgeTimeoutMillisAccessor, AcknowledgeRetryNumberAccessor, TransmissionTimeoutMillisAccessor, TransmissionRetryNumberAccessor, LengthWidthAccessor, org.refcodes.numerical.CrcAlgorithmAccessor, org.refcodes.numerical.ChecksumValidationModeAccessor, org.refcodes.numerical.EndianessAccessor, org.refcodes.mixin.BlockSizeAccessor, SequenceNumberWidthAccessor, SequenceNumberInitValueAccessor, org.refcodes.mixin.ReadTimeoutMillisAccessor, org.refcodes.mixin.WriteTimeoutMillisAccessor, SequenceNumberConcatenateModeAccessor, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor, MagicBytesLengthAccessor, org.refcodes.mixin.EncodingAccessor<Charset>, AcknowledgeSegmentPackagerAccessor, PacketSegmentPackagerAccessor, ReadyToReceiveSegmentPackagerAccessor, ReadyToReceiveTimeoutMillisAccessor, ReadyToReceiveMagicBytesAccessor, ReadyToReceiveRetryNumberAccessor, EnquiryStandbyTimeMillisAccessor, ReadyToSendTimeoutMillisAccessor, ReadyToSendMagicBytesAccessor, ReadyToSendRetryNumberAccessor, ReadyToSendSegmentPackagerAccessor, ClearToSendTimeoutMillisAccessor, ClearToSendMagicBytesAccessor, ClearToSendSegmentPackagerAccessor, EndOfStringByteAccessor, PacketMagicBytesAccessor, PacketLengthWidthAccessor, PingMagicBytesAccessor, PingTimeoutMillisAccessor, PingRetryNumberAccessor, PongMagicBytesAccessor, IoHeuristicsTimeToLiveMillisAccessor
The
TransmissionMetrics
interface represents common parameters
required when configuring a transmission. Not all configuration parameters
may be required when applying the TransmissionMetrics
. This depends
on your setup of Segment
and/or Section
compositions. Usually
TransmissionMetrics
are applied to sub-classes of the type
Segment
and Section
.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.refcodes.serial.AcknowledgeMagicBytesAccessor
AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<B extends AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<B>>, AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesMutator, AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.AcknowledgeRetryNumberAccessor
AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<B extends AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<B>>, AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberMutator, AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.AcknowledgeSegmentPackagerAccessor
AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<B extends AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<B>>, AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerMutator, AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.AcknowledgeTimeoutMillisAccessor
AcknowledgeTimeoutMillisAccessor.AcknowledgeTimeoutMillisBuilder<B extends AcknowledgeTimeoutMillisAccessor.AcknowledgeTimeoutMillisBuilder<B>>, AcknowledgeTimeoutMillisAccessor.AcknowledgeTimeoutMillisMutator, AcknowledgeTimeoutMillisAccessor.AcknowledgeTimeoutMillisProperty
Nested classes/interfaces inherited from interface org.refcodes.mixin.BlockSizeAccessor
org.refcodes.mixin.BlockSizeAccessor.BlockSizeBuilder<B extends org.refcodes.mixin.BlockSizeAccessor.BlockSizeBuilder<B>>, org.refcodes.mixin.BlockSizeAccessor.BlockSizeMutator, org.refcodes.mixin.BlockSizeAccessor.BlockSizeProperty
Nested classes/interfaces inherited from interface org.refcodes.numerical.ChecksumValidationModeAccessor
org.refcodes.numerical.ChecksumValidationModeAccessor.ChecksumValidationModeBuilder<B extends org.refcodes.numerical.ChecksumValidationModeAccessor.ChecksumValidationModeBuilder<B>>, org.refcodes.numerical.ChecksumValidationModeAccessor.ChecksumValidationModeMutator, org.refcodes.numerical.ChecksumValidationModeAccessor.ChecksumValidationModeProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.ClearToSendMagicBytesAccessor
ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<B extends ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<B>>, ClearToSendMagicBytesAccessor.ClearToSendMagicBytesMutator, ClearToSendMagicBytesAccessor.ClearToSendMagicBytesProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.ClearToSendSegmentPackagerAccessor
ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B extends ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B>>, ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerMutator, ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.ClearToSendTimeoutMillisAccessor
ClearToSendTimeoutMillisAccessor.ClearToSendTimeoutMillisBuilder<B extends ClearToSendTimeoutMillisAccessor.ClearToSendTimeoutMillisBuilder<B>>, ClearToSendTimeoutMillisAccessor.ClearToSendTimeoutMillisMutator, ClearToSendTimeoutMillisAccessor.ClearToSendTimeoutMillisProperty
Nested classes/interfaces inherited from interface org.refcodes.numerical.CrcAlgorithmAccessor
org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<B extends org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<B>>, org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmMutator, org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmProperty
Nested classes/interfaces inherited from interface org.refcodes.numerical.CrcChecksumConcatenateModeAccessor
org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<B extends org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<B>>, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeMutator, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeProperty
Nested classes/interfaces inherited from interface org.refcodes.mixin.EncodingAccessor
org.refcodes.mixin.EncodingAccessor.EncodingBuilder<E extends Object,
B extends org.refcodes.mixin.EncodingAccessor.EncodingBuilder<E, B>>, org.refcodes.mixin.EncodingAccessor.EncodingMutator<E extends Object>, org.refcodes.mixin.EncodingAccessor.EncodingProperty<E extends Object> Nested classes/interfaces inherited from interface org.refcodes.numerical.EndianessAccessor
org.refcodes.numerical.EndianessAccessor.EndianessBuilder<B extends org.refcodes.numerical.EndianessAccessor.EndianessBuilder<B>>, org.refcodes.numerical.EndianessAccessor.EndianessMutator, org.refcodes.numerical.EndianessAccessor.EndianessProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.EndOfStringByteAccessor
EndOfStringByteAccessor.EndOfStringByteBuilder<B extends EndOfStringByteAccessor.EndOfStringByteBuilder<B>>, EndOfStringByteAccessor.EndOfStringByteMutator, EndOfStringByteAccessor.EndOfStringByteProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.EnquiryStandbyTimeMillisAccessor
EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisBuilder<B extends EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisBuilder<B>>, EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisMutator, EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.IoHeuristicsTimeToLiveMillisAccessor
IoHeuristicsTimeToLiveMillisAccessor.IoHeuristicsTimeToLiveMillisBuilder<B extends IoHeuristicsTimeToLiveMillisAccessor.IoHeuristicsTimeToLiveMillisBuilder<B>>, IoHeuristicsTimeToLiveMillisAccessor.IoHeuristicsTimeToLiveMillisMutator, IoHeuristicsTimeToLiveMillisAccessor.IoHeuristicsTimeToLiveMillisProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.LengthWidthAccessor
LengthWidthAccessor.LengthWidthBuilder<B extends LengthWidthAccessor.LengthWidthBuilder<B>>, LengthWidthAccessor.LengthWidthMutator, LengthWidthAccessor.LengthWidthProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.MagicBytesLengthAccessor
MagicBytesLengthAccessor.MagicBytesLengthBuilder<B extends MagicBytesLengthAccessor.MagicBytesLengthBuilder<B>>, MagicBytesLengthAccessor.MagicBytesLengthMutator, MagicBytesLengthAccessor.MagicBytesLengthProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.PacketLengthWidthAccessor
PacketLengthWidthAccessor.PacketLengthWidthBuilder<B extends PacketLengthWidthAccessor.PacketLengthWidthBuilder<B>>, PacketLengthWidthAccessor.PacketLengthWidthMutator, PacketLengthWidthAccessor.PacketLengthWidthProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.PacketMagicBytesAccessor
PacketMagicBytesAccessor.PacketMagicBytesBuilder<B extends PacketMagicBytesAccessor.PacketMagicBytesBuilder<B>>, PacketMagicBytesAccessor.PacketMagicBytesMutator, PacketMagicBytesAccessor.PacketMagicBytesProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.PacketSegmentPackagerAccessor
PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<B extends PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<B>>, PacketSegmentPackagerAccessor.PacketSegmentPackagerMutator, PacketSegmentPackagerAccessor.PacketSegmentPackagerProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.PingMagicBytesAccessor
PingMagicBytesAccessor.PingMagicBytesBuilder<B extends PingMagicBytesAccessor.PingMagicBytesBuilder<B>>, PingMagicBytesAccessor.PingMagicBytesMutator, PingMagicBytesAccessor.PingMagicBytesProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.PingRetryNumberAccessor
PingRetryNumberAccessor.PingRetryNumberBuilder<B extends PingRetryNumberAccessor.PingRetryNumberBuilder<B>>, PingRetryNumberAccessor.PingRetryNumberMutator, PingRetryNumberAccessor.PingRetryNumberProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.PingTimeoutMillisAccessor
PingTimeoutMillisAccessor.PingTimeoutMillisBuilder<B extends PingTimeoutMillisAccessor.PingTimeoutMillisBuilder<B>>, PingTimeoutMillisAccessor.PingTimeoutMillisMutator, PingTimeoutMillisAccessor.PingTimeoutMillisProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.PongMagicBytesAccessor
PongMagicBytesAccessor.PongMagicBytesBuilder<B extends PongMagicBytesAccessor.PongMagicBytesBuilder<B>>, PongMagicBytesAccessor.PongMagicBytesMutator, PongMagicBytesAccessor.PongMagicBytesProperty
Nested classes/interfaces inherited from interface org.refcodes.mixin.ReadTimeoutMillisAccessor
org.refcodes.mixin.ReadTimeoutMillisAccessor.ReadTimeoutMillisBuilder<B extends org.refcodes.mixin.ReadTimeoutMillisAccessor.ReadTimeoutMillisBuilder<B>>, org.refcodes.mixin.ReadTimeoutMillisAccessor.ReadTimeoutMillisMutator, org.refcodes.mixin.ReadTimeoutMillisAccessor.ReadTimeoutMillisProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.ReadyToReceiveMagicBytesAccessor
ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<B extends ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<B>>, ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesMutator, ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.ReadyToReceiveRetryNumberAccessor
ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<B extends ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<B>>, ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberMutator, ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.ReadyToReceiveSegmentPackagerAccessor
ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B extends ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B>>, ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerMutator, ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.ReadyToReceiveTimeoutMillisAccessor
ReadyToReceiveTimeoutMillisAccessor.ReadyToReceiveTimeoutMillisBuilder<B extends ReadyToReceiveTimeoutMillisAccessor.ReadyToReceiveTimeoutMillisBuilder<B>>, ReadyToReceiveTimeoutMillisAccessor.ReadyToReceiveTimeoutMillisMutator, ReadyToReceiveTimeoutMillisAccessor.ReadyToReceiveTimeoutMillisProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.ReadyToSendMagicBytesAccessor
ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<B extends ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<B>>, ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesMutator, ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.ReadyToSendRetryNumberAccessor
ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<B extends ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<B>>, ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberMutator, ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.ReadyToSendSegmentPackagerAccessor
ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B extends ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B>>, ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerMutator, ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.ReadyToSendTimeoutMillisAccessor
ReadyToSendTimeoutMillisAccessor.ReadyToSendTimeoutMillisBuilder<B extends ReadyToSendTimeoutMillisAccessor.ReadyToSendTimeoutMillisBuilder<B>>, ReadyToSendTimeoutMillisAccessor.ReadyToSendTimeoutMillisMutator, ReadyToSendTimeoutMillisAccessor.ReadyToSendTimeoutMillisProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.SequenceNumberConcatenateModeAccessor
SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<B extends SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<B>>, SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeMutator, SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.SequenceNumberInitValueAccessor
SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<B extends SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<B>>, SequenceNumberInitValueAccessor.SequenceNumberInitValueMutator, SequenceNumberInitValueAccessor.SequenceNumberInitValueProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.SequenceNumberWidthAccessor
SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<B extends SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<B>>, SequenceNumberWidthAccessor.SequenceNumberWidthMutator, SequenceNumberWidthAccessor.SequenceNumberWidthProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.TransmissionRetryNumberAccessor
TransmissionRetryNumberAccessor.TransmissionRetryNumberBuilder<B extends TransmissionRetryNumberAccessor.TransmissionRetryNumberBuilder<B>>, TransmissionRetryNumberAccessor.TransmissionRetryNumberMutator, TransmissionRetryNumberAccessor.TransmissionRetryNumberProperty
Nested classes/interfaces inherited from interface org.refcodes.serial.TransmissionTimeoutMillisAccessor
TransmissionTimeoutMillisAccessor.TransmissionTimeoutMillisBuilder<B extends TransmissionTimeoutMillisAccessor.TransmissionTimeoutMillisBuilder<B>>, TransmissionTimeoutMillisAccessor.TransmissionTimeoutMillisMutator, TransmissionTimeoutMillisAccessor.TransmissionTimeoutMillisProperty
Nested classes/interfaces inherited from interface org.refcodes.mixin.WriteTimeoutMillisAccessor
org.refcodes.mixin.WriteTimeoutMillisAccessor.WriteTimeoutMillisBuilder<B extends org.refcodes.mixin.WriteTimeoutMillisAccessor.WriteTimeoutMillisBuilder<B>>, org.refcodes.mixin.WriteTimeoutMillisAccessor.WriteTimeoutMillisMutator, org.refcodes.mixin.WriteTimeoutMillisAccessor.WriteTimeoutMillisProperty
-
Field Summary
Modifier and TypeFieldDescriptionprotected byte[]
protected int
protected SegmentPackager
protected long
protected int
protected org.refcodes.numerical.ChecksumValidationMode
protected byte[]
protected SegmentPackager
protected long
protected org.refcodes.numerical.CrcAlgorithm
protected org.refcodes.mixin.ConcatenateMode
protected Charset
protected org.refcodes.numerical.Endianess
protected byte
protected long
protected long
protected int
protected int
protected int
protected byte[]
protected SegmentPackager
protected byte[]
protected int
protected long
protected byte[]
protected long
protected byte[]
protected int
protected SegmentPackager
protected long
protected byte[]
protected int
protected SegmentPackager
protected long
protected org.refcodes.mixin.ConcatenateMode
protected int
protected int
protected int
protected long
protected long
static final byte[]
static final int
static final long
static final int
static final org.refcodes.numerical.ChecksumValidationMode
static final byte[]
static final long
static final org.refcodes.numerical.CrcAlgorithm
static final org.refcodes.mixin.ConcatenateMode
static final Charset
static final byte
static final org.refcodes.numerical.Endianess
static final long
static final long
static final byte[]
static final int
static final int
static final byte[]
static final int
static final long
static final long
static final byte[]
static final int
static final long
static final byte[]
static final int
static final long
static final org.refcodes.mixin.ConcatenateMode
static final int
static final int
static final int
static final long
static final int
static final long
-
Constructor Summary
ModifierConstructorDescriptionCreates an instance of theTransmissionMetrics
with default values being applied as defined in theTransmissionMetrics
type.protected
Instantiates a new transmission metrics. -
Method Summary
Modifier and TypeMethodDescriptionstatic TransmissionMetrics.Builder
builder()
Creates builder to buildTransmissionMetrics
.byte[]
Retrieves the magic bytes from the acknowledge magic bytes property.int
Retrieves the number of retries from the acknowledge retry number.Retrieves theSegmentPackager
ACK property.long
The acknowledge timeout attribute in milliseconds.int
org.refcodes.numerical.ChecksumValidationMode
byte[]
Retrieves the magic bytes from the CTS ("clear-to-send") magic bytes property.Retrieves theSegmentPackager
CTS ("clear-to-send") property.long
The CTS ("clear-to-send") timeout attribute in milliseconds.org.refcodes.numerical.CrcAlgorithm
org.refcodes.mixin.ConcatenateMode
org.refcodes.numerical.Endianess
byte
Retrieves the end of string byte from the end of string byte property.long
The ENQ ("enquiry") timeout attribute in milliseconds.long
The IO heuristics TTL (time to live) attribute in milliseconds.int
Retrieves the length width (in bytes) from the length width (in bytes) property.int
Retrieves the magic bytes length from the magic bytes magic bytes length property.int
Retrieves the packet length width (in bytes) from the packet length width (in bytes) property.byte[]
Retrieves the magic bytes from the packet magic bytes property.Retrieves theSegmentPackager
from the packetSegmentPackager
property.byte[]
Retrieves the magic bytes from the ping magic bytes property.int
Retrieves the number of retries from the ping retry number.long
The ping timeout attribute in milliseconds.byte[]
Retrieves the magic bytes from the pong magic bytes property.long
byte[]
Retrieves the magic bytes from the RTR ("ready-to-receive") magic bytes property.int
Retrieves the number of retries from the RTR ("ready-to-receive") retry number.Retrieves theSegmentPackager
RTR ("ready-to-receive") property.long
The RTR ("ready-to-receive") timeout attribute in milliseconds.byte[]
Retrieves the magic bytes from the RTS ("ready-to-send") magic bytes property.int
Retrieves the number of retries from the RTS ("ready-to-send") retry number.Retrieves theSegmentPackager
RTS ("ready-to-send") property.long
The RTS ("ready-to-send") timeout attribute in milliseconds.org.refcodes.mixin.ConcatenateMode
Retrieves theConcatenateMode
from the sequence numberConcatenateMode
property.int
Retrieves the sequence number initial value from the sequence number initial value property.int
Retrieves the sequence number width (in bytes) from the sequence number width (in bytes) property.int
Retrieves the number of retries from the transmission retry number.long
The transmission timeout attribute in milliseconds.long
Inferences the ACKSegmentPackager
.Inferences the packetSegmentPackager
.
-
Field Details
-
DEFAULT_ACKNOWLEDGE_MAGIC_BYTES
public static final byte[] DEFAULT_ACKNOWLEDGE_MAGIC_BYTES -
DEFAULT_CLEAR_TO_SEND_MAGIC_BYTES
public static final byte[] DEFAULT_CLEAR_TO_SEND_MAGIC_BYTES -
DEFAULT_PACKET_MAGIC_BYTES
public static final byte[] DEFAULT_PACKET_MAGIC_BYTES -
DEFAULT_LAST_PACKET_MAGIC_BYTES
public static final byte[] DEFAULT_LAST_PACKET_MAGIC_BYTES -
DEFAULT_READY_TO_RECEIVE_MAGIC_BYTES
public static final byte[] DEFAULT_READY_TO_RECEIVE_MAGIC_BYTES -
DEFAULT_READY_TO_SEND_MAGIC_BYTES
public static final byte[] DEFAULT_READY_TO_SEND_MAGIC_BYTES -
DEFAULT_ACKNOWLEDGE_RETRY_NUMBER
public static final int DEFAULT_ACKNOWLEDGE_RETRY_NUMBER -
DEFAULT_ACKNOWLEDGE_TIMEOUT_IN_MS
public static final long DEFAULT_ACKNOWLEDGE_TIMEOUT_IN_MS -
DEFAULT_PING_RETRY_NUMBER
public static final int DEFAULT_PING_RETRY_NUMBER -
DEFAULT_PING_TIMEOUT_IN_MS
public static final long DEFAULT_PING_TIMEOUT_IN_MS -
DEFAULT_BLOCK_SIZE
public static final int DEFAULT_BLOCK_SIZE- See Also:
-
DEFAULT_CLEAR_TO_SEND_TIMEOUT_IN_MS
public static final long DEFAULT_CLEAR_TO_SEND_TIMEOUT_IN_MS -
DEFAULT_CRC_ALGORITHM
public static final org.refcodes.numerical.CrcAlgorithm DEFAULT_CRC_ALGORITHM -
DEFAULT_CRC_CHECKSUM_CONCATENATE_MODE
public static final org.refcodes.mixin.ConcatenateMode DEFAULT_CRC_CHECKSUM_CONCATENATE_MODE -
DEFAULT_CHECKSUM_VALIDATION_MODE
public static final org.refcodes.numerical.ChecksumValidationMode DEFAULT_CHECKSUM_VALIDATION_MODE -
DEFAULT_ENCODING
-
DEFAULT_END_OF_STRING_BYTE
public static final byte DEFAULT_END_OF_STRING_BYTE- See Also:
-
DEFAULT_ENDIANESS
public static final org.refcodes.numerical.Endianess DEFAULT_ENDIANESS -
DEFAULT_ENQUIERY_STRANDBY_TIME_IN_MS
public static final long DEFAULT_ENQUIERY_STRANDBY_TIME_IN_MS- See Also:
-
DEFAULT_LENGTH_WIDTH
public static final int DEFAULT_LENGTH_WIDTH- See Also:
-
DEFAULT_TRUNCATE_LENGTH_WIDTH
public static final int DEFAULT_TRUNCATE_LENGTH_WIDTH- See Also:
-
DEFAULT_MAGIC_BYTES_LENGTH
public static final int DEFAULT_MAGIC_BYTES_LENGTH- See Also:
-
DEFAULT_READ_TIMEOUT_IN_MS
public static final long DEFAULT_READ_TIMEOUT_IN_MS -
DEFAULT_READY_TO_RECEIVE_RETRY_NUMBER
public static final int DEFAULT_READY_TO_RECEIVE_RETRY_NUMBER -
DEFAULT_READY_TO_RECEIVE_TIMEOUT_IN_MS
public static final long DEFAULT_READY_TO_RECEIVE_TIMEOUT_IN_MS -
DEFAULT_READY_TO_SEND_RETRY_NUMBER
public static final int DEFAULT_READY_TO_SEND_RETRY_NUMBER -
DEFAULT_READY_TO_SEND_TIMEOUT_IN_MS
public static final long DEFAULT_READY_TO_SEND_TIMEOUT_IN_MS -
DEFAULT_SEQUENCE_NUMBER_CONCATENATE_MODE
public static final org.refcodes.mixin.ConcatenateMode DEFAULT_SEQUENCE_NUMBER_CONCATENATE_MODE -
DEFAULT_SEQUENCE_NUMBER_INIT_VALUE
public static final int DEFAULT_SEQUENCE_NUMBER_INIT_VALUE- See Also:
-
DEFAULT_SEQUENCE_NUMBER_WIDTH
public static final int DEFAULT_SEQUENCE_NUMBER_WIDTH- See Also:
-
DEFAULT_TRANSMISSION_RETRY_NUMBER
public static final int DEFAULT_TRANSMISSION_RETRY_NUMBER -
DEFAULT_TRANSMISSION_TIMEOUT_IN_MS
public static final long DEFAULT_TRANSMISSION_TIMEOUT_IN_MS -
DEFAULT_WRITE_TIMEOUT_IN_MS
public static final long DEFAULT_WRITE_TIMEOUT_IN_MS -
DEFAULT_IO_HEURISTICS_TIME_TO_LIVE_IN_MS
public static final long DEFAULT_IO_HEURISTICS_TIME_TO_LIVE_IN_MS -
_acknowledgeMagicBytes
protected byte[] _acknowledgeMagicBytes -
_clearToSendMagicBytes
protected byte[] _clearToSendMagicBytes -
_packetMagicBytes
protected byte[] _packetMagicBytes -
_readyToReceiveMagicBytes
protected byte[] _readyToReceiveMagicBytes -
_readyToSendMagicBytes
protected byte[] _readyToSendMagicBytes -
_pingMagicBytes
protected byte[] _pingMagicBytes -
_pongMagicBytes
protected byte[] _pongMagicBytes -
_acknowledgeSegmentPackager
-
_acknowledgeRetryNumber
protected int _acknowledgeRetryNumber -
_acknowledgeTimeoutInMs
protected long _acknowledgeTimeoutInMs -
_pingRetryNumber
protected int _pingRetryNumber -
_pingTimeoutInMs
protected long _pingTimeoutInMs -
_blockSize
protected int _blockSize -
_checksumValidationMode
protected org.refcodes.numerical.ChecksumValidationMode _checksumValidationMode -
_clearToSendSegmentPackager
-
_clearToSendTimeoutInMs
protected long _clearToSendTimeoutInMs -
_crcAlgorithm
protected org.refcodes.numerical.CrcAlgorithm _crcAlgorithm -
_crcChecksumConcatenateMode
protected org.refcodes.mixin.ConcatenateMode _crcChecksumConcatenateMode -
_encoding
-
_endianess
protected org.refcodes.numerical.Endianess _endianess -
_endOfStringByte
protected byte _endOfStringByte -
_enquiryStandbyTimeInMs
protected long _enquiryStandbyTimeInMs -
_lengthWidth
protected int _lengthWidth -
_packetLengthWidth
protected int _packetLengthWidth -
_magicBytesLength
protected int _magicBytesLength -
_packetSegmentPackager
-
_readTimeoutInMs
protected long _readTimeoutInMs -
_readyToReceiveRetryNumber
protected int _readyToReceiveRetryNumber -
_readyToReceiveSegmentPackager
-
_readyToReceiveTimeoutInMs
protected long _readyToReceiveTimeoutInMs -
_readyToSendRetryNumber
protected int _readyToSendRetryNumber -
_readyToSendSegmentPackager
-
_readyToSendTimeoutInMs
protected long _readyToSendTimeoutInMs -
_sequenceNumberConcatenateMode
protected org.refcodes.mixin.ConcatenateMode _sequenceNumberConcatenateMode -
_sequenceNumberInitValue
protected int _sequenceNumberInitValue -
_sequenceNumberWidth
protected int _sequenceNumberWidth -
_transmissionRetryNumber
protected int _transmissionRetryNumber -
_transmissionTimeoutInMs
protected long _transmissionTimeoutInMs -
_writeTimeoutInMs
protected long _writeTimeoutInMs -
_ioHeuristicsTimeToLiveInMs
protected long _ioHeuristicsTimeToLiveInMs
-
-
Constructor Details
-
TransmissionMetrics
Instantiates a new transmission metrics.- Parameters:
aBuilder
- the builder
-
TransmissionMetrics
public TransmissionMetrics()Creates an instance of theTransmissionMetrics
with default values being applied as defined in theTransmissionMetrics
type.
-
-
Method Details
-
toAckSegmentPackager
Inferences the ACKSegmentPackager
. In case one is available as ofgetAcknowledgeSegmentPackager()
, then that is returned. Else CRC settings are evaluated and if possible sufficient CRC settings are available, aCrcSegmentPackager
is returned. If there are no sufficient CRC settings, then aSegmentPackager.DummySegmentPackager
is returned.- Returns:
- An interferenced
SegmentPackager
as of the instance's properties.
-
toPacketSegmentPackager
Inferences the packetSegmentPackager
. In case one is available as ofgetPacketSegmentPackager()
, then that is returned. Else CRC settings are evaluated and if possible sufficient CRC settings are available, aCrcSegmentPackager
is returned. If there are no sufficient CRC settings, then aSegmentPackager.DummySegmentPackager
is returned.- Returns:
- An interferenced
SegmentPackager
as of the instance's properties.
-
getPongMagicBytes
public byte[] getPongMagicBytes()Retrieves the magic bytes from the pong magic bytes property.- Specified by:
getPongMagicBytes
in interfacePongMagicBytesAccessor
- Returns:
- The magic bytes stored by the pong magic bytes property.
-
getPingMagicBytes
public byte[] getPingMagicBytes()Retrieves the magic bytes from the ping magic bytes property.- Specified by:
getPingMagicBytes
in interfacePingMagicBytesAccessor
- Returns:
- The magic bytes stored by the ping magic bytes property.
-
getPacketLengthWidth
public int getPacketLengthWidth()Retrieves the packet length width (in bytes) from the packet length width (in bytes) property.- Specified by:
getPacketLengthWidth
in interfacePacketLengthWidthAccessor
- Returns:
- The packet length width (in bytes) stored by the packet length width (in bytes) property.
-
getAcknowledgeMagicBytes
public byte[] getAcknowledgeMagicBytes()Retrieves the magic bytes from the acknowledge magic bytes property.- Specified by:
getAcknowledgeMagicBytes
in interfaceAcknowledgeMagicBytesAccessor
- Returns:
- The magic bytes stored by the acknowledge magic bytes property.
-
getAcknowledgeSegmentPackager
Retrieves theSegmentPackager
ACK property.- Specified by:
getAcknowledgeSegmentPackager
in interfaceAcknowledgeSegmentPackagerAccessor
- Returns:
- The
SegmentPackager
stored by the ACKSegmentPackager
property.
-
getAcknowledgeRetryNumber
public int getAcknowledgeRetryNumber()Retrieves the number of retries from the acknowledge retry number. A acknowledge retry number is the overall number of retries to use when counting retries.- Specified by:
getAcknowledgeRetryNumber
in interfaceAcknowledgeRetryNumberAccessor
- Returns:
- The number of retries stored by the acknowledge retry number.
-
getAcknowledgeTimeoutMillis
public long getAcknowledgeTimeoutMillis()The acknowledge timeout attribute in milliseconds.- Specified by:
getAcknowledgeTimeoutMillis
in interfaceAcknowledgeTimeoutMillisAccessor
- Returns:
- An long integer with the timeout in milliseconds.
-
getPingTimeoutMillis
public long getPingTimeoutMillis()The ping timeout attribute in milliseconds.- Specified by:
getPingTimeoutMillis
in interfacePingTimeoutMillisAccessor
- Returns:
- An long integer with the timeout in milliseconds.
-
getPingRetryNumber
public int getPingRetryNumber()Retrieves the number of retries from the ping retry number. A ping retry number is the overall number of retries to use when counting retries.- Specified by:
getPingRetryNumber
in interfacePingRetryNumberAccessor
- Returns:
- The number of retries stored by the ping retry number.
-
getBlockSize
public int getBlockSize()- Specified by:
getBlockSize
in interfaceorg.refcodes.mixin.BlockSizeAccessor
-
getClearToSendMagicBytes
public byte[] getClearToSendMagicBytes()Retrieves the magic bytes from the CTS ("clear-to-send") magic bytes property.- Specified by:
getClearToSendMagicBytes
in interfaceClearToSendMagicBytesAccessor
- Returns:
- The magic bytes stored by the CTS ("clear-to-send") magic bytes property.
-
getClearToSendSegmentPackager
Retrieves theSegmentPackager
CTS ("clear-to-send") property.- Specified by:
getClearToSendSegmentPackager
in interfaceClearToSendSegmentPackagerAccessor
- Returns:
- The
SegmentPackager
stored by the CTS ("clear-to-send")SegmentPackager
property.
-
getClearToSendTimeoutMillis
public long getClearToSendTimeoutMillis()The CTS ("clear-to-send") timeout attribute in milliseconds.- Specified by:
getClearToSendTimeoutMillis
in interfaceClearToSendTimeoutMillisAccessor
- Returns:
- An integer with the CTS ("clear-to-send") timeout in milliseconds.
-
getCrcAlgorithm
public org.refcodes.numerical.CrcAlgorithm getCrcAlgorithm()- Specified by:
getCrcAlgorithm
in interfaceorg.refcodes.numerical.CrcAlgorithmAccessor
-
getCrcChecksumConcatenateMode
public org.refcodes.mixin.ConcatenateMode getCrcChecksumConcatenateMode()- Specified by:
getCrcChecksumConcatenateMode
in interfaceorg.refcodes.numerical.CrcChecksumConcatenateModeAccessor
-
getChecksumValidationMode
public org.refcodes.numerical.ChecksumValidationMode getChecksumValidationMode()- Specified by:
getChecksumValidationMode
in interfaceorg.refcodes.numerical.ChecksumValidationModeAccessor
-
getEncoding
- Specified by:
getEncoding
in interfaceorg.refcodes.mixin.EncodingAccessor<Charset>
-
getEndianess
public org.refcodes.numerical.Endianess getEndianess()- Specified by:
getEndianess
in interfaceorg.refcodes.numerical.EndianessAccessor
-
getEndOfStringByte
public byte getEndOfStringByte()Retrieves the end of string byte from the end of string byte property.- Specified by:
getEndOfStringByte
in interfaceEndOfStringByteAccessor
- Returns:
- The end of string byte stored by the end of string byte property.
-
getEnquiryStandbyTimeMillis
public long getEnquiryStandbyTimeMillis()The ENQ ("enquiry") timeout attribute in milliseconds.- Specified by:
getEnquiryStandbyTimeMillis
in interfaceEnquiryStandbyTimeMillisAccessor
- Returns:
- An integer with the ENQ ("enquiry") timeout in milliseconds.
-
getLengthWidth
public int getLengthWidth()Retrieves the length width (in bytes) from the length width (in bytes) property.- Specified by:
getLengthWidth
in interfaceLengthWidthAccessor
- Returns:
- The length width (in bytes) stored by the length width (in bytes) property.
-
getMagicBytesLength
public int getMagicBytesLength()Retrieves the magic bytes length from the magic bytes magic bytes length property.- Specified by:
getMagicBytesLength
in interfaceMagicBytesLengthAccessor
- Returns:
- The magic bytes length stored by the magic bytes magic bytes length property.
-
getPacketMagicBytes
public byte[] getPacketMagicBytes()Retrieves the magic bytes from the packet magic bytes property.- Specified by:
getPacketMagicBytes
in interfacePacketMagicBytesAccessor
- Returns:
- The magic bytes stored by the packet magic bytes property.
-
getPacketSegmentPackager
Retrieves theSegmentPackager
from the packetSegmentPackager
property.- Specified by:
getPacketSegmentPackager
in interfacePacketSegmentPackagerAccessor
- Returns:
- The
SegmentPackager
stored by the packetSegmentPackager
property.
-
getReadTimeoutMillis
public long getReadTimeoutMillis()- Specified by:
getReadTimeoutMillis
in interfaceorg.refcodes.mixin.ReadTimeoutMillisAccessor
-
getReadyToReceiveMagicBytes
public byte[] getReadyToReceiveMagicBytes()Retrieves the magic bytes from the RTR ("ready-to-receive") magic bytes property.- Specified by:
getReadyToReceiveMagicBytes
in interfaceReadyToReceiveMagicBytesAccessor
- Returns:
- The magic bytes stored by the RTR ("ready-to-receive") magic bytes property.
-
getReadyToReceiveRetryNumber
public int getReadyToReceiveRetryNumber()Retrieves the number of retries from the RTR ("ready-to-receive") retry number. A RTR retry number is the overall number of retries to use when counting retries.- Specified by:
getReadyToReceiveRetryNumber
in interfaceReadyToReceiveRetryNumberAccessor
- Returns:
- The number of retries stored by the RTR ("ready-to-receive") retry number.
-
getReadyToReceiveSegmentPackager
Retrieves theSegmentPackager
RTR ("ready-to-receive") property.- Specified by:
getReadyToReceiveSegmentPackager
in interfaceReadyToReceiveSegmentPackagerAccessor
- Returns:
- The
SegmentPackager
stored by the RTR ("ready-to-receive")SegmentPackager
property.
-
getReadyToReceiveTimeoutMillis
public long getReadyToReceiveTimeoutMillis()The RTR ("ready-to-receive") timeout attribute in milliseconds.- Specified by:
getReadyToReceiveTimeoutMillis
in interfaceReadyToReceiveTimeoutMillisAccessor
- Returns:
- An integer with the RTR ("ready-to-receive") timeout in milliseconds.
-
getReadyToSendMagicBytes
public byte[] getReadyToSendMagicBytes()Retrieves the magic bytes from the RTS ("ready-to-send") magic bytes property.- Specified by:
getReadyToSendMagicBytes
in interfaceReadyToSendMagicBytesAccessor
- Returns:
- The magic bytes stored by the RTS ("ready-to-send") magic bytes property.
-
getReadyToSendRetryNumber
public int getReadyToSendRetryNumber()Retrieves the number of retries from the RTS ("ready-to-send") retry number. A RTS retry number is the overall number of retries to use when counting retries.- Specified by:
getReadyToSendRetryNumber
in interfaceReadyToSendRetryNumberAccessor
- Returns:
- The number of retries stored by the RTS ("ready-to-send") retry number.
-
getReadyToSendSegmentPackager
Retrieves theSegmentPackager
RTS ("ready-to-send") property.- Specified by:
getReadyToSendSegmentPackager
in interfaceReadyToSendSegmentPackagerAccessor
- Returns:
- The
SegmentPackager
stored by the RTS ("ready-to-send")SegmentPackager
property.
-
getReadyToSendTimeoutMillis
public long getReadyToSendTimeoutMillis()The RTS ("ready-to-send") timeout attribute in milliseconds.- Specified by:
getReadyToSendTimeoutMillis
in interfaceReadyToSendTimeoutMillisAccessor
- Returns:
- An integer with the RTS ("ready-to-send") timeout in milliseconds.
-
getSequenceNumberConcatenateMode
public org.refcodes.mixin.ConcatenateMode getSequenceNumberConcatenateMode()Retrieves theConcatenateMode
from the sequence numberConcatenateMode
property.- Specified by:
getSequenceNumberConcatenateMode
in interfaceSequenceNumberConcatenateModeAccessor
- Returns:
- The
ConcatenateMode
stored by the sequence numberConcatenateMode
property.
-
getSequenceNumberInitValue
public int getSequenceNumberInitValue()Retrieves the sequence number initial value from the sequence number initial value property.- Specified by:
getSequenceNumberInitValue
in interfaceSequenceNumberInitValueAccessor
- Returns:
- The sequence number initial value stored by the sequence number initial value property.
-
getSequenceNumberWidth
public int getSequenceNumberWidth()Retrieves the sequence number width (in bytes) from the sequence number width (in bytes) property.- Specified by:
getSequenceNumberWidth
in interfaceSequenceNumberWidthAccessor
- Returns:
- The sequence number width (in bytes) stored by the sequence number width (in bytes) property.
-
getTransmissionRetryNumber
public int getTransmissionRetryNumber()Retrieves the number of retries from the transmission retry number. A transmission retry number is the overall number of retries to use when counting retries.- Specified by:
getTransmissionRetryNumber
in interfaceTransmissionRetryNumberAccessor
- Returns:
- The number of retries stored by the transmission retry number.
-
getTransmissionTimeoutMillis
public long getTransmissionTimeoutMillis()The transmission timeout attribute in milliseconds.- Specified by:
getTransmissionTimeoutMillis
in interfaceTransmissionTimeoutMillisAccessor
- Returns:
- An long integer with the timeout in milliseconds.
-
getWriteTimeoutMillis
public long getWriteTimeoutMillis()- Specified by:
getWriteTimeoutMillis
in interfaceorg.refcodes.mixin.WriteTimeoutMillisAccessor
-
getIoHeuristicsTimeToLiveMillis
public long getIoHeuristicsTimeToLiveMillis()The IO heuristics TTL (time to live) attribute in milliseconds.- Specified by:
getIoHeuristicsTimeToLiveMillis
in interfaceIoHeuristicsTimeToLiveMillisAccessor
- Returns:
- An integer with the in milliseconds.
-
builder
Creates builder to buildTransmissionMetrics
.- Returns:
- created builder
-