o2::framework::DataProcessingHelpers Struct Reference

Generic helpers for DataProcessing releated functions. More...

#include <DataProcessingHelpers.h>

Static Public Member Functions
static void	sendEndOfStream (ServiceRegistryRef const &ref, OutputChannelSpec const &channel)
static bool	sendOldestPossibleTimeframe (ServiceRegistryRef const &ref, ForwardChannelInfo const &info, ForwardChannelState &state, size_t timeslice)
static bool	sendOldestPossibleTimeframe (ServiceRegistryRef const &ref, OutputChannelInfo const &info, OutputChannelState &state, size_t timeslice)
static void	broadcastOldestPossibleTimeslice (ServiceRegistryRef const &ref, size_t timeslice)
	Broadcast the oldest possible timeslice to all channels in output.
static void	switchState (ServiceRegistryRef const &ref, StreamingState newState)
	change the device StreamingState to newState
static bool	hasOnlyGenerated (DeviceSpec const &spec)
	check if spec is a source devide
static TransitionHandlingState	updateStateTransition (ServiceRegistryRef const &ref, ProcessingPolicies const &policies)
	starts the EoS timers and returns the new TransitionHandlingState in case as new state is requested
static std::vector< fair::mq::Parts >	routeForwardedMessageSet (FairMQDeviceProxy &proxy, std::vector< MessageSet > &currentSetOfInputs, bool copy, bool consume)
	Helper to route messages for forwarding.
static void	routeForwardedMessages (FairMQDeviceProxy &proxy, std::span< fair::mq::MessagePtr > &currentSetOfInputs, std::vector< fair::mq::Parts > &forwardedParts, bool copy, bool consume)
	Helper to route messages for forwarding.
static void	cleanForwardedMessages (std::span< fair::mq::MessagePtr > &currentSetOfInputs, bool consume)

Detailed Description

Generic helpers for DataProcessing releated functions.

Definition at line 38 of file DataProcessingHelpers.h.

Member Function Documentation

broadcastOldestPossibleTimeslice()

void o2::framework::DataProcessingHelpers::broadcastOldestPossibleTimeslice ( ServiceRegistryRef const &  ref, size_t  timeslice  )

static

Broadcast the oldest possible timeslice to all channels in output.

Definition at line 111 of file DataProcessingHelpers.cxx.

cleanForwardedMessages()

void o2::framework::DataProcessingHelpers::cleanForwardedMessages ( std::span< fair::mq::MessagePtr > &  currentSetOfInputs, bool  consume  )

static

Definition at line 341 of file DataProcessingHelpers.cxx.

hasOnlyGenerated()

bool o2::framework::DataProcessingHelpers::hasOnlyGenerated ( DeviceSpec const &  spec )

static

check if spec is a source devide

Definition at line 137 of file DataProcessingHelpers.cxx.

routeForwardedMessages()

void o2::framework::DataProcessingHelpers::routeForwardedMessages ( FairMQDeviceProxy &  proxy, std::span< fair::mq::MessagePtr > &  currentSetOfInputs, std::vector< fair::mq::Parts > &  forwardedParts, bool  copy, bool  consume  )

static

Helper to route messages for forwarding.

Definition at line 231 of file DataProcessingHelpers.cxx.

routeForwardedMessageSet()

auto o2::framework::DataProcessingHelpers::routeForwardedMessageSet ( FairMQDeviceProxy &  proxy, std::vector< MessageSet > &  currentSetOfInputs, bool  copy, bool  consume  )

static

Helper to route messages for forwarding.

Definition at line 395 of file DataProcessingHelpers.cxx.

sendEndOfStream()

void o2::framework::DataProcessingHelpers::sendEndOfStream ( ServiceRegistryRef const &  ref, OutputChannelSpec const &  channel  )

static

Send EndOfStream message to a given channel

Parameters

device	the fair::mq::Device which needs to send the EndOfStream message
channel	the OutputChannelSpec of the channel which needs to be signaled for EndOfStream

Definition at line 52 of file DataProcessingHelpers.cxx.

sendOldestPossibleTimeframe() [1/2]

bool o2::framework::DataProcessingHelpers::sendOldestPossibleTimeframe ( ServiceRegistryRef const &  ref, ForwardChannelInfo const &  info, ForwardChannelState &  state, size_t  timeslice  )

static

Returns

true if we did send the oldest possible timeslice message, false otherwise.

Definition at line 85 of file DataProcessingHelpers.cxx.

sendOldestPossibleTimeframe() [2/2]

bool o2::framework::DataProcessingHelpers::sendOldestPossibleTimeframe ( ServiceRegistryRef const &  ref, OutputChannelInfo const &  info, OutputChannelState &  state, size_t  timeslice  )

static

Returns

true if we did send the oldest possible timeslice message, false otherwise.

Definition at line 98 of file DataProcessingHelpers.cxx.

switchState()

void o2::framework::DataProcessingHelpers::switchState ( ServiceRegistryRef const &  ref, StreamingState  newState  )

static

change the device StreamingState to newState

Definition at line 121 of file DataProcessingHelpers.cxx.

updateStateTransition()

TransitionHandlingState o2::framework::DataProcessingHelpers::updateStateTransition ( ServiceRegistryRef const &  ref, ProcessingPolicies const &  policies  )

static

starts the EoS timers and returns the new TransitionHandlingState in case as new state is requested

Definition at line 178 of file DataProcessingHelpers.cxx.

---

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

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