java.lang.Object
org.refcodes.serial.AbstractReferenceeLengthSegment<AllocSegmentBody<?>>
org.refcodes.serial.AllocSegmentHead
- All Implemented Interfaces:
Serializable
,org.refcodes.mixin.BodyAccessor<AllocSegmentBody<?>>
,org.refcodes.mixin.BodyAccessor.BodyMutator<AllocSegmentBody<?>>
,org.refcodes.mixin.BodyAccessor.BodyProperty<AllocSegmentBody<?>>
,org.refcodes.mixin.LengthAccessor
,org.refcodes.mixin.Resetable
,org.refcodes.mixin.Schemable
,org.refcodes.numerical.EndianessAccessor
,AllocLengthAccessor
,LengthWidthAccessor
,Segment
,Transmission
,Transmission.TransmissionMixin
public class AllocSegmentHead
extends AbstractReferenceeLengthSegment<AllocSegmentBody<?>>
implements org.refcodes.mixin.BodyAccessor.BodyProperty<AllocSegmentBody<?>>
An
AllocSegmentHead
provides the allocation length for a
AllocSegmentBody
. Therefore the AllocSegmentHead
references a
AllocSegmentBody
. The AllocSegmentHead
manages the
Sequence
regarding the allocation length whereas the
AllocSegmentBody
manages the decorated Segment
by harnessing
the allocation length provided by the AllocSegmentHead
.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.refcodes.serial.AllocLengthAccessor
AllocLengthAccessor.AllocLengthBuilder<B extends AllocLengthAccessor.AllocLengthBuilder<B>>, AllocLengthAccessor.AllocLengthMutator, AllocLengthAccessor.AllocLengthProperty
Nested classes/interfaces inherited from interface org.refcodes.mixin.BodyAccessor
org.refcodes.mixin.BodyAccessor.BodyBuilder<T extends Object,
B extends org.refcodes.mixin.BodyAccessor.BodyBuilder<T, B>>, org.refcodes.mixin.BodyAccessor.BodyMutator<T extends Object>, org.refcodes.mixin.BodyAccessor.BodyProperty<T extends Object> Nested classes/interfaces inherited from interface org.refcodes.numerical.EndianessAccessor
org.refcodes.numerical.EndianessAccessor.EndianessBuilder<B extends org.refcodes.numerical.EndianessAccessor.EndianessBuilder<B>>, org.refcodes.numerical.EndianessAccessor.EndianessMutator, org.refcodes.numerical.EndianessAccessor.EndianessProperty
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.LengthWidthAccessor
LengthWidthAccessor.LengthWidthBuilder<B extends LengthWidthAccessor.LengthWidthBuilder<B>>, LengthWidthAccessor.LengthWidthMutator, LengthWidthAccessor.LengthWidthProperty
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.AbstractReferenceeLengthSegment
_allocLength, _endianess, _lengthWidth, _referencee, ALLOC_LENGTH, ALLOC_LENGTH_WIDTH, ENDIANESS
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructs an empty head with a width ofTransmissionMetrics.DEFAULT_LENGTH_WIDTH
bytes used to specify the body's length and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of the body's length.protected
AllocSegmentHead
(int aLengthWidth) Constructs an empty head with the given number of bytes used to specify the body's length and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of the body's length.protected
AllocSegmentHead
(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess) Constructs an empty head with a width ofTransmissionMetrics.DEFAULT_LENGTH_WIDTH
bytes used to specify the body's length and the providedEndianess
representation of the body's length.protected
AllocSegmentHead
(org.refcodes.numerical.Endianess aEndianess) Constructs an empty head with a width ofTransmissionMetrics.DEFAULT_LENGTH_WIDTH
bytes used to specify the body's length and the providedEndianess
representation of the body's length.AllocSegmentHead
(AllocSegmentBody<?> aBody) Constructs the head with the given body and a width ofTransmissionMetrics.DEFAULT_LENGTH_WIDTH
bytes used to specify the body's length aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of the body's length.AllocSegmentHead
(AllocSegmentBody<?> aBody, int aLengthWidth) Constructs the head with the given body and with the given number of bytes used to specify the body's length and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of the body's length.AllocSegmentHead
(AllocSegmentBody<?> aBody, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess) Constructs the head with the given body and with the given number of bytes used to specify the body's length and the providedEndianess
representation of the body's length.AllocSegmentHead
(AllocSegmentBody<?> aBody, org.refcodes.numerical.Endianess aEndianess) Constructs the head with the given body and a width ofTransmissionMetrics.DEFAULT_LENGTH_WIDTH
bytes used to specify the body's length and the providedEndianess
representation of the body's length.AllocSegmentHead
(AllocSegmentBody<?> aBody, TransmissionMetrics aTransmissionMetrics) Constructs the head with the given body.protected
AllocSegmentHead
(TransmissionMetrics aTransmissionMetrics) -
Method Summary
Modifier and TypeMethodDescriptionint
fromTransmission
(Sequence aSequence, int aOffset) (Re-)initializes this instance with the the givenSequence
data.getBody()
void
receiveFrom
(InputStream aInputStream, OutputStream aReturnStream) (Re-)initializes this instance by receiving the accordingSequence
from the givenInputStream
.void
setBody
(AllocSegmentBody<?> aBody) toSchema()
Methods inherited from class org.refcodes.serial.AbstractReferenceeLengthSegment
equals, getAllocLength, getEndianess, getLength, getLengthWidth, hashCode, reset, 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.BodyAccessor.BodyProperty
letBody
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
-
Constructor Details
-
AllocSegmentHead
-
AllocSegmentHead
Constructs the head with the given body. The configuration attributes are taken from theTransmissionMetrics
configuration object, though only those attributes are supported which are also supported by the other constructors!- Parameters:
aBody
- The body referenced by this head.aTransmissionMetrics
- TheTransmissionMetrics
to be used for configuring this instance.
-
AllocSegmentHead
protected AllocSegmentHead()Constructs an empty head with a width ofTransmissionMetrics.DEFAULT_LENGTH_WIDTH
bytes used to specify the body's length and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of the body's length. -
AllocSegmentHead
protected AllocSegmentHead(org.refcodes.numerical.Endianess aEndianess) Constructs an empty head with a width ofTransmissionMetrics.DEFAULT_LENGTH_WIDTH
bytes used to specify the body's length and the providedEndianess
representation of the body's length.- Parameters:
aEndianess
- TheEndianess
to be used for length values.
-
AllocSegmentHead
protected AllocSegmentHead(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess) Constructs an empty head with a width ofTransmissionMetrics.DEFAULT_LENGTH_WIDTH
bytes used to specify the body's length and the providedEndianess
representation of the body's length.- Parameters:
aLengthWidth
- The width (in bytes) to be used for length values.aEndianess
- TheEndianess
to be used for length values.
-
AllocSegmentHead
protected AllocSegmentHead(int aLengthWidth) Constructs an empty head with the given number of bytes used to specify the body's length and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of the body's length.- Parameters:
aLengthWidth
- The width (in bytes) to be used for length values.
-
AllocSegmentHead
Constructs the head with the given body and a width ofTransmissionMetrics.DEFAULT_LENGTH_WIDTH
bytes used to specify the body's length and the providedEndianess
representation of the body's length.- Parameters:
aBody
- The body referenced by this head.aEndianess
- TheEndianess
to be used for length values.
-
AllocSegmentHead
public AllocSegmentHead(AllocSegmentBody<?> aBody, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess) Constructs the head with the given body and with the given number of bytes used to specify the body's length and the providedEndianess
representation of the body's length.- Parameters:
aBody
- The body referenced by this head.aLengthWidth
- The width (in bytes) to be used for length values.aEndianess
- TheEndianess
to be used for length values.
-
AllocSegmentHead
Constructs the head with the given body and with the given number of bytes used to specify the body's length and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of the body's length.- Parameters:
aBody
- The body referenced by this head.aLengthWidth
- The width (in bytes) to be used for length values.
-
AllocSegmentHead
Constructs the head with the given body and a width ofTransmissionMetrics.DEFAULT_LENGTH_WIDTH
bytes used to specify the body's length aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of the body's length.- Parameters:
aBody
- The body referenced by this head.
-
-
Method Details
-
fromTransmission
(Re-)initializes this instance with the the givenSequence
data.- Specified by:
fromTransmission
in interfaceSegment
- Overrides:
fromTransmission
in classAbstractReferenceeLengthSegment<AllocSegmentBody<?>>
- Parameters:
aSequence
- TheSequence
data from which to (re-)initialize this instance.aOffset
- The offset where to start processing the providedSequence
.- Returns:
- The index after the last offset into the given
Sequence
processed by this method. - Throws:
TransmissionException
- thrown in case a givenSequence
cannot be processed.
-
receiveFrom
(Re-)initializes this instance by receiving the accordingSequence
from the givenInputStream
. Implementations providing error correction methods use the provided feedbackOutputStream
to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the received data.- Specified by:
receiveFrom
in interfaceSegment
- Overrides:
receiveFrom
in classAbstractReferenceeLengthSegment<AllocSegmentBody<?>>
- Parameters:
aInputStream
- TheInputStream
from which to read the instance's (re-)initializationSequence
from.aReturnStream
- AnOutputStream
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 theInputStream
caused problems.TransmissionException
- thrown in case a given transmission cannot be processed.
-
toSchema
- Specified by:
toSchema
in interfaceorg.refcodes.mixin.Schemable
- Specified by:
toSchema
in interfaceTransmission
- Overrides:
toSchema
in classAbstractReferenceeLengthSegment<AllocSegmentBody<?>>
-
getBody
- Specified by:
getBody
in interfaceorg.refcodes.mixin.BodyAccessor<AllocSegmentBody<?>>
-
setBody
- Specified by:
setBody
in interfaceorg.refcodes.mixin.BodyAccessor.BodyMutator<AllocSegmentBody<?>>
-