Module org.refcodes.serial

Package org.refcodes.serial

Class FullDuplexTransmissionPortDecorator.Builder<PM extends PortMetrics>

java.lang.Object

org.refcodes.serial.FullDuplexTransmissionPortDecorator.Builder<PM>

Type Parameters:

PM - The actual PortMetrics type to use.

Enclosing class:

FullDuplexTransmissionPortDecorator<PM extends PortMetrics>

public static final class FullDuplexTransmissionPortDecorator.Builder<PM extends PortMetrics>
extends Object

Builder for building a FullDuplexTransmissionPortDecorator instance.

Method Summary

Modifier and Type	Method	Description
FullDuplexTransmissionPortDecorator<PM>	build()	Builds the.
FullDuplexTransmissionPortDecorator.Builder<PM>	withAcknowledgeMagicBytes(byte[] aAcknowledgeMagicBytes)	Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().
FullDuplexTransmissionPortDecorator.Builder<PM>	withAcknowledgeRetryNumber(int aAcknowledgeRetryNumber)	Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().
FullDuplexTransmissionPortDecorator.Builder<PM>	withAcknowledgeTimeoutInMs(long aAcknowledgeTimeoutInMs)	Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().
FullDuplexTransmissionPortDecorator.Builder<PM>	withCrcAlgorithm(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)	Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().
FullDuplexTransmissionPortDecorator.Builder<PM>	withCrcChecksumValidationMode(org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)	Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().
FullDuplexTransmissionPortDecorator.Builder<PM>	withEndianess(org.refcodes.numerical.Endianess aEndianess)	Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().
FullDuplexTransmissionPortDecorator.Builder<PM>	withExecutorService(ExecutorService aExecutorService)	Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().
FullDuplexTransmissionPortDecorator.Builder<PM>	withPort(Port<PM> aPort)	Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().
FullDuplexTransmissionPortDecorator.Builder<PM>	withSequenceNumberInitValue(int aSequenceNumberInitValue)	Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().
FullDuplexTransmissionPortDecorator.Builder<PM>	withSequenceNumberWidth(int aSequenceNumberWidth)	Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().
FullDuplexTransmissionPortDecorator.Builder<PM>	withTransmissionMagicBytes(byte[] aTransmissionMagicBytes)	Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Methods inherited from class java.lang.Object

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

Method Detail

withEndianess

public FullDuplexTransmissionPortDecorator.Builder<PM> withEndianess(org.refcodes.numerical.Endianess aEndianess)

Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Parameters:

aEndianess - The Endianess to use when calculating the CRC checksum.

Returns:

The FullDuplexTransmissionPortDecorator.Builder to chain other operations as of the builder pattern.

withPort

public FullDuplexTransmissionPortDecorator.Builder<PM> withPort(Port<PM> aPort)

Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Parameters:

aPort - the a port

Returns:

The FullDuplexTransmissionPortDecorator.Builder to chain other operations as of the builder pattern.

withTransmissionMagicBytes

public FullDuplexTransmissionPortDecorator.Builder<PM> withTransmissionMagicBytes(byte[] aTransmissionMagicBytes)

Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Parameters:

aTransmissionMagicBytes - The magic bytes identifying a regular transmission (as of FullDuplexTransmissionPortDecorator.transmitSegment(Segment) or the like).

Returns:

The FullDuplexTransmissionPortDecorator.Builder to chain other operations as of the builder pattern.

withAcknowledgeMagicBytes

public FullDuplexTransmissionPortDecorator.Builder<PM> withAcknowledgeMagicBytes(byte[] aAcknowledgeMagicBytes)

Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Parameters:

aAcknowledgeMagicBytes - The ACK character to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.

Returns:

The FullDuplexTransmissionPortDecorator.Builder to chain other operations as of the builder pattern.

withAcknowledgeRetryNumber

public FullDuplexTransmissionPortDecorator.Builder<PM> withAcknowledgeRetryNumber(int aAcknowledgeRetryNumber)

Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Parameters:

aAcknowledgeRetryNumber - The number of retries waiting for an ACK from the return channel.

Returns:

The FullDuplexTransmissionPortDecorator.Builder to chain other operations as of the builder pattern.

withAcknowledgeTimeoutInMs

public FullDuplexTransmissionPortDecorator.Builder<PM> withAcknowledgeTimeoutInMs(long aAcknowledgeTimeoutInMs)

Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Parameters:

aAcknowledgeTimeoutInMs - The timeout in milliseconds to pend till the next retry.

Returns:

The FullDuplexTransmissionPortDecorator.Builder to chain other operations as of the builder pattern.

withSequenceNumberInitValue

public FullDuplexTransmissionPortDecorator.Builder<PM> withSequenceNumberInitValue(int aSequenceNumberInitValue)

Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Parameters:

aSequenceNumberInitValue - The initialization value for the sequence number counter.

Returns:

The FullDuplexTransmissionPortDecorator.Builder to chain other operations as of the builder pattern.

withSequenceNumberWidth

public FullDuplexTransmissionPortDecorator.Builder<PM> withSequenceNumberWidth(int aSequenceNumberWidth)

Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Parameters:

aSequenceNumberWidth - The width in bytes to be used for the binary sequence number representation.

Returns:

The FullDuplexTransmissionPortDecorator.Builder to chain other operations as of the builder pattern.

withCrcAlgorithm

public FullDuplexTransmissionPortDecorator.Builder<PM> withCrcAlgorithm(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)

Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Parameters:

aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.

Returns:

The FullDuplexTransmissionPortDecorator.Builder to chain other operations as of the builder pattern.

withCrcChecksumValidationMode

public FullDuplexTransmissionPortDecorator.Builder<PM> withCrcChecksumValidationMode(org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)

Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Parameters:

aCrcChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.

Returns:

The FullDuplexTransmissionPortDecorator.Builder to chain other operations as of the builder pattern.

withExecutorService

public FullDuplexTransmissionPortDecorator.Builder<PM> withExecutorService(ExecutorService aExecutorService)

Sets the according property for configuring the FullDuplexTransmissionPortDecorator upon invoking build().

Parameters:

aExecutorService - The ExecutorService to be used when creating Thread instances for handling input and output data simultaneously.

Returns:

The FullDuplexTransmissionPortDecorator.Builder to chain other operations as of the builder pattern.

build

public FullDuplexTransmissionPortDecorator<PM> build()

Builds the.

Returns:

the full duplex segment multiplexer