o2::framework::DataProcessingHeader Struct Reference

#include <DataProcessingHeader.h>

Inherits o2::header::BaseHeader.

Public Types
using	StartTime = uint64_t
using	Duration = uint64_t
using	CreationTime = uint64_t

Public Member Functions
	DataProcessingHeader ()
	DataProcessingHeader (StartTime s)
	DataProcessingHeader (StartTime s, Duration d)
	DataProcessingHeader (StartTime s, Duration d, CreationTime t)
	DataProcessingHeader (const DataProcessingHeader &)=default
Public Member Functions inherited from o2::header::BaseHeader
	BaseHeader ()=delete
	dont construct directly
	BaseHeader (const BaseHeader &)=default
constexpr	BaseHeader (uint32_t mySize, HeaderType desc, SerializationMethod ser, uint32_t version)
	Special ctor for initialization in derived types.
constexpr uint32_t	size () const noexcept
const std::byte *	data () const noexcept
const BaseHeader *	next () const noexcept
	get the next header if any (const version)
BaseHeader *	next () noexcept
	get the next header if any (non-const version)
bool	sanityCheck (uint32_t expectedVersion) const
void	throwInconsistentStackError () const

Static Public Member Functions
static uint64_t	getCreationTime ()
static const DataProcessingHeader *	Get (const BaseHeader *baseHeader)
Static Public Member Functions inherited from o2::header::BaseHeader
static const BaseHeader *	get (const std::byte *b, size_t=0)
	access header in buffer
static BaseHeader *	get (std::byte *b, size_t=0)
	access header in buffer

Public Attributes
StartTime	startTime
Duration	duration
CreationTime	creation
Public Attributes inherited from o2::header::BaseHeader
union {
char   magicString [gSizeMagicString]
uint32_t   magicStringInt
};
	a magic string, used to identify an O2 header in a raw stream of bytes
uint32_t	headerSize
union {
uint32_t   flags
struct {
uint32_t   flagsNextHeader: 1
uint32_t   flagsReserved: 15
uint32_t   flagsDerivedHeader: 16
}
};
	flags, first bit indicates that a sub header follows
uint32_t	headerVersion
	version of the entire header, set by the derived header
o2::header::HeaderType	description
	header type description, set by derived header
o2::header::SerializationMethod	serialization
	header serialization method, set by derived header

Static Public Attributes
static constexpr uint64_t	DUMMY_CREATION_TIME_OFFSET = 0x8000000000000000
static constexpr int32_t	KEEP_AT_EOS_FLAG = 1
static constexpr const o2::header::HeaderType	sHeaderType = "DataFlow"
static const uint32_t	sVersion = 1
Static Public Attributes inherited from o2::header::BaseHeader
static constexpr uint32_t	sMagicString {String2<uint32_t>("O2O2")}
static const uint32_t	sVersion = o2::header::gInvalidToken32
static const o2::header::HeaderType	sHeaderType = o2::header::gInvalidToken64
static const o2::header::SerializationMethod	sSerializationMethod = o2::header::gInvalidToken64

Detailed Description

Definition at line 43 of file DataProcessingHeader.h.

Member Typedef Documentation

CreationTime

using o2::framework::DataProcessingHeader::CreationTime = uint64_t

Definition at line 66 of file DataProcessingHeader.h.

Duration

using o2::framework::DataProcessingHeader::Duration = uint64_t

Definition at line 65 of file DataProcessingHeader.h.

StartTime

using o2::framework::DataProcessingHeader::StartTime = uint64_t

Definition at line 64 of file DataProcessingHeader.h.

Constructor & Destructor Documentation

DataProcessingHeader() [1/5]

o2::framework::DataProcessingHeader::DataProcessingHeader ( )

inline

Definition at line 84 of file DataProcessingHeader.h.

DataProcessingHeader() [2/5]

o2::framework::DataProcessingHeader::DataProcessingHeader ( StartTime  s )

inline

Definition at line 89 of file DataProcessingHeader.h.

DataProcessingHeader() [3/5]

o2::framework::DataProcessingHeader::DataProcessingHeader ( StartTime  s, Duration  d  )

inline

Definition at line 94 of file DataProcessingHeader.h.

DataProcessingHeader() [4/5]

o2::framework::DataProcessingHeader::DataProcessingHeader ( StartTime  s, Duration  d, CreationTime  t  )

inline

Definition at line 102 of file DataProcessingHeader.h.

DataProcessingHeader() [5/5]

o2::framework::DataProcessingHeader::DataProcessingHeader ( const DataProcessingHeader &  )

default

Member Function Documentation

Get()

static const DataProcessingHeader * o2::framework::DataProcessingHeader::Get ( const BaseHeader *  baseHeader )

inlinestatic

Definition at line 111 of file DataProcessingHeader.h.

getCreationTime()

static uint64_t o2::framework::DataProcessingHeader::getCreationTime ( )

inlinestatic

We return some number of milliseconds, offsetting int by 0x8000000000000000 to make sure we can understand when the dummy constructor of DataProcessingHeader was used without overriding it with an actual real time from epoch. This creation time is not meant to be used for anything but to understand the relative creation of messages in the flow. Notice that for the case DataProcessingHeader::creation has some particular meaning, we expect this function not to be used.

Definition at line 54 of file DataProcessingHeader.h.

Member Data Documentation

creation

CreationTime o2::framework::DataProcessingHeader::creation

Definition at line 78 of file DataProcessingHeader.h.

DUMMY_CREATION_TIME_OFFSET

constexpr uint64_t o2::framework::DataProcessingHeader::DUMMY_CREATION_TIME_OFFSET = 0x8000000000000000

staticconstexpr

Definition at line 44 of file DataProcessingHeader.h.

duration

Duration o2::framework::DataProcessingHeader::duration

data duration

Definition at line 76 of file DataProcessingHeader.h.

KEEP_AT_EOS_FLAG

constexpr int32_t o2::framework::DataProcessingHeader::KEEP_AT_EOS_FLAG = 1

staticconstexpr

Definition at line 46 of file DataProcessingHeader.h.

sHeaderType

constexpr const o2::header::HeaderType o2::framework::DataProcessingHeader::sHeaderType = "DataFlow"

staticconstexpr

Definition at line 60 of file DataProcessingHeader.h.

startTime

StartTime o2::framework::DataProcessingHeader::startTime

data start time

Definition at line 71 of file DataProcessingHeader.h.

sVersion

const uint32_t o2::framework::DataProcessingHeader::sVersion = 1

static

Definition at line 61 of file DataProcessingHeader.h.

---

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

• /home/runner/work/AliceO2/AliceO2/Framework/Core/include/Framework/DataProcessingHeader.h