a BaseHeader with state information from the source More...

#include <SourceInfoHeader.h>

Public Member Functions
	SourceInfoHeader ()

	SourceInfoHeader (const SourceInfoHeader &)=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 const SourceInfoHeader *	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
InputChannelState	state = InputChannelState::Running

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 const o2::header::HeaderType	sHeaderType = "SrcInfo"

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

a BaseHeader with state information from the source

This header can be associated to a given O2 message to notify the receiving side what is the state of the preceding dataprocessor in the dag associated to a given channel.

Definition at line 39 of file SourceInfoHeader.h.

Constructor & Destructor Documentation

◆ SourceInfoHeader() [1/2]

o2::framework::SourceInfoHeader::SourceInfoHeader ( )

inline

Definition at line 43 of file SourceInfoHeader.h.

◆ SourceInfoHeader() [2/2]

o2::framework::SourceInfoHeader::SourceInfoHeader ( const SourceInfoHeader & )

default

Member Function Documentation

◆ Get()

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

inlinestatic

Definition at line 51 of file SourceInfoHeader.h.

Member Data Documentation

◆ sHeaderType

constexpr o2::header::HeaderType o2::framework::SourceInfoHeader::sHeaderType = "SrcInfo"

staticconstexpr

Definition at line 40 of file SourceInfoHeader.h.

◆ state

InputChannelState o2::framework::SourceInfoHeader::state = InputChannelState::Running

Definition at line 48 of file SourceInfoHeader.h.

◆ sVersion

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

static

Definition at line 41 of file SourceInfoHeader.h.

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

/home/runner/work/AliceO2/AliceO2/Framework/Core/include/Framework/SourceInfoHeader.h
/home/runner/work/AliceO2/AliceO2/Framework/Core/src/SourceInfoHeader.cxx

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes