Module org.refcodes.serial

Package org.refcodes.serial

Interface Segment.SegmentMixin

All Superinterfaces:

org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.Resetable, org.refcodes.mixin.Schemable, Segment, Serializable, Transmission, Transmission.TransmissionMixin

All Known Subinterfaces:

ArraySegment<SEGMENT>

All Known Implementing Classes:

AbstractPayloadSegment, AsciizArraySegment, AsciizSegment, AssertMagicBytesSegment, AssertMagicBytesSegmentDecorator, BooleanSegment, ByteSegment, ComplexTypeSegment, DoubleSegment, EnumSegment, FixedLengthSequenceSegment, FloatSegment, IntSegment, LongSegment, MagicBytesSegment, MagicBytesSegmentDecorator, NumberSegment, SegmentComposite, SequenceNumberSegment, ShortSegment

Enclosing interface:

Segment

public static interface Segment.SegmentMixin
extends Transmission.TransmissionMixin, Segment

Default implementation of the Segment interface providing an implementation of the receiveFrom(InputStream, OutputStream) method using the Segment.fromTransmission(Sequence) method or the Segment.fromTransmission(Sequence, int) method.

Nested Class Summary

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

Segment.SegmentMixin

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

Transmission.TransmissionMixin

Method Summary

Modifier and Type	Method	Description
default void	receiveFrom(InputStream aInputStream, OutputStream aReturnStream)	Default implementation harnessing the Segment.fromTransmission(Sequence) method.

Methods inherited from interface org.refcodes.serial.Segment

fromTransmission, fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

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

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

transmitTo

Method Details

receiveFrom

default void receiveFrom(InputStream aInputStream,
 OutputStream aReturnStream)
                  throws IOException

Default implementation harnessing the Segment.fromTransmission(Sequence) method. (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.