Module org.refcodes.serial

Package org.refcodes.serial

Class StopAndWaitPacketOutputStream

java.lang.Object

java.io.OutputStream

org.refcodes.serial.PacketOutputStream

org.refcodes.serial.StopAndWaitPacketOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, org.refcodes.mixin.BlockSizeAccessor, org.refcodes.mixin.PacketSizeAccessor, org.refcodes.numerical.EndianessAccessor, AcknowledgeMagicBytesAccessor, AcknowledgeRetryNumberAccessor, AcknowledgeSegmentPackagerAccessor, AcknowledgeTimeoutInMsAccessor, PacketLengthWidthAccessor, PacketMagicBytesAccessor, PacketSegmentPackagerAccessor, SequenceNumberAccessor, SequenceNumberConcatenateModeAccessor, SequenceNumberInitValueAccessor, SequenceNumberWidthAccessor

public class StopAndWaitPacketOutputStream
extends PacketOutputStream
implements AcknowledgeRetryNumberAccessor, AcknowledgeTimeoutInMsAccessor, AcknowledgeMagicBytesAccessor, AcknowledgeSegmentPackagerAccessor

The StopAndWaitPacketOutputStream wraps an OutputStream and chunks any data to be written into packets with a sequence number, a block of data and a CRC checksum. An according StopAndWaitPacketInputStream then reverts the packetised data stream while performing CRC checksum validation as well as sequence number validation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StopAndWaitPacketOutputStream.Builder	Builder to build StopAndWaitPacketInputStream instances.

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.AcknowledgeTimeoutInMsAccessor

AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsBuilder<B extends AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsBuilder<B>>, AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsMutator, AcknowledgeTimeoutInMsAccessor.AcknowledgeTimeoutInMsProperty

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.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.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.mixin.PacketSizeAccessor

org.refcodes.mixin.PacketSizeAccessor.PacketSizeBuilder<B extends org.refcodes.mixin.PacketSizeAccessor.PacketSizeBuilder<B>>, org.refcodes.mixin.PacketSizeAccessor.PacketSizeMutator, org.refcodes.mixin.PacketSizeAccessor.PacketSizeProperty

Nested classes/interfaces inherited from interface org.refcodes.serial.SequenceNumberAccessor

SequenceNumberAccessor.SequenceNumberBuilder<B extends SequenceNumberAccessor.SequenceNumberBuilder<B>>, SequenceNumberAccessor.SequenceNumberMutator, SequenceNumberAccessor.SequenceNumberProperty

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

Field Summary

Fields inherited from class org.refcodes.serial.PacketOutputStream

_allocSegment, _blockOffset, _blockSequence, _boundedSequence, _endianess, _outputStream, _packetSegment, _sequenceNumber, _sequenceNumberSegment, _sequenceNumberWidth

Constructor Summary

Constructors

Constructor	Description
StopAndWaitPacketOutputStream(OutputStream aOutputStream, int aBlockSize, int aPacketLengthWidth, byte[] aPacketMagicBytes, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, SegmentPackager aPacketSegmentPackager, InputStream aReturnStream, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)	Constructs an according StopAndWaitPacketOutputStream instance wrapping the given OutputStream.
StopAndWaitPacketOutputStream(OutputStream aOutputStream, InputStream aReturnStream, TransmissionMetrics aTransmissionMetrics)	Constructs an according StopAndWaitPacketOutputStream instance wrapping the given OutputStream.

Method Summary

Modifier and Type	Method	Description
static StopAndWaitPacketOutputStream.Builder	builder()	Creates builder to build StopAndWaitPacketOutputStream.
protected void	doTransmitPacket()	Do transmit packet.
byte[]	getAcknowledgeMagicBytes()	Retrieves the magic bytes from the acknowledge magic bytes property.
int	getAcknowledgeRetryNumber()	Retrieves the number of retries from the acknowledge retry number.
SegmentPackager	getAcknowledgeSegmentPackager()	Retrieves the SegmentPackager ACK property.
long	getAcknowledgeTimeoutInMs()	The acknowledge timeout attribute in milliseconds.

