Module org.refcodes.serial

Package org.refcodes.serial

Class TransmissionMetrics.Builder

java.lang.Object

org.refcodes.serial.TransmissionMetrics.Builder

All Implemented Interfaces:

org.refcodes.mixin.BlockSizeAccessor.BlockSizeBuilder<TransmissionMetrics.Builder>, org.refcodes.mixin.EncodingAccessor.EncodingBuilder<Charset,TransmissionMetrics.Builder>, org.refcodes.mixin.ReadTimeoutMillisAccessor.ReadTimeoutMillisBuilder<TransmissionMetrics.Builder>, org.refcodes.mixin.WriteTimeoutMillisAccessor.WriteTimeoutMillisBuilder<TransmissionMetrics.Builder>, org.refcodes.numerical.ChecksumValidationModeAccessor.ChecksumValidationModeBuilder<TransmissionMetrics.Builder>, org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<TransmissionMetrics.Builder>, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<TransmissionMetrics.Builder>, org.refcodes.numerical.EndianessAccessor.EndianessBuilder<TransmissionMetrics.Builder>, AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<TransmissionMetrics.Builder>, AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<TransmissionMetrics.Builder>, AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<TransmissionMetrics.Builder>, AcknowledgeTimeoutMillisAccessor.AcknowledgeTimeoutMillisBuilder<TransmissionMetrics.Builder>, ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<TransmissionMetrics.Builder>, ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<TransmissionMetrics.Builder>, ClearToSendTimeoutMillisAccessor.ClearToSendTimeoutMillisBuilder<TransmissionMetrics.Builder>, EndOfStringByteAccessor.EndOfStringByteBuilder<TransmissionMetrics.Builder>, EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisBuilder<TransmissionMetrics.Builder>, IoHeuristicsTimeToLiveMillisAccessor.IoHeuristicsTimeToLiveMillisBuilder<TransmissionMetrics.Builder>, LengthWidthAccessor.LengthWidthBuilder<TransmissionMetrics.Builder>, MagicBytesLengthAccessor.MagicBytesLengthBuilder<TransmissionMetrics.Builder>, PacketLengthWidthAccessor.PacketLengthWidthBuilder<TransmissionMetrics.Builder>, PacketMagicBytesAccessor.PacketMagicBytesBuilder<TransmissionMetrics.Builder>, PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<TransmissionMetrics.Builder>, PingMagicBytesAccessor.PingMagicBytesBuilder<TransmissionMetrics.Builder>, PingRetryNumberAccessor.PingRetryNumberBuilder<TransmissionMetrics.Builder>, PingTimeoutMillisAccessor.PingTimeoutMillisBuilder<TransmissionMetrics.Builder>, PongMagicBytesAccessor.PongMagicBytesBuilder<TransmissionMetrics.Builder>, ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<TransmissionMetrics.Builder>, ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<TransmissionMetrics.Builder>, ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<TransmissionMetrics.Builder>, ReadyToReceiveTimeoutMillisAccessor.ReadyToReceiveTimeoutMillisBuilder<TransmissionMetrics.Builder>, ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<TransmissionMetrics.Builder>, ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<TransmissionMetrics.Builder>, ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<TransmissionMetrics.Builder>, ReadyToSendTimeoutMillisAccessor.ReadyToSendTimeoutMillisBuilder<TransmissionMetrics.Builder>, SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<TransmissionMetrics.Builder>, SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<TransmissionMetrics.Builder>, SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<TransmissionMetrics.Builder>, TransmissionRetryNumberAccessor.TransmissionRetryNumberBuilder<TransmissionMetrics.Builder>, TransmissionTimeoutMillisAccessor.TransmissionTimeoutMillisBuilder<TransmissionMetrics.Builder>

Enclosing class:

TransmissionMetrics

