Module org.refcodes.serial

Package org.refcodes.serial

Class StopAndWaitPacketOutputStream.Builder

java.lang.Object

org.refcodes.serial.PacketOutputStream.Builder

org.refcodes.serial.StopAndWaitPacketOutputStream.Builder

All Implemented Interfaces:

org.refcodes.mixin.BlockSizeAccessor.BlockSizeBuilder<PacketOutputStream.Builder>, org.refcodes.mixin.OutputStreamAccessor.OutputStreamBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.ChecksumValidationModeAccessor.ChecksumValidationModeBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.EndianessAccessor.EndianessBuilder<PacketOutputStream.Builder>, AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<StopAndWaitPacketOutputStream.Builder>, AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<StopAndWaitPacketOutputStream.Builder>, AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<StopAndWaitPacketOutputStream.Builder>, AcknowledgeTimeoutMillisAccessor.AcknowledgeTimeoutMillisBuilder<StopAndWaitPacketOutputStream.Builder>, InputReturnStreamAccessor.InputReturnStreamBuilder<StopAndWaitPacketOutputStream.Builder>, PacketLengthWidthAccessor.PacketLengthWidthBuilder<PacketOutputStream.Builder>, PacketMagicBytesAccessor.PacketMagicBytesBuilder<PacketOutputStream.Builder>, PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<PacketOutputStream.Builder>, SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<PacketOutputStream.Builder>, SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<PacketOutputStream.Builder>, SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<PacketOutputStream.Builder>

Enclosing class:

StopAndWaitPacketOutputStream

public static final class StopAndWaitPacketOutputStream.Builder
extends PacketOutputStream.Builder
implements AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<StopAndWaitPacketOutputStream.Builder>, AcknowledgeTimeoutMillisAccessor.AcknowledgeTimeoutMillisBuilder<StopAndWaitPacketOutputStream.Builder>, AcknowledgeRetryNumberAccessor.AcknowledgeRetryNumberBuilder<StopAndWaitPacketOutputStream.Builder>, InputReturnStreamAccessor.InputReturnStreamBuilder<StopAndWaitPacketOutputStream.Builder>, AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<StopAndWaitPacketOutputStream.Builder>

Builder to build StopAndWaitPacketInputStream instances.

Method Summary

Modifier and Type	Method	Description
StopAndWaitPacketOutputStream	build()	Returns the StopAndWaitPacketInputStream instance build according to the StopAndWaitPacketOutputStream.Builder configuration.
StopAndWaitPacketOutputStream.Builder	withAcknowledgeMagicBytes(byte[] aAcknowledgeMagicBytes)	Sets the magic bytes for the acknowledge magic bytes property.
StopAndWaitPacketOutputStream.Builder	withAcknowledgeRetryNumber(int aAcknowledgeRetryNumber)	Sets the number of retries for the acknowledge retry number.
StopAndWaitPacketOutputStream.Builder	withAcknowledgeSegmentPackager(SegmentPackager aAcknowledgeSegmentPackager)	Sets the SegmentPackager ACK property.
StopAndWaitPacketOutputStream.Builder	withAcknowledgeTimeoutMillis(long aAckTimeoutInMs)	Sets the number for the acknowledge timeout property.
StopAndWaitPacketOutputStream.Builder	withReturnStream(InputStream aReturnStream)	Sets the input return stream to use and returns this builder as of the Builder-Pattern.

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

withBlockSize, withChecksumValidationMode, withCrcAlgorithm, withCrcChecksumConcatenateMode, withEndianess, withOutputStream, withPacketLengthWidth, withPacketMagicBytes, withPacketSegmentPackager, 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

Method Details

build

public StopAndWaitPacketOutputStream build()

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

Overrides:

build in class PacketOutputStream.Builder

Returns:

The accordingly configured StopAndWaitPacketInputStream.

withAcknowledgeMagicBytes

public StopAndWaitPacketOutputStream.Builder withAcknowledgeMagicBytes(byte[] aAcknowledgeMagicBytes)

Sets the magic bytes for the acknowledge magic bytes property.

Specified by:

withAcknowledgeMagicBytes in interface AcknowledgeMagicBytesAccessor.AcknowledgeMagicBytesBuilder<StopAndWaitPacketOutputStream.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 StopAndWaitPacketOutputStream.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<StopAndWaitPacketOutputStream.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 StopAndWaitPacketOutputStream.Builder withAcknowledgeSegmentPackager(SegmentPackager aAcknowledgeSegmentPackager)

Sets the SegmentPackager ACK property.

Specified by:

withAcknowledgeSegmentPackager in interface AcknowledgeSegmentPackagerAccessor.AcknowledgeSegmentPackagerBuilder<StopAndWaitPacketOutputStream.Builder>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withAcknowledgeTimeoutMillis

public StopAndWaitPacketOutputStream.Builder withAcknowledgeTimeoutMillis(long aAckTimeoutInMs)

Sets the number for the acknowledge timeout property.

Specified by:

withAcknowledgeTimeoutMillis in interface AcknowledgeTimeoutMillisAccessor.AcknowledgeTimeoutMillisBuilder<StopAndWaitPacketOutputStream.Builder>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withReturnStream

public StopAndWaitPacketOutputStream.Builder withReturnStream(InputStream aReturnStream)

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

Specified by:

withReturnStream in interface InputReturnStreamAccessor.InputReturnStreamBuilder<StopAndWaitPacketOutputStream.Builder>

Parameters:

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

Returns:

This InputReturnStreamAccessor.InputReturnStreamBuilder instance to continue configuration.