Module org.refcodes.serial

Package org.refcodes.serial

Interface ArraySegment<SEGMENT extends Segment>

Type Parameters:

SEGMENT - The type of the array Segment elements.

All Superinterfaces:

org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.ArrayAccessor<SEGMENT[]>, org.refcodes.mixin.ArrayAccessor.ArrayBuilder<SEGMENT[],ArrayTransmission<SEGMENT>>, org.refcodes.mixin.ArrayAccessor.ArrayMutator<SEGMENT[]>, org.refcodes.mixin.ArrayAccessor.ArrayProperty<SEGMENT[]>, ArrayTransmission<SEGMENT>, org.refcodes.mixin.LengthAccessor, Segment, Segment.SegmentMixin, Serializable, Transmission, Transmission.TransmissionMixin

public interface ArraySegment<SEGMENT extends Segment>
extends Segment.SegmentMixin, Segment, ArrayTransmission<SEGMENT>

A ArraySegment is a Segment with array Segment elements as of ArrayTransmission.

Nested Class Summary

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

org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

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

org.refcodes.mixin.ArrayAccessor.ArrayBuilder<T extends Object,B extends org.refcodes.mixin.ArrayAccessor.ArrayBuilder<T,B>>, org.refcodes.mixin.ArrayAccessor.ArrayMutator<T extends Object>, org.refcodes.mixin.ArrayAccessor.ArrayProperty<T 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.Segment

Segment.SegmentMixin

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

Transmission.TransmissionMixin

Method Summary

Modifier and Type	Method	Description
default int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
default void	receiveFrom(InputStream aInputStream, OutputStream aReturnStream)	Default implementation harnessing the Segment.fromTransmission(Sequence) method.

Methods inherited from interface org.refcodes.mixin.AliasAccessor

getAlias

Methods inherited from interface org.refcodes.mixin.ArrayAccessor

getArray

Methods inherited from interface org.refcodes.mixin.ArrayAccessor.ArrayBuilder

withArray

Methods inherited from interface org.refcodes.mixin.ArrayAccessor.ArrayMutator

setArray

Methods inherited from interface org.refcodes.mixin.ArrayAccessor.ArrayProperty

letArray

Methods inherited from interface org.refcodes.serial.ArrayTransmission

getLength, toSchema, toSequence, toSimpleTypeMap

Methods inherited from interface org.refcodes.serial.Segment

fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom

Methods inherited from interface org.refcodes.serial.Transmission

transmitTo, transmitTo

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

transmitTo

Method Detail

fromTransmission

default 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

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

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

Specified by:

receiveFrom in interface Segment.SegmentMixin

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.