Module org.refcodes.serial

Package org.refcodes.serial

Class ReadyToReceiveSegmentDecorator<DECORATEE extends Segment>

java.lang.Object

org.refcodes.serial.AbstractReadyToReceiveTransmissionDecorator<DECORATEE>

org.refcodes.serial.ReadyToReceiveSegmentDecorator<DECORATEE>

Type Parameters:

DECORATEE - The decoratee type describing the according subclass to be enriched.

All Implemented Interfaces:

Serializable, org.refcodes.mixin.DecorateeAccessor<DECORATEE>, org.refcodes.mixin.LengthAccessor, DecoratorSegment<DECORATEE>, EnquiryStandbyTimeInMsAccessor, ReadyToReceiveMagicBytesAccessor, ReadyToReceiveRetryNumberAccessor, ReadyToReceiveSegmentPackagerAccessor, ReadyToReceiveTimeoutInMsAccessor, ReadyToReceiveTransmission, Segment, Transmission, Transmission.TransmissionMixin

public class ReadyToReceiveSegmentDecorator<DECORATEE extends Segment>
extends AbstractReadyToReceiveTransmissionDecorator<DECORATEE>
implements ReadyToReceiveTransmission, Segment, DecoratorSegment<DECORATEE>

The ReadyToReceiveSegmentDecorator class implements a decorator providing ReadyToReceiveTransmission functionality for a Segment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReadyToReceiveSegmentDecorator.Builder<DECORATEE extends Segment>	Builder to build ReadyToReceiveSegmentDecorator.

Nested classes/interfaces inherited from interface org.refcodes.mixin.DecorateeAccessor

org.refcodes.mixin.DecorateeAccessor.DecorateeBuilder<DECORATEE extends Object,B extends org.refcodes.mixin.DecorateeAccessor.DecorateeBuilder<DECORATEE,B>>, org.refcodes.mixin.DecorateeAccessor.DecorateeMutator<DECORATEE extends Object>, org.refcodes.mixin.DecorateeAccessor.DecorateeProperty<DECORATEE extends Object>

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

EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsBuilder<B extends EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsBuilder<B>>, EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsMutator, EnquiryStandbyTimeInMsAccessor.EnquiryStandbyTimeInMsProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.LengthAccessor

org.refcodes.mixin.LengthAccessor.LengthBuilder<B extends org.refcodes.mixin.LengthAccessor.LengthBuilder<B>>, org.refcodes.mixin.LengthAccessor.LengthMutator, org.refcodes.mixin.LengthAccessor.LengthProperty

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

ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<B extends ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesBuilder<B>>, ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesMutator, ReadyToReceiveMagicBytesAccessor.ReadyToReceiveMagicBytesProperty

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

ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<B extends ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberBuilder<B>>, ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberMutator, ReadyToReceiveRetryNumberAccessor.ReadyToReceiveRetryNumberProperty

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

ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B extends ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerBuilder<B>>, ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerMutator, ReadyToReceiveSegmentPackagerAccessor.ReadyToReceiveSegmentPackagerProperty

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

ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsBuilder<B extends ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsBuilder<B>>, ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsMutator, ReadyToReceiveTimeoutInMsAccessor.ReadyToReceiveTimeoutInMsProperty

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

Segment.SegmentMixin

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

Transmission.TransmissionMixin

Field Summary

Fields inherited from class org.refcodes.serial.AbstractReadyToReceiveTransmissionDecorator

_decoratee, _enquiryStandbyTimeInMs, _readyToReceiveMagicBytes, _readyToReceiveMagicByteSegment, _readyToReceiveRetryNumber, _readyToReceiveSegment, _readyToReceiveSegmentPackager, _readyToReceiveTimeoutInMs, RTR_MAGIC_BYTES, RTR_RETRY_NUMBER, RTR_TIMEOUT_IN_MS

Constructor Summary

Constructors

Constructor	Description
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte aReadyToReceiveMagicBytes)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToReceiveTimeoutInMs)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)

Method Summary

