Module org.refcodes.serial

Package org.refcodes.serial

Class StopAndWaitPacketInputStream.Builder

java.lang.Object

org.refcodes.serial.PacketInputStream.Builder

org.refcodes.serial.StopAndWaitPacketInputStream.Builder

All Implemented Interfaces:

org.refcodes.mixin.BlockSizeAccessor.BlockSizeBuilder<PacketInputStream.Builder>, org.refcodes.mixin.InputStreamAccessor.InputStreamBuilder<PacketInputStream.Builder>, org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<PacketInputStream.Builder>, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<PacketInputStream.Builder>, org.refcodes.numerical.CrcChecksumValidationModeAccessor.CrcChecksumValidationModeBuilder<PacketInputStream.Builder>, org.refcodes.numerical.EndianessAccessor.EndianessBuilder<PacketInputStream.Builder>, AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<StopAndWaitPacketInputStream.Builder>, AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<StopAndWaitPacketInputStream.Builder>, AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<StopAndWaitPacketInputStream.Builder>, AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsBuilder<StopAndWaitPacketInputStream.Builder>, OutputReturnStreamAccessor.OutputReturnStreamBuilder<StopAndWaitPacketInputStream.Builder>, PacketLengthWidthAccessor.PacketLengthWidthBuilder<PacketInputStream.Builder>, PacketMagicBytesAccessor.PacketMagicBytesBuilder<PacketInputStream.Builder>, PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<PacketInputStream.Builder>, SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<PacketInputStream.Builder>, SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<PacketInputStream.Builder>, SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<PacketInputStream.Builder>

Enclosing class:

StopAndWaitPacketInputStream

public static class StopAndWaitPacketInputStream.Builder
extends PacketInputStream.Builder
implements AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<StopAndWaitPacketInputStream.Builder>, AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsBuilder<StopAndWaitPacketInputStream.Builder>, AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<StopAndWaitPacketInputStream.Builder>, OutputReturnStreamAccessor.OutputReturnStreamBuilder<StopAndWaitPacketInputStream.Builder>, AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<StopAndWaitPacketInputStream.Builder>

Builder to build StopAndWaitPacketInputStream instances.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
StopAndWaitPacketInputStream	build()	Returns the StopAndWaitPacketInputStream instance build according to the StopAndWaitPacketInputStream.Builder configuration.
StopAndWaitPacketInputStream.Builder	withAcknowledgeMagicBytes(byte[] aAcknowledgeMagicBytes)	Sets the magic bytes for the acknowledge magic bytes property.
StopAndWaitPacketInputStream.Builder	withAcknowledgeRetryNumber(int aAcknowledgeRetryNumber)	Sets the number of retries for the acknowledge retry number.
StopAndWaitPacketInputStream.Builder	withAcknowledgeSegmentPackager(SegmentPackager aAcknowledgeSegmentPackager)	Sets the SegmentPackager ACK property.
StopAndWaitPacketInputStream.Builder	withAcknowledgeTimeoutInMs(long aAcknowledgeTimeoutInMs)	Sets the number for the acknowledge timeout property.
StopAndWaitPacketInputStream.Builder	withCrcAlgorithm(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
StopAndWaitPacketInputStream.Builder	withCrcChecksumConcatenateMode(org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
StopAndWaitPacketInputStream.Builder	withCrcChecksumValidationMode(org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)
StopAndWaitPacketInputStream.Builder	withPacketSegmentPackager(SegmentPackager aPacketSegmentPackager)	Sets the SegmentPackager for the packet SegmentPackager property.
StopAndWaitPacketInputStream.Builder	withReturnStream(OutputStream aReturnStream)	Sets the output return stream to use and returns this builder as of the Builder-Pattern.

Methods inherited from class org.refcodes.serial.PacketInputStream.Builder

withBlockSize, withEndianess, withInputStream, withPacketLengthWidth, withPacketMagicBytes, withSequenceNumberConcatenateMode, withSequenceNumberInitValue, withSequenceNumberWidth

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

Constructor Details

Builder

protected Builder()

Method Details

build

public StopAndWaitPacketInputStream build()

Returns the StopAndWaitPacketInputStream instance build according to the StopAndWaitPacketInputStream.Builder configuration.

Overrides:

build in class PacketInputStream.Builder

Returns:

The accordingly configured StopAndWaitPacketInputStream.

withAcknowledgeMagicBytes

public StopAndWaitPacketInputStream.Builder withAcknowledgeMagicBytes(byte[] aAcknowledgeMagicBytes)

Sets the magic bytes for the acknowledge magic bytes property.

Specified by:

withAcknowledgeMagicBytes in interface AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<StopAndWaitPacketInputStream.Builder>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withAcknowledgeRetryNumber

public StopAndWaitPacketInputStream.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<StopAndWaitPacketInputStream.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.

withAcknowledgeSegmentPackager

public StopAndWaitPacketInputStream.Builder withAcknowledgeSegmentPackager(SegmentPackager aAcknowledgeSegmentPackager)

Sets the SegmentPackager ACK property.

Specified by:

withAcknowledgeSegmentPackager in interface AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<StopAndWaitPacketInputStream.Builder>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withAcknowledgeTimeoutInMs

public StopAndWaitPacketInputStream.Builder withAcknowledgeTimeoutInMs(long aAcknowledgeTimeoutInMs)

Sets the number for the acknowledge timeout property.

Specified by:

withAcknowledgeTimeoutInMs in interface AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsBuilder<StopAndWaitPacketInputStream.Builder>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withCrcAlgorithm

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

Specified by:

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

Overrides:

withCrcAlgorithm in class PacketInputStream.Builder

withCrcChecksumConcatenateMode

public StopAndWaitPacketInputStream.Builder withCrcChecksumConcatenateMode(org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)

Specified by:

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

Overrides:

withCrcChecksumConcatenateMode in class PacketInputStream.Builder

withCrcChecksumValidationMode

public StopAndWaitPacketInputStream.Builder withCrcChecksumValidationMode(org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)

Specified by:

withCrcChecksumValidationMode in interface org.refcodes.numerical.CrcChecksumValidationModeAccessor.CrcChecksumValidationModeBuilder<PacketInputStream.Builder>

Overrides:

withCrcChecksumValidationMode in class PacketInputStream.Builder

withPacketSegmentPackager

public StopAndWaitPacketInputStream.Builder withPacketSegmentPackager(SegmentPackager aPacketSegmentPackager)

Sets the SegmentPackager for the packet SegmentPackager property.

Specified by:

withPacketSegmentPackager in interface PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<PacketInputStream.Builder>

Overrides:

withPacketSegmentPackager in class PacketInputStream.Builder

Parameters:

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

Returns:

The builder for applying multiple build operations.

withReturnStream

public StopAndWaitPacketInputStream.Builder withReturnStream(OutputStream aReturnStream)

Sets the output return stream to use and returns this builder as of the Builder-Pattern.

Specified by:

withReturnStream in interface OutputReturnStreamAccessor.OutputReturnStreamBuilder<StopAndWaitPacketInputStream.Builder>

Parameters:

aReturnStream - The output return stream to be stored by the output return stream property.

Returns:

This OutputReturnStreamAccessor.OutputReturnStreamBuilder instance to continue configuration.