Module org.refcodes.serial
Package org.refcodes.serial

Class BreakerSegmentDecorator<DECORATEE extends Segment>

java.lang.Object
org.refcodes.serial.AbstractTransmissionDecorator<DECORATEE>
org.refcodes.serial.BreakerSegmentDecorator<DECORATEE>
Type Parameters:
DECORATEE - The Segment type describing the Segment subclass to be "enriched" with breaking functionality.
All Implemented Interfaces:
Serializable, org.refcodes.component.Resetable, org.refcodes.mixin.DecorateeAccessor<DECORATEE>, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.Schemable<SerialSchema>, DecoratorSegment<DECORATEE>, Segment, Transmission, Transmission.TransmissionMixin
public class BreakerSegmentDecorator<DECORATEE extends Segment> extends AbstractTransmissionDecorator<DECORATEE> implements DecoratorSegment<DECORATEE>, org.refcodes.component.Resetable
The BreakerSegmentDecorator is a DecoratorSegment build to test error detection and error correction Transmission implementations such as the CrcSegmentDecorator or the StopAndWaitSegmentDecorator. To achieve this, the BreakerSegmentDecorator 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:

  • Field Details

    • BREAK_NUMBER

      public static final String BREAK_NUMBER
      See Also:

    • BREAK_COUNT

      public static final String BREAK_COUNT
      See Also:

    • _breakNumber

      protected int _breakNumber

    • _breakCount

      protected int _breakCount

    • _startTime

      protected long _startTime

  • Constructor Details

    • BreakerSegmentDecorator

      protected BreakerSegmentDecorator()
      Constructs an empty BreakerSegmentDecorator.

    • BreakerSegmentDecorator

      public BreakerSegmentDecorator(DECORATEE aDecoratee, int aBreakNumber)
      Constructs a BreakerSegmentDecorator 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 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.

    • toSchema

      public SerialSchema toSchema()
      Retrieves the SerialSchema representing the Transmission. Retrieving a SerialSchema is useful when analyzing and debugging data structures such as a AllocSectionDecoratorSegment instance to help document, learn and verify on the structure (as well as the content) of that very AllocSectionDecoratorSegment.
      Specified by:
      toSchema in interface org.refcodes.mixin.Schemable<DECORATEE extends Segment>
      Specified by:
      toSchema in interface Transmission
      Returns:
      The SerialSchema representation of the implementing type for debugging and verification (or documentation) purposes.

    • reset

      public void reset()
      Specified by:
      reset in interface org.refcodes.component.Resetable