Modifier and Type	Method	Description
static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator.Builder<DECORATEE>	builder()	Creates builder to build ReadyToReceiveSegmentDecorator.
int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
void	receiveFrom(InputStream aInputStream, OutputStream aReturnStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.

Methods inherited from class org.refcodes.serial.AbstractReadyToReceiveTransmissionDecorator

equals, getDecoratee, getEnquiryStandbyTimeInMs, getLength, getReadyToReceiveMagicBytes, getReadyToReceiveRetryNumber, getReadyToReceiveSegmentPackager, getReadyToReceiveTimeoutInMs, hashCode, toSchema, toSimpleTypeMap, toString, toTransmission, transmitTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.refcodes.mixin.DecorateeAccessor

getDecoratee

Methods inherited from interface org.refcodes.serial.EnquiryStandbyTimeInMsAccessor

getEnquiryStandbyTimeInMs

Methods inherited from interface org.refcodes.serial.ReadyToReceiveMagicBytesAccessor

getReadyToReceiveMagicBytes

Methods inherited from interface org.refcodes.serial.ReadyToReceiveRetryNumberAccessor

getReadyToReceiveRetryNumber

Methods inherited from interface org.refcodes.serial.ReadyToReceiveSegmentPackagerAccessor

getReadyToReceiveSegmentPackager

Methods inherited from interface org.refcodes.serial.ReadyToReceiveTimeoutInMsAccessor

getReadyToReceiveTimeoutInMs

Methods inherited from interface org.refcodes.serial.Segment

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

getLength, toSchema, toSimpleTypeMap, toTransmission, transmitTo, transmitTo

Constructor Detail

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      byte aReadyToReceiveMagicBytes,
                                      int aReadyToReceiveRetryNumber,
                                      long aReadyToReceiveTimeoutInMs,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      byte aReadyToReceiveMagicBytes,
                                      int aReadyToReceiveRetryNumber,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      byte aReadyToReceiveMagicBytes,
                                      int aReadyToReceiveRetryNumber)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      byte aReadyToReceiveMagicBytes,
                                      long aReadyToReceiveTimeoutInMs,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      byte aReadyToReceiveMagicBytes,
                                      long aReadyToReceiveTimeoutInMs)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      byte aReadyToReceiveMagicBytes,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      byte aReadyToReceiveMagicBytes)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      int aReadyToReceiveRetryNumber,
                                      long aReadyToReceiveTimeoutInMs,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      int aReadyToReceiveRetryNumber,
                                      long aReadyToReceiveTimeoutInMs)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs,
                                      byte[] aReadyToReceiveMagicBytes,
                                      int aReadyToReceiveRetryNumber,
                                      long aReadyToReceiveTimeoutInMs,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs,
                                      byte aReadyToReceiveMagicBytes,
                                      int aReadyToReceiveRetryNumber,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs,
                                      byte aReadyToReceiveMagicBytes,
                                      int aReadyToReceiveRetryNumber)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs,
                                      byte aReadyToReceiveMagicBytes,
                                      long aReadyToReceiveTimeoutInMs,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs,
                                      byte aReadyToReceiveMagicBytes,
                                      long aReadyToReceiveTimeoutInMs)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs,
                                      byte aReadyToReceiveMagicBytes,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs,
                                      byte aReadyToReceiveMagicBytes)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs,
                                      int aReadyToReceiveRetryNumber,
                                      long aReadyToReceiveTimeoutInMs,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs,
                                      int aReadyToReceiveRetryNumber,
                                      long aReadyToReceiveTimeoutInMs)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs,
                                      long aReadyToReceiveTimeoutInMs,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs,
                                      long aReadyToReceiveTimeoutInMs)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aReadyToReceiveTimeoutInMs,
                                      SegmentPackager aReadyToReceiveSegmentPackager)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      long aEnquiryStandbyTimeInMs)

ReadyToReceiveSegmentDecorator

public ReadyToReceiveSegmentDecorator(DECORATEE aDecoratee,
                                      TransmissionMetrics aTransmissionMetrics)

Method Detail

fromTransmission

public int fromTransmission(Sequence aSequence,
                            int aOffset)
                     throws TransmissionException

(Re-)initializes this instance with the the given Sequence data.

Specified by:

fromTransmission in interface Segment

Parameters:

aSequence - The Sequence data from which to (re-)initialize this instance.

aOffset - The offset where to start processing the provided Sequence.

Returns:

The index after the last offset into the given Sequence processed by this method.

Throws:

TransmissionException - thrown in case a given Sequence cannot be processed.

receiveFrom

public void receiveFrom(InputStream aInputStream,
                        OutputStream aReturnStream)
                 throws IOException,
                        TransmissionException

(Re-)initializes this instance by receiving the according Sequence from the given InputStream. Implementations providing error correction methods use the provided feedback OutputStream to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the received data.

Specified by:

receiveFrom in interface Segment

Parameters:

aInputStream - The InputStream from which to read the instance's (re-)initialization Sequence from.

aReturnStream - An OutputStream being the return channel to handle "stop-and-wait ARQ" or the like in case of a bidirectional connection. Can be null in case we have a unidirectional connection.

Throws:

IOException - thrown in case reading data from the InputStream caused problems.

TransmissionException - thrown in case a given transmission cannot be processed.

builder

public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator.Builder<DECORATEE> builder()

Creates builder to build ReadyToReceiveSegmentDecorator.

Type Parameters:

DECORATEE - The decoratee type describing the according subclass to be enriched.

Returns:

created builder