public static class TransmissionMetrics.Builder
extends Object
implements AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<TransmissionMetrics.Builder>, AcknowledgeTimeoutMillisAccessor.AcknowledgeTimeoutMillisBuilder<TransmissionMetrics.Builder>, AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<TransmissionMetrics.Builder>, TransmissionTimeoutMillisAccessor.TransmissionTimeoutMillisBuilder<TransmissionMetrics.Builder>, TransmissionRetryNumberAccessor.TransmissionRetryNumberBuilder<TransmissionMetrics.Builder>, LengthWidthAccessor.LengthWidthBuilder<TransmissionMetrics.Builder>, org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<TransmissionMetrics.Builder>, org.refcodes.numerical.ChecksumValidationModeAccessor.ChecksumValidationModeBuilder<TransmissionMetrics.Builder>, org.refcodes.numerical.EndianessAccessor.EndianessBuilder<TransmissionMetrics.Builder>, org.refcodes.mixin.BlockSizeAccessor.BlockSizeBuilder<TransmissionMetrics.Builder>, SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<TransmissionMetrics.Builder>, SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<TransmissionMetrics.Builder>, org.refcodes.mixin.ReadTimeoutMillisAccessor.ReadTimeoutMillisBuilder<TransmissionMetrics.Builder>, org.refcodes.mixin.WriteTimeoutMillisAccessor.WriteTimeoutMillisBuilder<TransmissionMetrics.Builder>, SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<TransmissionMetrics.Builder>, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<TransmissionMetrics.Builder>, MagicBytesLengthAccessor.MagicBytesLengthBuilder<TransmissionMetrics.Builder>, org.refcodes.mixin.EncodingAccessor.EncodingBuilder<Charset,TransmissionMetrics.Builder>, AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<TransmissionMetrics.Builder>, PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<TransmissionMetrics.Builder>, ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<TransmissionMetrics.Builder>, ReadyToReceiveTimeoutMillisAccessor.ReadyToReceiveTimeoutMillisBuilder<TransmissionMetrics.Builder>, ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<TransmissionMetrics.Builder>, ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<TransmissionMetrics.Builder>, EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisBuilder<TransmissionMetrics.Builder>, ReadyToSendTimeoutMillisAccessor.ReadyToSendTimeoutMillisBuilder<TransmissionMetrics.Builder>, ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<TransmissionMetrics.Builder>, ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<TransmissionMetrics.Builder>, ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<TransmissionMetrics.Builder>, ClearToSendTimeoutMillisAccessor.ClearToSendTimeoutMillisBuilder<TransmissionMetrics.Builder>, ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<TransmissionMetrics.Builder>, ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<TransmissionMetrics.Builder>, EndOfStringByteAccessor.EndOfStringByteBuilder<TransmissionMetrics.Builder>, PacketMagicBytesAccessor.PacketMagicBytesBuilder<TransmissionMetrics.Builder>, PacketLengthWidthAccessor.PacketLengthWidthBuilder<TransmissionMetrics.Builder>, PingMagicBytesAccessor.PingMagicBytesBuilder<TransmissionMetrics.Builder>, PingRetryNumberAccessor.PingRetryNumberBuilder<TransmissionMetrics.Builder>, PingTimeoutMillisAccessor.PingTimeoutMillisBuilder<TransmissionMetrics.Builder>, PongMagicBytesAccessor.PongMagicBytesBuilder<TransmissionMetrics.Builder>, IoHeuristicsTimeToLiveMillisAccessor.IoHeuristicsTimeToLiveMillisBuilder<TransmissionMetrics.Builder>

Builder to build TransmissionMetrics.

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	acknowledgeMagicBytes
protected int	acknowledgeRetryNumber
protected SegmentPackager	acknowledgeSegmentPackager
protected long	acknowledgeTimeoutInMs
protected int	blockSize
protected org.refcodes.numerical.ChecksumValidationMode	checksumValidationMode
protected byte[]	clearToSendMagicBytes
protected SegmentPackager	clearToSendSegmentPackager
protected long	clearToSendTimeoutInMs
protected org.refcodes.numerical.CrcAlgorithm	crcAlgorithm
protected org.refcodes.mixin.ConcatenateMode	crcChecksumConcatenateMode
protected Charset	encoding
protected org.refcodes.numerical.Endianess	endianess
protected byte	endOfStringByte
protected long	enquiryStandbyTimeInMs
protected long	ioHeuristicsTimeToLiveInMs
protected int	lengthWidth
protected int	magicBytesLength
protected int	packetLengthWidth
protected byte[]	packetMagicBytes
protected SegmentPackager	packetSegmentPackager
protected byte[]	pingMagicBytes
protected int	pingRetryNumber
protected long	pingTimeoutInMs
protected byte[]	pongMagicBytes
protected long	readTimeoutInMs
protected byte[]	readyToReceiveMagicBytes
protected int	readyToReceiveRetryNumber
protected SegmentPackager	readyToReceiveSegmentPackager
protected long	readyToReceiveTimeoutInMs
protected byte[]	readyToSendMagicBytes
protected int	readyToSendRetryNumber
protected SegmentPackager	readyToSendSegmentPackager
protected long	readyToSendTimeoutInMs
protected org.refcodes.mixin.ConcatenateMode	sequenceNumberConcatenateMode
protected int	sequenceNumberInitValue
protected int	sequenceNumberWidth
protected int	transmissionRetryNumber
protected long	transmissionTimeoutInMs
protected long	writeTimeoutInMs

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Instantiates a new builder.

