o2::header::HeartbeatFrameEnvelope Struct Reference

#include <HeartbeatFrame.h>

Inherits o2::header::BaseHeader.

Public Member Functions
	HeartbeatFrameEnvelope ()
	HeartbeatFrameEnvelope (const HeartbeatHeader &h, const HeartbeatTrailer &t)
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

Public Attributes
HeartbeatHeader	header
HeartbeatTrailer	trailer
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 const uint32_t	sVersion = 1
static const o2::header::HeaderType	sHeaderType = String2<uint64_t>("HBFEnvel")
static const o2::header::SerializationMethod	sSerializationMethod = o2::header::gSerializationMethodNone
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

Additional Inherited Members
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

Detailed Description

Definition at line 116 of file HeartbeatFrame.h.

Constructor & Destructor Documentation

HeartbeatFrameEnvelope() [1/2]

o2::header::HeartbeatFrameEnvelope::HeartbeatFrameEnvelope ( )

inline

Definition at line 125 of file HeartbeatFrame.h.

HeartbeatFrameEnvelope() [2/2]

o2::header::HeartbeatFrameEnvelope::HeartbeatFrameEnvelope ( const HeartbeatHeader &  h, const HeartbeatTrailer &  t  )

inline

Definition at line 128 of file HeartbeatFrame.h.

Member Data Documentation

header

HeartbeatHeader o2::header::HeartbeatFrameEnvelope::header

Definition at line 122 of file HeartbeatFrame.h.

sHeaderType

const o2::header::HeaderType o2::header::HeartbeatFrameEnvelope::sHeaderType = String2<uint64_t>("HBFEnvel")

static

Definition at line 119 of file HeartbeatFrame.h.

sSerializationMethod

const o2::header::SerializationMethod o2::header::HeartbeatFrameEnvelope::sSerializationMethod = o2::header::gSerializationMethodNone

static

Definition at line 120 of file HeartbeatFrame.h.

sVersion

const uint32_t o2::header::HeartbeatFrameEnvelope::sVersion = 1

static

Definition at line 118 of file HeartbeatFrame.h.

trailer

HeartbeatTrailer o2::header::HeartbeatFrameEnvelope::trailer

Definition at line 123 of file HeartbeatFrame.h.

---

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

• /home/runner/work/AliceO2/AliceO2/DataFormats/Headers/include/Headers/HeartbeatFrame.h
• /home/runner/work/AliceO2/AliceO2/DataFormats/Headers/src/HeartbeatFrame.cxx