Module org.refcodes.serial

Package org.refcodes.serial

Class BreakerSectionDecorator<DECORATEE extends Section>

java.lang.Object

org.refcodes.serial.AbstractTransmissionDecorator<DECORATEE>

org.refcodes.serial.BreakerSectionDecorator<DECORATEE>

Type Parameters:

DECORATEE - The Section type describing the Section subclass to be "enriched" with breaking functionality.

All Implemented Interfaces:

Serializable, org.refcodes.mixin.DecorateeAccessor<DECORATEE>, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.Resetable, org.refcodes.schema.Schemable, DecoratorSection<DECORATEE>, Section, Transmission, Transmission.TransmissionMixin

public class BreakerSectionDecorator<DECORATEE extends Section>
extends AbstractTransmissionDecorator<DECORATEE>
implements DecoratorSection<DECORATEE>, org.refcodes.mixin.Resetable

The BreakerSectionDecorator is a DecoratorSection build to test error detection and error correction Transmission implementations such as the CrcSectionDecorator or the StopAndWaitSectionDecorator. To achieve this, the BreakerSectionDecorator can be configured to "break" deserialization for a given number of times by intercepting into the according Transmission's methods and throwing a TransmissionSequenceException.

See Also:

• Serialized Form

Nested Class Summary

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

Section.SectionMixin

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

Transmission.TransmissionMixin

Field Summary

Fields

Modifier and Type	Field	Description
protected int	_breakCount
protected int	_breakNumber
protected long	_startTime
static final String	BREAK_COUNT
static final String	BREAK_NUMBER

Fields inherited from class org.refcodes.serial.AbstractTransmissionDecorator

_decoratee

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BreakerSectionDecorator()	Constructs an empty BreakerSectionDecorator.
	BreakerSectionDecorator(DECORATEE aDecoratee, int aBreakNumber)	Constructs a BreakerSectionDecorator instance with the given decoratee breaking deserialization of the decorated segments by the given number of times.fter the total number of breaking the decoratee has been reached, the decorator behaves transparent (it just delegates without breaking the decoratee any more).

Method Summary

Modifier and Type	Method	Description
void	fromTransmission(Sequence aSequence, int aOffset, int aLength)	(Re-)initializes this instance with the the given Sequence data.
void	receiveFrom(InputStream aInputStream, int aLength, OutputStream aReturnStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.
void	reset()	Resets any dynamic data (e.g. values such as payloads or checksums) and must not(!)
SerialSchema	toSchema()

Methods inherited from class org.refcodes.serial.AbstractTransmissionDecorator

equals, getDecoratee, getLength, hashCode, toSequence, toSimpleTypeMap, toString

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

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

getLength, toSequence, toSimpleTypeMap, transmitTo, transmitTo

Methods inherited from interface org.refcodes.serial.Transmission.TransmissionMixin

transmitTo

Field Details

BREAK_NUMBER

public static final String BREAK_NUMBER

See Also:

• Constant Field Values

BREAK_COUNT

public static final String BREAK_COUNT

See Also:

• Constant Field Values

_breakNumber

protected int _breakNumber

_breakCount

protected int _breakCount

_startTime

protected long _startTime

Constructor Details

BreakerSectionDecorator

protected BreakerSectionDecorator()

Constructs an empty BreakerSectionDecorator.

BreakerSectionDecorator

public BreakerSectionDecorator(DECORATEE aDecoratee,
 int aBreakNumber)

Constructs a BreakerSectionDecorator instance with the given decoratee breaking deserialization of the decorated segments by the given number of times.fter the total number of breaking the decoratee has been reached, the decorator behaves transparent (it just delegates without breaking the decoratee any more). This is good to see if a retry mechanism works when using some kind of error correction segment.

Parameters:

aDecoratee - The decoratee to be contained by this facade.

aBreakNumber - The number of times to break deserialization.

Method Details

fromTransmission

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

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

Specified by:

fromTransmission in interface Section

Parameters:

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

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

aLength - The length of data assigned by the Sequence.

Throws:

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

receiveFrom

public void receiveFrom(InputStream aInputStream,
 int aLength,
 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 Section

Parameters:

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

aLength - The length of data assigned by the byte array.

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 InputStream bytes cannot be processed.

toSchema

public SerialSchema toSchema()

Specified by:

toSchema in interface org.refcodes.schema.Schemable

Specified by:

toSchema in interface Transmission

reset

public void reset()

Resets any dynamic data (e.g. values such as payloads or checksums) and must not(!) reset any configurations or settings required to produce the dynamic data (e.g. the TransmissionMetrics).

Specified by:

reset in interface org.refcodes.mixin.Resetable

Specified by:

reset in interface Transmission

Overrides:

reset in class AbstractTransmissionDecorator<DECORATEE extends Section>