Method Summary

Modifier and Type	Method	Description
TransmissionMetrics	build()	Builds the TransmissionMetrics instance from this builder's settings.
TransmissionMetrics.Builder	withAcknowledgeMagicBytes(byte[] aAcknowledgeMagicBytes)	Sets the magic bytes for the acknowledge magic bytes property.
TransmissionMetrics.Builder	withAcknowledgeRetryNumber(int aAcknowledgeRetryNumber)	Sets the number of retries for the acknowledge retry number.
TransmissionMetrics.Builder	withAcknowledgeSegmentPackager(SegmentPackager aAcknowledgeSegmentPackager)	Sets the SegmentPackager ACK property.
TransmissionMetrics.Builder	withAcknowledgeTimeoutMillis(long aAcknowledgeTimeoutInMs)	Sets the number for the acknowledge timeout property.
TransmissionMetrics.Builder	withBlockSize(int aBlockSize)
TransmissionMetrics.Builder	withChecksumValidationMode(org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)
TransmissionMetrics.Builder	withClearToSendMagicBytes(byte[] aClearToSendMagicBytes)	Sets the magic bytes for the CTS ("clear-to-send") magic bytes property.
TransmissionMetrics.Builder	withClearToSendSegmentPackager(SegmentPackager aClearToSendSegmentPackager)	Sets the SegmentPackager CTS ("clear-to-send") property.
TransmissionMetrics.Builder	withClearToSendTimeoutMillis(long aClearToSendTimeoutInMs)	Sets the number for the CTS ("clear-to-send") timeout property.
TransmissionMetrics.Builder	withCrcAlgorithm(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
TransmissionMetrics.Builder	withCrcChecksumConcatenateMode(org.refcodes.mixin.ConcatenateMode aChecksumConcatenateMode)
TransmissionMetrics.Builder	withEncoding(Charset aEncoding)
TransmissionMetrics.Builder	withEndianess(org.refcodes.numerical.Endianess aEndianess)
TransmissionMetrics.Builder	withEndOfStringByte(byte aEndOfStringByte)	Sets the end of string byte for the end of string byte property.
TransmissionMetrics.Builder	withEnquiryStandbyTimeMillis(long aEnquiryStandbyTimeInMs)	Sets the number for the ENQ ("enquiry") timeout property.
TransmissionMetrics.Builder	withIoHeuristicsTimeToLiveMillis(long aIoHeuristicsTimeToLiveInMs)	Sets the number for the IO heuristics TTL (time to live) property.
TransmissionMetrics.Builder	withLengthWidth(int aLengthWidth)	Sets the length width (in bytes) for the length width (in bytes) property.
TransmissionMetrics.Builder	withMagicBytesLength(int aMagicBytesLength)	Sets the magic bytes length for the magic bytes magic bytes length property.
TransmissionMetrics.Builder	withPacketLengthWidth(int aPacketLengthWidth)	With packet length width.
TransmissionMetrics.Builder	withPacketMagicBytes(byte[] aPacketMagicBytes)	Sets the magic bytes for the packet magic bytes property.
TransmissionMetrics.Builder	withPacketSegmentPackager(SegmentPackager aPacketSegmentPackager)	Sets the SegmentPackager for the packet SegmentPackager property.
TransmissionMetrics.Builder	withPingMagicBytes(byte[] aPingMagicBytes)	Sets the magic bytes for the ping magic bytes property.
TransmissionMetrics.Builder	withPingRetryNumber(int aPingRetryNumber)	Sets the number of retries for the ping retry number.
TransmissionMetrics.Builder	withPingTimeoutMillis(long aPingTimeoutInMs)	Sets the number for the ping timeout property.
TransmissionMetrics.Builder	withPongMagicBytes(byte[] aPongMagicBytes)	Sets the magic bytes for the pong magic bytes property.
TransmissionMetrics.Builder	withReadTimeoutMillis(long aReadTimeoutInMs)
TransmissionMetrics.Builder	withReadyToReceiveMagicBytes(byte[] aReadyToReceiveMagicBytes)	Sets the magic bytes for the RTR ("ready-to-receive") magic bytes property.
TransmissionMetrics.Builder	withReadyToReceiveRetryNumber(int aReadyToReceiveRetryNumber)	Sets the number of retries for the RTR ("ready-to-receive") retry number.
TransmissionMetrics.Builder	withReadyToReceiveSegmentPackager(SegmentPackager aReadyToReceiveSegmentPackager)	Sets the SegmentPackager RTR ("ready-to-receive") property.
TransmissionMetrics.Builder	withReadyToReceiveTimeoutMillis(long aReadyToReceiveTimeoutInMs)	Sets the number for the RTR ("ready-to-receive") timeout property.
TransmissionMetrics.Builder	withReadyToSendMagicBytes(byte[] aReadyToSendMagicBytes)	Sets the magic bytes for the RTS ("ready-to-send") magic bytes property.
TransmissionMetrics.Builder	withReadyToSendRetryNumber(int aReadyToSendRetryNumber)	Sets the number of retries for the RTS ("ready-to-send") retry number.
TransmissionMetrics.Builder	withReadyToSendSegmentPackager(SegmentPackager aReadyToSendSegmentPackager)	Sets the SegmentPackager RTS ("ready-to-send") property.
TransmissionMetrics.Builder	withReadyToSendTimeoutMillis(long aReadyToSendTimeoutInMs)	Sets the number for the RTS ("ready-to-send") timeout property.
TransmissionMetrics.Builder	withSequenceNumberConcatenateMode(org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode)	Sets the ConcatenateMode for the sequence number ConcatenateMode property.
TransmissionMetrics.Builder	withSequenceNumberInitValue(int aSequenceNumberInitValue)	Sets the sequence number initial value for the sequence number initial value property.
TransmissionMetrics.Builder	withSequenceNumberWidth(int aSequenceNumberWidth)	Sets the sequence number width (in bytes) for the sequence number width (in bytes) property.
TransmissionMetrics.Builder	withTransmissionRetryNumber(int aTransmissionRetryNumber)	Sets the number of retries for the transmission retry number.
TransmissionMetrics.Builder	withTransmissionTimeoutMillis(long aTransmissionTimeoutInMs)	Sets the number for the transmission timeout property.
TransmissionMetrics.Builder	withWriteTimeoutMillis(long aWriteTimeoutInMs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.serial.AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder

withAcknowledgeMagicBytes, withAcknowledgeMagicBytes

Methods inherited from interface org.refcodes.serial.PacketMagicBytesAccessor.PacketMagicBytesBuilder

withPacketMagicBytes, withPacketMagicBytes

Methods inherited from interface org.refcodes.serial.PingMagicBytesAccessor.PingMagicBytesBuilder

withPingMagicBytes, withPingMagicBytes

Methods inherited from interface org.refcodes.serial.PongMagicBytesAccessor.PongMagicBytesBuilder

withPongMagicBytes, withPongMagicBytes

Field Details

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

protected SegmentPackager acknowledgeSegmentPackager

acknowledgeTimeoutInMs

protected long acknowledgeTimeoutInMs

acknowledgeRetryNumber

protected int acknowledgeRetryNumber

pingTimeoutInMs

protected long pingTimeoutInMs

pingRetryNumber

protected int pingRetryNumber

blockSize

protected int blockSize

clearToSendSegmentPackager

protected SegmentPackager clearToSendSegmentPackager

clearToSendTimeoutInMs

protected long clearToSendTimeoutInMs

crcAlgorithm

protected org.refcodes.numerical.CrcAlgorithm crcAlgorithm

crcChecksumConcatenateMode

protected org.refcodes.mixin.ConcatenateMode crcChecksumConcatenateMode

checksumValidationMode

protected org.refcodes.numerical.ChecksumValidationMode checksumValidationMode

encoding

protected Charset 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

protected SegmentPackager packetSegmentPackager

readTimeoutInMs

protected long readTimeoutInMs

readyToReceiveRetryNumber

protected int readyToReceiveRetryNumber

readyToReceiveSegmentPackager

protected SegmentPackager readyToReceiveSegmentPackager

readyToReceiveTimeoutInMs

protected long readyToReceiveTimeoutInMs

readyToSendRetryNumber

protected int readyToSendRetryNumber

readyToSendSegmentPackager

protected SegmentPackager 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

Builder

protected Builder()

Instantiates a new builder.

Method Details

withAcknowledgeMagicBytes

public TransmissionMetrics.Builder withAcknowledgeMagicBytes(byte[] aAcknowledgeMagicBytes)

Sets the magic bytes for the acknowledge magic bytes property.

Specified by:

withAcknowledgeMagicBytes in interface AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<TransmissionMetrics.Builder>

Parameters:

aAcknowledgeMagicBytes - The magic bytes to be stored by the acknowledge magic bytes property.

Returns:

The builder for applying multiple build operations.

withClearToSendMagicBytes

public TransmissionMetrics.Builder withClearToSendMagicBytes(byte[] aClearToSendMagicBytes)

Sets the magic bytes for the CTS ("clear-to-send") magic bytes property.

Specified by:

withClearToSendMagicBytes in interface ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<TransmissionMetrics.Builder>

Parameters:

aClearToSendMagicBytes - The magic bytes to be stored by the CTS ("clear-to-send") magic bytes property.

Returns:

The builder for applying multiple build operations.

withPacketMagicBytes

public TransmissionMetrics.Builder withPacketMagicBytes(byte[] aPacketMagicBytes)

Sets the magic bytes for the packet magic bytes property.

Specified by:

withPacketMagicBytes in interface PacketMagicBytesAccessor.PacketMagicBytesBuilder<TransmissionMetrics.Builder>

Parameters:

aPacketMagicBytes - The magic bytes to be stored by the packet magic bytes property.

Returns:

The builder for applying multiple build operations.

withReadyToReceiveMagicBytes

public TransmissionMetrics.Builder withReadyToReceiveMagicBytes(byte[] aReadyToReceiveMagicBytes)

Sets the magic bytes for the RTR ("ready-to-receive") magic bytes property.

Specified by:

withReadyToReceiveMagicBytes in interface ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<TransmissionMetrics.Builder>

Parameters:

aReadyToReceiveMagicBytes - The magic bytes to be stored by the RTR ("ready-to-receive") magic bytes property.

Returns:

The builder for applying multiple build operations.

withReadyToSendMagicBytes

public TransmissionMetrics.Builder withReadyToSendMagicBytes(byte[] aReadyToSendMagicBytes)

Sets the magic bytes for the RTS ("ready-to-send") magic bytes property.

Specified by:

withReadyToSendMagicBytes in interface ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<TransmissionMetrics.Builder>

Parameters:

aReadyToSendMagicBytes - The magic bytes to be stored by the RTS ("ready-to-send") magic bytes property.

Returns:

The builder for applying multiple build operations.

withAcknowledgeSegmentPackager

public TransmissionMetrics.Builder withAcknowledgeSegmentPackager(SegmentPackager aAcknowledgeSegmentPackager)

Sets the SegmentPackager ACK property.

Specified by:

withAcknowledgeSegmentPackager in interface AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<TransmissionMetrics.Builder>

Parameters:

aAcknowledgeSegmentPackager - The SegmentPackager to be stored by the SegmentPackager ACK property.

Returns:

The builder for applying multiple build operations.

withAcknowledgeRetryNumber

public TransmissionMetrics.Builder withAcknowledgeRetryNumber(int aAcknowledgeRetryNumber)

Sets the number of retries for the acknowledge retry number. A acknowledge retry number is the overall number of retries to use when counting retries.

Specified by:

withAcknowledgeRetryNumber in interface AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<TransmissionMetrics.Builder>

Parameters:

aAcknowledgeRetryNumber - The number of retries to be stored by the number of acknowledge retry number.

Returns:

The builder for applying multiple build operations.

withAcknowledgeTimeoutMillis

public TransmissionMetrics.Builder withAcknowledgeTimeoutMillis(long aAcknowledgeTimeoutInMs)

Sets the number for the acknowledge timeout property.

Specified by:

withAcknowledgeTimeoutMillis in interface AcknowledgeTimeoutMillisAccessor.AcknowledgeTimeoutMillisBuilder<TransmissionMetrics.Builder>

Parameters:

aAcknowledgeTimeoutInMs - The acknowledge timeout in milliseconds to be stored by the acknowledge timeout property.

Returns:

The builder for applying multiple build operations.

withPingRetryNumber

public TransmissionMetrics.Builder withPingRetryNumber(int aPingRetryNumber)

Sets the number of retries for the ping retry number. A ping retry number is the overall number of retries to use when counting retries.

Specified by:

withPingRetryNumber in interface PingRetryNumberAccessor.PingRetryNumberBuilder<TransmissionMetrics.Builder>

Parameters:

aPingRetryNumber - The number of retries to be stored by the number of ping retry number.

Returns:

The builder for applying multiple build operations.

withPingTimeoutMillis

public TransmissionMetrics.Builder withPingTimeoutMillis(long aPingTimeoutInMs)

Sets the number for the ping timeout property.

Specified by:

withPingTimeoutMillis in interface PingTimeoutMillisAccessor.PingTimeoutMillisBuilder<TransmissionMetrics.Builder>

Parameters:

aPingTimeoutInMs - The ping timeout in milliseconds to be stored by the ping timeout property.

Returns:

The builder for applying multiple build operations.

withBlockSize

public TransmissionMetrics.Builder withBlockSize(int aBlockSize)

Specified by:

withBlockSize in interface org.refcodes.mixin.BlockSizeAccessor.BlockSizeBuilder<TransmissionMetrics.Builder>

withChecksumValidationMode

public TransmissionMetrics.Builder withChecksumValidationMode(org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)

Specified by:

withChecksumValidationMode in interface org.refcodes.numerical.ChecksumValidationModeAccessor.ChecksumValidationModeBuilder<TransmissionMetrics.Builder>

withClearToSendSegmentPackager

public TransmissionMetrics.Builder withClearToSendSegmentPackager(SegmentPackager aClearToSendSegmentPackager)

Sets the SegmentPackager CTS ("clear-to-send") property.

Specified by:

withClearToSendSegmentPackager in interface ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<TransmissionMetrics.Builder>

Parameters:

aClearToSendSegmentPackager - The SegmentPackager to be stored by the SegmentPackager CTS ("clear-to-send") property.

Returns:

The builder for applying multiple build operations.

withClearToSendTimeoutMillis

public TransmissionMetrics.Builder withClearToSendTimeoutMillis(long aClearToSendTimeoutInMs)

Sets the number for the CTS ("clear-to-send") timeout property.

Specified by:

withClearToSendTimeoutMillis in interface ClearToSendTimeoutMillisAccessor.ClearToSendTimeoutMillisBuilder<TransmissionMetrics.Builder>

Parameters:

aClearToSendTimeoutInMs - The CTS ("clear-to-send") timeout in milliseconds to be stored by the CTS timeout property.

Returns:

The builder for applying multiple build operations.

withCrcAlgorithm

public TransmissionMetrics.Builder withCrcAlgorithm(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)

Specified by:

withCrcAlgorithm in interface org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<TransmissionMetrics.Builder>

withCrcChecksumConcatenateMode

public TransmissionMetrics.Builder withCrcChecksumConcatenateMode(org.refcodes.mixin.ConcatenateMode aChecksumConcatenateMode)

Specified by:

withCrcChecksumConcatenateMode in interface org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<TransmissionMetrics.Builder>

withEncoding

public TransmissionMetrics.Builder withEncoding(Charset aEncoding)

Specified by:

withEncoding in interface org.refcodes.mixin.EncodingAccessor.EncodingBuilder<Charset,TransmissionMetrics.Builder>

withEndianess

public TransmissionMetrics.Builder withEndianess(org.refcodes.numerical.Endianess aEndianess)

Specified by:

withEndianess in interface org.refcodes.numerical.EndianessAccessor.EndianessBuilder<TransmissionMetrics.Builder>

withEndOfStringByte

public TransmissionMetrics.Builder withEndOfStringByte(byte aEndOfStringByte)

Sets the end of string byte for the end of string byte property.

Specified by:

withEndOfStringByte in interface EndOfStringByteAccessor.EndOfStringByteBuilder<TransmissionMetrics.Builder>

Parameters:

aEndOfStringByte - The end of string byte to be stored by the end of string byte property.

Returns:

The builder for applying multiple build operations.

withEnquiryStandbyTimeMillis

public TransmissionMetrics.Builder withEnquiryStandbyTimeMillis(long aEnquiryStandbyTimeInMs)

Sets the number for the ENQ ("enquiry") timeout property.

Specified by:

withEnquiryStandbyTimeMillis in interface EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisBuilder<TransmissionMetrics.Builder>

Parameters:

aEnquiryStandbyTimeInMs - The ENQ ("enquiry") timeout in milliseconds to be stored by the ENQ ("enquiry") timeout property.

Returns:

The builder for applying multiple build operations.

withLengthWidth

public TransmissionMetrics.Builder withLengthWidth(int aLengthWidth)

Sets the length width (in bytes) for the length width (in bytes) property.

Specified by:

withLengthWidth in interface LengthWidthAccessor.LengthWidthBuilder<TransmissionMetrics.Builder>

Parameters:

aLengthWidth - The length width (in bytes) to be stored by the length width (in bytes) property.

Returns:

The builder for applying multiple build operations.

withPacketLengthWidth

public TransmissionMetrics.Builder withPacketLengthWidth(int aPacketLengthWidth)

With packet length width.

Specified by:

withPacketLengthWidth in interface PacketLengthWidthAccessor.PacketLengthWidthBuilder<TransmissionMetrics.Builder>

Parameters:

aPacketLengthWidth - the packet length width

Returns:

the builder

withMagicBytesLength

public TransmissionMetrics.Builder withMagicBytesLength(int aMagicBytesLength)

Sets the magic bytes length for the magic bytes magic bytes length property.

Specified by:

withMagicBytesLength in interface MagicBytesLengthAccessor.MagicBytesLengthBuilder<TransmissionMetrics.Builder>

Parameters:

aMagicBytesLength - The magic bytes length to be stored by the magic bytes length property.

Returns:

The builder for applying multiple build operations.

withPacketSegmentPackager

public TransmissionMetrics.Builder withPacketSegmentPackager(SegmentPackager aPacketSegmentPackager)

Sets the SegmentPackager for the packet SegmentPackager property.

Specified by:

withPacketSegmentPackager in interface PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<TransmissionMetrics.Builder>

Parameters:

aPacketSegmentPackager - The SegmentPackager to be stored by the packet SegmentPackager property.

Returns:

The builder for applying multiple build operations.

withReadTimeoutMillis

public TransmissionMetrics.Builder withReadTimeoutMillis(long aReadTimeoutInMs)

Specified by:

withReadTimeoutMillis in interface org.refcodes.mixin.ReadTimeoutMillisAccessor.ReadTimeoutMillisBuilder<TransmissionMetrics.Builder>

withReadyToReceiveRetryNumber

public TransmissionMetrics.Builder withReadyToReceiveRetryNumber(int aReadyToReceiveRetryNumber)

Sets the number of retries for the RTR ("ready-to-receive") retry number. A RTR retry number is the overall number of retries to use when counting retries.

Specified by:

withReadyToReceiveRetryNumber in interface ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<TransmissionMetrics.Builder>

Parameters:

aReadyToReceiveRetryNumber - The number of retries to be stored by the number of RTR ("ready-to-receive") retry number.

Returns:

The builder for applying multiple build operations.

withReadyToReceiveSegmentPackager

public TransmissionMetrics.Builder withReadyToReceiveSegmentPackager(SegmentPackager aReadyToReceiveSegmentPackager)

Sets the SegmentPackager RTR ("ready-to-receive") property.

Specified by:

withReadyToReceiveSegmentPackager in interface ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<TransmissionMetrics.Builder>

Parameters:

aReadyToReceiveSegmentPackager - The SegmentPackager to be stored by the SegmentPackager RTR ("ready-to-receive") property.

Returns:

The builder for applying multiple build operations.

withReadyToReceiveTimeoutMillis

public TransmissionMetrics.Builder withReadyToReceiveTimeoutMillis(long aReadyToReceiveTimeoutInMs)

Sets the number for the RTR ("ready-to-receive") timeout property.

Specified by:

withReadyToReceiveTimeoutMillis in interface ReadyToReceiveTimeoutMillisAccessor.ReadyToReceiveTimeoutMillisBuilder<TransmissionMetrics.Builder>

Parameters:

aReadyToReceiveTimeoutInMs - The RTR ("ready-to-receive") timeout in milliseconds to be stored by the RTR timeout property.

Returns:

The builder for applying multiple build operations.

withReadyToSendRetryNumber

public TransmissionMetrics.Builder withReadyToSendRetryNumber(int aReadyToSendRetryNumber)

Sets the number of retries for the RTS ("ready-to-send") retry number. A RTS retry number is the overall number of retries to use when counting retries.

Specified by:

withReadyToSendRetryNumber in interface ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<TransmissionMetrics.Builder>

Parameters:

aReadyToSendRetryNumber - The number of retries to be stored by the number of RTS ("ready-to-send") retry number.

Returns:

The builder for applying multiple build operations.

withReadyToSendSegmentPackager

public TransmissionMetrics.Builder withReadyToSendSegmentPackager(SegmentPackager aReadyToSendSegmentPackager)

Sets the SegmentPackager RTS ("ready-to-send") property.

Specified by:

withReadyToSendSegmentPackager in interface ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<TransmissionMetrics.Builder>

Parameters:

aReadyToSendSegmentPackager - The SegmentPackager to be stored by the SegmentPackager RTS ("ready-to-send") property.

Returns:

The builder for applying multiple build operations.

withReadyToSendTimeoutMillis

public TransmissionMetrics.Builder withReadyToSendTimeoutMillis(long aReadyToSendTimeoutInMs)

Sets the number for the RTS ("ready-to-send") timeout property.

Specified by:

withReadyToSendTimeoutMillis in interface ReadyToSendTimeoutMillisAccessor.ReadyToSendTimeoutMillisBuilder<TransmissionMetrics.Builder>

Parameters:

aReadyToSendTimeoutInMs - The RTS ("ready-to-send") timeout in milliseconds to be stored by the RTS timeout property.

Returns:

The builder for applying multiple build operations.

withSequenceNumberConcatenateMode

public TransmissionMetrics.Builder withSequenceNumberConcatenateMode(org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode)

Sets the ConcatenateMode for the sequence number ConcatenateMode property.

Specified by:

withSequenceNumberConcatenateMode in interface SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<TransmissionMetrics.Builder>

Parameters:

aSequenceNumberConcatenateMode - The ConcatenateMode to be stored by the sequence number ConcatenateMode property.

Returns:

The builder for applying multiple build operations.

withSequenceNumberInitValue

public TransmissionMetrics.Builder withSequenceNumberInitValue(int aSequenceNumberInitValue)

Sets the sequence number initial value for the sequence number initial value property.

Specified by:

withSequenceNumberInitValue in interface SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<TransmissionMetrics.Builder>

Parameters:

aSequenceNumberInitValue - The sequence number initial value to be stored by the sequence number initial value property.

Returns:

The builder for applying multiple build operations.

withSequenceNumberWidth

public TransmissionMetrics.Builder withSequenceNumberWidth(int aSequenceNumberWidth)

Sets the sequence number width (in bytes) for the sequence number width (in bytes) property.

Specified by:

withSequenceNumberWidth in interface SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<TransmissionMetrics.Builder>

Parameters:

aSequenceNumberWidth - The sequence number width (in bytes) to be stored by the sequence number width (in bytes) property.

Returns:

The builder for applying multiple build operations.

withTransmissionRetryNumber

public TransmissionMetrics.Builder withTransmissionRetryNumber(int aTransmissionRetryNumber)

Sets the number of retries for the transmission retry number. A transmission retry number is the overall number of retries to use when counting retries.

Specified by:

withTransmissionRetryNumber in interface TransmissionRetryNumberAccessor.TransmissionRetryNumberBuilder<TransmissionMetrics.Builder>

Parameters:

aTransmissionRetryNumber - The number of retries to be stored by the number of transmission retry number.

Returns:

The builder for applying multiple build operations.

withTransmissionTimeoutMillis

public TransmissionMetrics.Builder withTransmissionTimeoutMillis(long aTransmissionTimeoutInMs)

Sets the number for the transmission timeout property.

Specified by:

withTransmissionTimeoutMillis in interface TransmissionTimeoutMillisAccessor.TransmissionTimeoutMillisBuilder<TransmissionMetrics.Builder>

Parameters:

aTransmissionTimeoutInMs - The transmission timeout in milliseconds to be stored by the transmission timeout property.

Returns:

The builder for applying multiple build operations.

withWriteTimeoutMillis

public TransmissionMetrics.Builder withWriteTimeoutMillis(long aWriteTimeoutInMs)

Specified by:

withWriteTimeoutMillis in interface org.refcodes.mixin.WriteTimeoutMillisAccessor.WriteTimeoutMillisBuilder<TransmissionMetrics.Builder>

withPongMagicBytes

public TransmissionMetrics.Builder withPongMagicBytes(byte[] aPongMagicBytes)

Sets the magic bytes for the pong magic bytes property.

Specified by:

withPongMagicBytes in interface PongMagicBytesAccessor.PongMagicBytesBuilder<TransmissionMetrics.Builder>

Parameters:

aPongMagicBytes - The magic bytes to be stored by the pong magic bytes property.

Returns:

The builder for applying multiple build operations.

withPingMagicBytes

public TransmissionMetrics.Builder withPingMagicBytes(byte[] aPingMagicBytes)

Sets the magic bytes for the ping magic bytes property.

Specified by:

withPingMagicBytes in interface PingMagicBytesAccessor.PingMagicBytesBuilder<TransmissionMetrics.Builder>

Parameters:

aPingMagicBytes - The magic bytes to be stored by the ping magic bytes property.

Returns:

The builder for applying multiple build operations.

withIoHeuristicsTimeToLiveMillis

public TransmissionMetrics.Builder withIoHeuristicsTimeToLiveMillis(long aIoHeuristicsTimeToLiveInMs)

Sets the number for the IO heuristics TTL (time to live) property.

Specified by:

withIoHeuristicsTimeToLiveMillis in interface IoHeuristicsTimeToLiveMillisAccessor.IoHeuristicsTimeToLiveMillisBuilder<TransmissionMetrics.Builder>

Parameters:

aIoHeuristicsTimeToLiveInMs - The IO heuristics TTL (time to live) in milliseconds to be stored by the IO heuristics TTL (time to live) property.

Returns:

The builder for applying multiple build operations.

build

public TransmissionMetrics build()

Builds the TransmissionMetrics instance from this builder's settings.

Returns:

The accordingly built TransmissionMetrics instance.