Project
Loading...
Searching...
No Matches
o2::framework::ControlService Class Reference

#include <ControlService.h>

Public Member Functions

 ControlService (ServiceRegistryRef registry, DeviceState &deviceState)
 
void readyToQuit (bool all)
 Compatibility with old API.
 
void readyToQuit (QuitRequest kind)
 
void endOfStream ()
 Signal that we are done with the current stream.
 
void notifyStreamingState (StreamingState state)
 Report the current streaming state of a given device.
 
void push (std::string_view key, std::string_view value, int64_t timestamp)
 Push a generic key/value pair to the driver.
 
void notifyDeviceState (std::string state)
 Report the current FairMQ state of a given device.
 

Static Public Attributes

static constexpr ServiceKind service_kind = ServiceKind::Global
 

Detailed Description

A service that data processors can use to talk to control and ask for their own state change or others. A ControlService is requried to be a ServiceKind::Global kind of service.

Definition at line 39 of file ControlService.h.

Constructor & Destructor Documentation

◆ ControlService()

o2::framework::ControlService::ControlService ( ServiceRegistryRef  registry,
DeviceState deviceState 
)

Definition at line 27 of file ControlService.cxx.

Member Function Documentation

◆ endOfStream()

void o2::framework::ControlService::endOfStream ( )

Signal that we are done with the current stream.

Definition at line 35 of file ControlService.cxx.

◆ notifyDeviceState()

void o2::framework::ControlService::notifyDeviceState ( std::string  state)

Report the current FairMQ state of a given device.

Definition at line 85 of file ControlService.cxx.

◆ notifyStreamingState()

void o2::framework::ControlService::notifyStreamingState ( StreamingState  state)

Report the current streaming state of a given device.

Definition at line 61 of file ControlService.cxx.

◆ push()

void o2::framework::ControlService::push ( std::string_view  key,
std::string_view  value,
int64_t  timestamp 
)

Push a generic key/value pair to the driver.

Definition at line 79 of file ControlService.cxx.

◆ readyToQuit() [1/2]

void o2::framework::ControlService::readyToQuit ( bool  all)
inline

Compatibility with old API.

Definition at line 46 of file ControlService.h.

◆ readyToQuit() [2/2]

void o2::framework::ControlService::readyToQuit ( QuitRequest  kind)

Signal control that we are potentially ready to quit some / all dataprocessor.

Definition at line 42 of file ControlService.cxx.

Member Data Documentation

◆ service_kind

constexpr ServiceKind o2::framework::ControlService::service_kind = ServiceKind::Global
staticconstexpr

Definition at line 42 of file ControlService.h.


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