dunedaq::dfmessages::TimeSync Struct Reference

A synthetic message used to ensure that all elements of a DAQ system are synchronized. More...

#include <TimeSync.hpp>

Public Member Functions
	TimeSync ()=default
	TimeSync (timestamp_t daq_time, system_time_t sys_time=gettimeofday_us())
	Construct a TimeSync message.
	DUNE_DAQ_SERIALIZE (TimeSync, daq_time, system_time, run_number, sequence_number, source_id)

Static Public Member Functions
static system_time_t	gettimeofday_us ()
	Get the current system time.

Public Attributes
timestamp_t	daq_time { TypeDefaults::s_invalid_timestamp }
	The current DAQ time.
system_time_t	system_time { TypeDefaults::s_invalid_system_time }
	The current system time.
uint64_t	sequence_number { 0 }
	Sequence Number of this message, for debugging.
run_number_t	run_number { 0 }
	Run number at time of creation.
uint32_t	source_id { 0 }
	SourceID::id of the creating DAQModule, for debugging.

Detailed Description

A synthetic message used to ensure that all elements of a DAQ system are synchronized.

Definition at line 24 of file TimeSync.hpp.

Constructor & Destructor Documentation

TimeSync() [1/2]

dunedaq::dfmessages::TimeSync::TimeSync ( )

default

TimeSync() [2/2]

dunedaq::dfmessages::TimeSync::TimeSync ( timestamp_t daq_time, system_time_t sys_time = gettimeofday_us() )

inlineexplicit

Construct a TimeSync message.

Parameters

daq_time	The current DAQ time
sys_time	The current system time. Will be initialized to gettimeofday_us() if unset

Definition at line 44 of file TimeSync.hpp.

    : daq_time(daq_time)
    , system_time(sys_time)
  {}

Member Function Documentation

DUNE_DAQ_SERIALIZE()

dunedaq::dfmessages::TimeSync::DUNE_DAQ_SERIALIZE	(	TimeSync	,
		daq_time	,
		system_time	,
		run_number	,
		sequence_number	,
		source_id	)

gettimeofday_us()

static system_time_t dunedaq::dfmessages::TimeSync::gettimeofday_us ( )

inlinestatic

Get the current system time.

Returns

A system_time_t containing the current system time

system_time_t values are defined as the number of microseconds since the system clock epoch

Definition at line 55 of file TimeSync.hpp.

  {
    struct timeval tv;
    gettimeofday(&tv, nullptr);
    return static_cast<system_time_t>(tv.tv_sec) * 1000000 + tv.tv_usec;
  }

Member Data Documentation

daq_time

timestamp_t dunedaq::dfmessages::TimeSync::daq_time { TypeDefaults::s_invalid_timestamp }

The current DAQ time.

Definition at line 27 of file TimeSync.hpp.

{ TypeDefaults::s_invalid_timestamp };

run_number

run_number_t dunedaq::dfmessages::TimeSync::run_number { 0 }

Run number at time of creation.

Definition at line 33 of file TimeSync.hpp.

{ 0 };

sequence_number

uint64_t dunedaq::dfmessages::TimeSync::sequence_number { 0 }

Sequence Number of this message, for debugging.

Definition at line 31 of file TimeSync.hpp.

{ 0 }; // NOLINT(build/unsigned)

source_id

uint32_t dunedaq::dfmessages::TimeSync::source_id { 0 }

SourceID::id of the creating DAQModule, for debugging.

Definition at line 35 of file TimeSync.hpp.

{ 0 }; // NOLINT(build/unsigned)

system_time

system_time_t dunedaq::dfmessages::TimeSync::system_time { TypeDefaults::s_invalid_system_time }

The current system time.

Definition at line 29 of file TimeSync.hpp.

{ TypeDefaults::s_invalid_system_time };

---

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

• /github/workspace/dunedaq/sourcecode/dfmessages/include/dfmessages/TimeSync.hpp