famouso::mw::afp::defrag::Headers< DCP > Class Template Reference

AFP Headers of a received fragment. More...

#include <Headers.h>

Public Member Functions
	Headers (const uint8_t *data)
	Create Headers object and read headers from data.
bool	error () const
	Returns true if an error occured while reading headers.
flen_t	length () const
	Returns length of all headers (basic + extension headers).
flen_t	ext_length () const
	Returns length of extension headers.
Data Fields
bool	first_fragment
	True if current fragment is the first fragment of an event.
fcount_t	fseq
	Fragment sequence number.
EventSeqHeader	eseq
	Extension header: event sequence number.
FECHeader	fec
	Extension header: forward error correction.
Protected Attributes
flen_t	all_header_length
	Length of all headers, zero encodes that an error occured while reading headers.
flen_t	ext_header_length
	Length of the extension headers.

---

Detailed Description

template<class DCP>
class famouso::mw::afp::defrag::Headers< DCP >

AFP Headers of a received fragment.

---

Constructor & Destructor Documentation

template<class DCP>

famouso::mw::afp::defrag::Headers< DCP >::Headers

(

const uint8_t *

data

)

[inline]

Create Headers object and read headers from data.

Check for errors via error() afterwards.

References famouso::mw::afp::defrag::Headers< DCP >::all_header_length, famouso::mw::afp::defrag::Headers< DCP >::eseq, famouso::mw::afp::defrag::Headers< DCP >::ext_header_length, famouso::mw::afp::defrag::Headers< DCP >::fec, famouso::mw::afp::defrag::Headers< DCP >::first_fragment, and famouso::mw::afp::defrag::Headers< DCP >::fseq.

---

Member Function Documentation

template<class DCP>

bool famouso::mw::afp::defrag::Headers< DCP >::error

(

)

const [inline]

Returns true if an error occured while reading headers.

References famouso::mw::afp::defrag::Headers< DCP >::all_header_length.

template<class DCP>

flen_t famouso::mw::afp::defrag::Headers< DCP >::ext_length

(

)

const [inline]

Returns length of extension headers.

References famouso::mw::afp::defrag::Headers< DCP >::ext_header_length.

Referenced by famouso::mw::afp::defrag::SingleEventDemux< DCP >::get_defragmenter_handle(), famouso::mw::afp::defrag::MultiSourceDemux< DCP >::get_defragmenter_handle(), and famouso::mw::afp::defrag::EventSeqDemux< DCP >::get_defragmenter_handle().

template<class DCP>

flen_t famouso::mw::afp::defrag::Headers< DCP >::length

(

)

const [inline]

Returns length of all headers (basic + extension headers).

References famouso::mw::afp::defrag::Headers< DCP >::all_header_length.

Referenced by famouso::mw::afp::defrag::SingleEventDemux< DCP >::get_defragmenter_handle(), famouso::mw::afp::defrag::MultiSourceDemux< DCP >::get_defragmenter_handle(), and famouso::mw::afp::defrag::EventSeqDemux< DCP >::get_defragmenter_handle().

---

Field Documentation

template<class DCP>

flen_t famouso::mw::afp::defrag::Headers< DCP >::all_header_length [protected]

Length of all headers, zero encodes that an error occured while reading headers.

Referenced by famouso::mw::afp::defrag::Headers< DCP >::error(), famouso::mw::afp::defrag::Headers< DCP >::Headers(), and famouso::mw::afp::defrag::Headers< DCP >::length().

template<class DCP>

EventSeqHeader famouso::mw::afp::defrag::Headers< DCP >::eseq

Extension header: event sequence number.

Referenced by famouso::mw::afp::defrag::EventSeqDemux< DCP >::get_defragmenter_handle(), and famouso::mw::afp::defrag::Headers< DCP >::Headers().

template<class DCP>

flen_t famouso::mw::afp::defrag::Headers< DCP >::ext_header_length [protected]

Length of the extension headers.

Referenced by famouso::mw::afp::defrag::Headers< DCP >::ext_length(), and famouso::mw::afp::defrag::Headers< DCP >::Headers().

template<class DCP>

FECHeader famouso::mw::afp::defrag::Headers< DCP >::fec

Extension header: forward error correction.

Referenced by famouso::mw::afp::defrag::Headers< DCP >::Headers(), famouso::mw::afp::defrag::OutOfOrderEventDataReconstructor< DCP >::put_fragment(), famouso::mw::afp::defrag::InOrderEventDataReconstructor< DCP >::put_fragment(), and famouso::mw::afp::defrag::FECEventDataReconstructor< DCP >::put_fragment().

template<class DCP>

bool famouso::mw::afp::defrag::Headers< DCP >::first_fragment

True if current fragment is the first fragment of an event.

Referenced by famouso::mw::afp::defrag::SingleEventDemux< DCP >::get_defragmenter_handle(), famouso::mw::afp::defrag::MultiSourceDemux< DCP >::get_defragmenter_handle(), famouso::mw::afp::defrag::Headers< DCP >::Headers(), famouso::mw::afp::defrag::OutOfOrderEventDataReconstructor< DCP >::put_fragment(), and famouso::mw::afp::defrag::InOrderEventDataReconstructor< DCP >::put_fragment().

template<class DCP>

fcount_t famouso::mw::afp::defrag::Headers< DCP >::fseq

Fragment sequence number.

Referenced by famouso::mw::afp::defrag::MultiSourceDemux< DCP >::get_defragmenter_handle(), famouso::mw::afp::defrag::EventSeqDemux< DCP >::get_defragmenter_handle(), famouso::mw::afp::defrag::Headers< DCP >::Headers(), famouso::mw::afp::defrag::DuplicateChecker< DCP >::new_fragment(), famouso::mw::afp::defrag::OutOfOrderEventDataReconstructor< DCP >::put_fragment(), famouso::mw::afp::defrag::InOrderEventDataReconstructor< DCP >::put_fragment(), and famouso::mw::afp::defrag::FECEventDataReconstructor< DCP >::put_fragment().

---

The documentation for this class was generated from the following file:

• include/mw/afp/defrag/Headers.h