Methods inherited from class org.refcodes.serial.PacketOutputStream

close, flush, getBlockSize, getEndianess, getPacketLengthWidth, getPacketMagicBytes, getPacketSegmentPackager, getPacketSize, getSequenceNumber, getSequenceNumberConcatenateMode, getSequenceNumberInitValue, getSequenceNumberWidth, write

Methods inherited from class java.io.OutputStream

nullOutputStream, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

StopAndWaitPacketOutputStream

public StopAndWaitPacketOutputStream(OutputStream aOutputStream,
                                     InputStream aReturnStream,
                                     TransmissionMetrics aTransmissionMetrics)

Constructs an according StopAndWaitPacketOutputStream instance wrapping the given OutputStream. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!

Parameters:

aOutputStream - The OutputStream to be wrapped.

aReturnStream - The InputStream for establishing a return channel (handshake with the communication partner).

aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

StopAndWaitPacketOutputStream

public StopAndWaitPacketOutputStream(OutputStream aOutputStream,
                                     int aBlockSize,
                                     int aPacketLengthWidth,
                                     byte[] aPacketMagicBytes,
                                     int aSequenceNumberInitValue,
                                     int aSequenceNumberWidth,
                                     org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode,
                                     SegmentPackager aPacketSegmentPackager,
                                     InputStream aReturnStream,
                                     byte[] aAcknowledgeMagicBytes,
                                     int aAckRetryNumber,
                                     long aAckTimeoutInMs,
                                     SegmentPackager aAckSegmentPackager,
                                     org.refcodes.numerical.Endianess aEndianess)

Constructs an according StopAndWaitPacketOutputStream instance wrapping the given OutputStream.

Parameters:

aOutputStream - The OutputStream to be wrapped.

aBlockSize - The block size of a data block for each packet.

aPacketLengthWidth - The width (bytes) for the number of bytes to be truncated from the last block.

aPacketMagicBytes - The magic bytes identifying a packet and distinguishing a packet from a last package.

aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.

aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.

aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.

aPacketSegmentPackager - An (optional) SegmentPackager used to modify a packet's data e.g. with a CRC checksum.

aReturnStream - The InputStream for establishing a return channel (handshake with the communication partner).

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

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

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

aAckSegmentPackager - An (optional) SegmentPackager used to modify a ACK response data e.g. with a CRC checksum.

aEndianess - The Endianess to use for integer (double) numbers and the like.

Method Detail

builder

public static StopAndWaitPacketOutputStream.Builder builder()

Creates builder to build StopAndWaitPacketOutputStream.

Returns:

created builder

getAcknowledgeMagicBytes

public byte[] getAcknowledgeMagicBytes()

Retrieves the magic bytes from the acknowledge magic bytes property.

Specified by:

getAcknowledgeMagicBytes in interface AcknowledgeMagicBytesAccessor

Returns:

The magic bytes stored by the acknowledge magic bytes 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 interface AcknowledgeRetryNumberAccessor

Returns:

The number of retries stored by the acknowledge retry number.

getAcknowledgeSegmentPackager

public SegmentPackager getAcknowledgeSegmentPackager()

Retrieves the SegmentPackager ACK property.

Specified by:

getAcknowledgeSegmentPackager in interface AcknowledgeSegmentPackagerAccessor

Returns:

The SegmentPackager stored by the ACK SegmentPackager property.

getAcknowledgeTimeoutInMs

public long getAcknowledgeTimeoutInMs()

The acknowledge timeout attribute in milliseconds.

Specified by:

getAcknowledgeTimeoutInMs in interface AcknowledgeTimeoutInMsAccessor

Returns:

An long integer with the timeout in milliseconds.

doTransmitPacket

protected void doTransmitPacket()
                         throws IOException,
                                TransmissionSequenceException

Description copied from class: PacketOutputStream

Do transmit packet.

Overrides:

doTransmitPacket in class PacketOutputStream

Throws:

IOException - Signals that an I/O exception has occurred.

TransmissionSequenceException - the transmission sequence exception