Module org.refcodes.serial

Package org.refcodes.serial

Class ReadyToSendSegmentDecorator<DECORATEE extends Segment>

java.lang.Object

org.refcodes.serial.AbstractReadyToSendTransmissionDecorator<DECORATEE>

org.refcodes.serial.ReadyToSendSegmentDecorator<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, org.refcodes.mixin.Resetable, org.refcodes.schema.Schemable, ClearToSendMagicBytesAccessor, ClearToSendSegmentPackagerAccessor, ClearToSendTimeoutMillisAccessor, DecoratorSegment<DECORATEE>, EnquiryStandbyTimeMillisAccessor, ReadyToSendMagicBytesAccessor, ReadyToSendRetryNumberAccessor, ReadyToSendSegmentPackagerAccessor, ReadyToSendTimeoutMillisAccessor, ReadyToSendTransmission, Segment, Transmission, Transmission.TransmissionMixin

public class ReadyToSendSegmentDecorator<DECORATEE extends Segment>
extends AbstractReadyToSendTransmissionDecorator<DECORATEE>
implements Segment, DecoratorSegment<DECORATEE>

The ReadyToSendSegmentDecorator class implements a decorator providing ReadyToSendTransmission functionality for a Segment.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

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

ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<B extends ClearToSendMagicBytesAccessor.ClearToSendMagicBytesBuilder<B>>, ClearToSendMagicBytesAccessor.ClearToSendMagicBytesMutator, ClearToSendMagicBytesAccessor.ClearToSendMagicBytesProperty

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

ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B extends ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerBuilder<B>>, ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerMutator, ClearToSendSegmentPackagerAccessor.ClearToSendSegmentPackagerProperty

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

ClearToSendTimeoutMillisAccessor.ClearToSendTimeoutMillisBuilder<B extends ClearToSendTimeoutMillisAccessor.ClearToSendTimeoutMillisBuilder<B>>, ClearToSendTimeoutMillisAccessor.ClearToSendTimeoutMillisMutator, ClearToSendTimeoutMillisAccessor.ClearToSendTimeoutMillisProperty

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

EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisBuilder<B extends EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisBuilder<B>>, EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisMutator, EnquiryStandbyTimeMillisAccessor.EnquiryStandbyTimeMillisProperty

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

ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<B extends ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesBuilder<B>>, ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesMutator, ReadyToSendMagicBytesAccessor.ReadyToSendMagicBytesProperty

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

ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<B extends ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberBuilder<B>>, ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberMutator, ReadyToSendRetryNumberAccessor.ReadyToSendRetryNumberProperty

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

ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B extends ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerBuilder<B>>, ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerMutator, ReadyToSendSegmentPackagerAccessor.ReadyToSendSegmentPackagerProperty

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

ReadyToSendTimeoutMillisAccessor.ReadyToSendTimeoutMillisBuilder<B extends ReadyToSendTimeoutMillisAccessor.ReadyToSendTimeoutMillisBuilder<B>>, ReadyToSendTimeoutMillisAccessor.ReadyToSendTimeoutMillisMutator, ReadyToSendTimeoutMillisAccessor.ReadyToSendTimeoutMillisProperty

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

_clearToSendMagicBytes, _clearToSendMagicBytesSegment, _clearToSendSegment, _clearToSendSegmentPackager, _clearToSendTimeoutInMs, _decoratee, _enquiryStandbyTimeInMs, _readyToSendMagicBytes, _readyToSendMagicBytesSegment, _readyToSendRetryNumber, _readyToSendSegment, _readyToSendSegmentPackager, _readyToSendTimeoutInMs, CTS_MAGIC_BYTES, CTS_TIMEOUT_IN_MS, RTS_MAGIC_BYTES, RTS_RETRY_NUMBER, RTS_TIMEOUT_IN_MS

Constructor Summary

Constructors

Constructor	Description
ReadyToSendSegmentDecorator()
ReadyToSendSegmentDecorator(DECORATEE aDecoratee)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, byte[] aClearToSendMagicBytes)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, byte[] aClearToSendMagicBytes)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, byte[] aClearToSendMagicBytes)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, byte[] aClearToSendMagicBytes)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
ReadyToSendSegmentDecorator(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)

Method Summary

Modifier and Type	Method	Description
static <DECORATEE extends Segment> ReadyToSendSegmentDecorator.Builder<DECORATEE>	builder()	Creates builder to build ReadyToSendSegmentDecorator.
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.AbstractReadyToSendTransmissionDecorator

