Module org.refcodes.serial

Package org.refcodes.serial

Class MagicBytesSegmentMultiplexer

java.lang.Object

org.refcodes.serial.AbstractMagicBytesTransmissionMultiplexer<Segment>

org.refcodes.serial.MagicBytesSegmentMultiplexer

All Implemented Interfaces:

Serializable, Iterable<Segment>, org.refcodes.mixin.ChildrenAccessor<Segment[]>, org.refcodes.mixin.LengthAccessor, Segment, Transmission

public class MagicBytesSegmentMultiplexer
extends AbstractMagicBytesTransmissionMultiplexer<Segment>
implements Segment, Iterable<Segment>, org.refcodes.mixin.ChildrenAccessor<Segment[]>

THe MagicBytesSegmentMultiplexer dispatches a transmission to one of the aggregated Segment instances depending on the magic number provided by the transmission. A transmission is passed to each of the aggregated Segment instances till one Segment accepts the transmission, e.g. until a Segment does not throw a BadMagicBytesException. To enforce throwing a BadMagicBytesException use a magic bytes Segment or Section which enforces the magic bytes to of a transmission to match its own magic bytes, e.e. use one of the following: AssertMagicBytesSectionDecorator, AssertMagicBytesSegment, AssertMagicBytesSegmentDecorator Attention: A Segment throwing a TransmissionException other than a BadMagicBytesException is considered to be responsible for the transmission so that dispatching is *not* continued with the succeeding Segment! The last Segment which was responsible for a transmission's magic bytes will be the responsible Segment till another Segment claims responsibility for a transmsision's magic bytes. Initially the first Segment passed to this instance is the responsible Segment.

See Also:

Serialized Form

Nested Class Summary

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

org.refcodes.mixin.ChildrenAccessor.ChildrenBuilder<T extends Object,B extends org.refcodes.mixin.ChildrenAccessor.ChildrenBuilder<T,B>>, org.refcodes.mixin.ChildrenAccessor.ChildrenMutator<T extends Object>, org.refcodes.mixin.ChildrenAccessor.ChildrenProperty<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

Field Summary

Fields inherited from class org.refcodes.serial.AbstractMagicBytesTransmissionMultiplexer

_children, _readLimit, _responsibility, DEFAULT_READ_LIMIT

Constructor Summary

Constructors

Constructor	Description
MagicBytesSegmentMultiplexer()
MagicBytesSegmentMultiplexer(int aReadLimit, Segment... aSegments)
MagicBytesSegmentMultiplexer(Collection<Segment> aSegments)
MagicBytesSegmentMultiplexer(Collection<Segment> aSegments, int aReadLimit)
MagicBytesSegmentMultiplexer(Segment... aSegments)

Method Summary

Modifier and Type	Method	Description
int	fromTransmission(byte[] aChunk)	(Re-)initializes this instance with the the given byte array data.
int	fromTransmission(byte[] aChunk, int aOffset)	(Re-)initializes this instance with the the given byte array data.
int	fromTransmission(Sequence aSequence)	(Re-)initializes this instance with the the given Sequence data.
int	fromTransmission(Sequence aSequence, int aOffset)	(Re-)initializes this instance with the the given Sequence data.
void	receiveFrom(InputStream aInputStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.
void	receiveFrom(InputStream aInputStream, OutputStream aReturnStream)	(Re-)initializes this instance by receiving the according Sequence from the given InputStream.
void	receiveFrom(SerialTransceiver aSerialTransceiver)	(Re-)initializes this instance by receiving the according Sequence from the given SerialTransceiver's InputStream.

Methods inherited from class org.refcodes.serial.AbstractMagicBytesTransmissionMultiplexer

getCallee, getChildren, getLength, iterator, toSchema, toSequence, toSimpleTypeMap, transmitTo, transmitTo, transmitTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.mixin.ChildrenAccessor

getChildren

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.refcodes.serial.Transmission

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

Constructor Detail

MagicBytesSegmentMultiplexer

public MagicBytesSegmentMultiplexer()

MagicBytesSegmentMultiplexer

public MagicBytesSegmentMultiplexer(Collection<Segment> aSegments,
                                    int aReadLimit)

MagicBytesSegmentMultiplexer

public MagicBytesSegmentMultiplexer(Collection<Segment> aSegments)

MagicBytesSegmentMultiplexer

public MagicBytesSegmentMultiplexer(int aReadLimit,
                                    Segment... aSegments)

MagicBytesSegmentMultiplexer

public MagicBytesSegmentMultiplexer(Segment... aSegments)

Method Detail

fromTransmission

public int fromTransmission(byte[] aChunk)
                     throws TransmissionException

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

Specified by:

fromTransmission in interface Segment

Parameters:

aChunk - The byte array data from which to (re-)initialize this instance.

Returns:

The index after the last offset into the given byte array processed by this method.

Throws:

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

fromTransmission

public int fromTransmission(Sequence aSequence)
                     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.

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.

fromTransmission

public int fromTransmission(byte[] aChunk,
                            int aOffset)
                     throws TransmissionException

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

Specified by:

fromTransmission in interface Segment

Parameters:

aChunk - The byte array data from which to (re-)initialize this instance.

aOffset - The offset where to start processing the provided byte array.

Returns:

The index after the last offset into the given byte array processed by this method.

Throws:

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

receiveFrom

public void receiveFrom(InputStream aInputStream)
                 throws IOException,
                        TransmissionException

(Re-)initializes this instance by receiving the according Sequence from the given InputStream. This is a convenience method in case there is no feedback OutputStream available (actually the Segment.receiveFrom(InputStream, OutputStream ) method is invoked with null for the feedback OutputStream). Override Segment.receiveFrom(InputStream, OutputStream) for your custom receiving functionality.

Specified by:

receiveFrom in interface Segment

Parameters:

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

Throws:

IOException - thrown in case reading data from the InputStream caused problems.

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

receiveFrom

public void receiveFrom(SerialTransceiver aSerialTransceiver)
                 throws IOException,
                        TransmissionException

(Re-)initializes this instance by receiving the according Sequence from the given SerialTransceiver's InputStream. Implementations providing error correction methods use the provided SerialTransceiver's feedback OutputStream to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the received data. This is a convenience method (actually the Segment.receiveFrom(InputStream, OutputStream ) method is invoked). Override Segment.receiveFrom(InputStream, OutputStream) for your custom receiving functionality.

Specified by:

receiveFrom in interface Segment

Parameters:

aSerialTransceiver - The SerialTransceiver providing the InputStream where to read this instance's Sequence from and providing the OutputStream being the feedback channel to handle "stop-and-wait ARQ".

Throws:

IOException - thrown in case reading data from the InputStream caused problems.

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

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.