equals, getClearToSendMagicBytes, getClearToSendSegmentPackager, getClearToSendTimeoutMillis, getDecoratee, getEnquiryStandbyTimeMillis, getLength, getReadyToSendMagicBytes, getReadyToSendRetryNumber, getReadyToSendSegmentPackager, getReadyToSendTimeoutMillis, hashCode, receiveCtsTransmitTo, reset, toSchema, toSequence, toSimpleTypeMap, toString, 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.Segment

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

getLength, reset, toSchema, toSequence, toSimpleTypeMap, transmitTo, transmitTo

Constructor Details

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator()

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 byte[] aReadyToSendMagicBytes,
 byte[] aClearToSendMagicBytes)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 byte[] aReadyToSendMagicBytes,
 int aReadyToSendRetryNumber,
 byte[] aClearToSendMagicBytes)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 byte[] aReadyToSendMagicBytes,
 int aReadyToSendRetryNumber,
 long aReadyToSendTimeoutInMs,
 SegmentPackager aReadyToSendSegmentPackager,
 byte[] aClearToSendMagicBytes,
 long aClearToSendTimeoutInMs,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 byte[] aReadyToSendMagicBytes,
 int aReadyToSendRetryNumber,
 SegmentPackager aReadyToSendSegmentPackager,
 byte[] aClearToSendMagicBytes,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 byte[] aReadyToSendMagicBytes,
 long aReadyToSendTimeoutInMs,
 byte[] aClearToSendMagicBytes,
 long aClearToSendTimeoutInMs)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 byte[] aReadyToSendMagicBytes,
 long aReadyToSendTimeoutInMs,
 SegmentPackager aReadyToSendSegmentPackager,
 byte[] aClearToSendMagicBytes,
 long aClearToSendTimeoutInMs,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 byte[] aReadyToSendMagicBytes,
 SegmentPackager aReadyToSendSegmentPackager,
 byte[] aClearToSendMagicBytes,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 int aReadyToSendRetryNumber,
 long aReadyToSendTimeoutInMs,
 long aClearToSendTimeoutInMs)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 int aReadyToSendRetryNumber,
 long aReadyToSendTimeoutInMs,
 SegmentPackager aReadyToSendSegmentPackager,
 long aClearToSendTimeoutInMs,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToSendMagicBytes,
 byte[] aClearToSendMagicBytes)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToSendMagicBytes,
 int aReadyToSendRetryNumber,
 byte[] aClearToSendMagicBytes)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToSendMagicBytes,
 int aReadyToSendRetryNumber,
 long aReadyToSendTimeoutInMs,
 SegmentPackager aReadyToSendSegmentPackager,
 byte[] aClearToSendMagicBytes,
 long aClearToSendTimeoutInMs,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToSendMagicBytes,
 int aReadyToSendRetryNumber,
 SegmentPackager aReadyToSendSegmentPackager,
 byte[] aClearToSendMagicBytes,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToSendMagicBytes,
 long aReadyToSendTimeoutInMs,
 byte[] aClearToSendMagicBytes,
 long aClearToSendTimeoutInMs)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToSendMagicBytes,
 long aReadyToSendTimeoutInMs,
 SegmentPackager aReadyToSendSegmentPackager,
 byte[] aClearToSendMagicBytes,
 long aClearToSendTimeoutInMs,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 byte[] aReadyToSendMagicBytes,
 SegmentPackager aReadyToSendSegmentPackager,
 byte[] aClearToSendMagicBytes,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 int aReadyToSendRetryNumber,
 long aReadyToSendTimeoutInMs,
 long aClearToSendTimeoutInMs)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 int aReadyToSendRetryNumber,
 long aReadyToSendTimeoutInMs,
 SegmentPackager aReadyToSendSegmentPackager,
 long aClearToSendTimeoutInMs,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 long aReadyToSendTimeoutInMs,
 long aClearToSendTimeoutInMs)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs,
 long aReadyToSendTimeoutInMs,
 SegmentPackager aReadyToSendSegmentPackager,
 long aClearToSendTimeoutInMs,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aReadyToSendTimeoutInMs,
 SegmentPackager aReadyToSendSegmentPackager,
 long aClearToSendTimeoutInMs,
 SegmentPackager aClearToSendSegmentPackager)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 long aEnquiryStandbyTimeInMs)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee,
 TransmissionMetrics aTransmissionMetrics)

ReadyToSendSegmentDecorator

public ReadyToSendSegmentDecorator(DECORATEE aDecoratee)

Method Details

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

(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>
ReadyToSendSegmentDecorator.Builder<DECORATEE> builder()

Creates builder to build ReadyToSendSegmentDecorator.

Type Parameters:

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

Returns:

created builder