#include <ServiceSpec.h>

Public Attributes
std::string	name = "please specify name"
	Name of the service.

ServiceId	uniqueId = nullptr
	Callback to get the unique id for the Service.

ServiceInit	init = nullptr
	Callback to initialise the service.

ServiceConfigureCallback	configure = nullptr
	Callback to configure the service.

ServiceProcessingCallback	preProcessing = nullptr
	Callback executed before actual processing happens.

ServiceProcessingCallback	finaliseOutputs = nullptr

ServiceProcessingCallback	postProcessing = nullptr
	Callback executed once actual processing happened.

ServiceDanglingCallback	preDangling = nullptr
	Callback executed before the dangling inputs loop.

ServiceDanglingCallback	postDangling = nullptr
	Callback executed after the dangling inputs loop.

ServiceEOSCallback	preEOS = nullptr
	Callback executed before the end of stream callback of the user happended.

ServiceEOSCallback	postEOS = nullptr
	Callback executed after the end of stream callback of the user happended.

ServicePreFork	preFork = nullptr

ServicePostForkChild	postForkChild = nullptr

ServicePostForkParent	postForkParent = nullptr
	Callback executed after forking a given device in the driver.

ServicePreSchedule	preSchedule = nullptr
	Callback executed before and after we schedule a topology.

ServicePostSchedule	postSchedule = nullptr

ServiceMetricHandling	metricHandling = nullptr
	Callback executed after each metric is received by the driver.

ServicePostDispatching	postDispatching = nullptr

ServicePostForwarding	postForwarding = nullptr

ServiceStartCallback	start = nullptr
	Callback invoked on Start.

ServiceStopCallback	stop = nullptr
	Callback invoked on Start.

ServiceExitCallback	exit = nullptr
	Callback invoked on exit.

ServiceDriverInit	driverInit = nullptr
	Callback invoked on driver entering the INIT state.

ServiceDriverStartup	driverStartup = nullptr
	Callback invoked when starting the driver.

ServicePreLoop	preLoop = nullptr
	Callback invoked before the loop starts.

ServiceTopologyInject	injectTopology = nullptr
	Callback invoked when doing topology creation.

ServiceTopologyAdjust	adjustTopology = nullptr
	Callback invoked when finalising topology creation.

ServiceDomainInfoUpdated	domainInfoUpdated = nullptr
	Callback invoked when we get updated about the oldest possible timeslice we can process.

ServicePreSendingMessages	preSendingMessages = nullptr
	Callback invoked when we are about sending a message.

ServicePostRenderGUI	postRenderGUI = nullptr
	Callback invoked after the main GUI has been drawn.

ServiceSummaryHandling	summaryHandling = nullptr
	Callback invoked on the driver quitting.

bool	active = true
	Active flag. If set to false, the service will not be used by default.

ServiceKind	kind = ServiceKind::Serial
	Kind of service being specified.

Detailed Description

A specification for a Service. A Service is a utility class which does not perform data processing itself, but it can be used by the data processor to carry out common tasks (e.g. monitoring) or by the framework to perform data processing related ancillary work (e.g. send messages after a computation happended).

Definition at line 138 of file ServiceSpec.h.

Member Data Documentation

◆ active

bool o2::framework::ServiceSpec::active = true

Active flag. If set to false, the service will not be used by default.

Definition at line 218 of file ServiceSpec.h.

◆ adjustTopology

ServiceTopologyAdjust o2::framework::ServiceSpec::adjustTopology = nullptr

Callback invoked when finalising topology creation.

Definition at line 203 of file ServiceSpec.h.

◆ configure

ServiceConfigureCallback o2::framework::ServiceSpec::configure = nullptr

Callback to configure the service.

Definition at line 146 of file ServiceSpec.h.

◆ domainInfoUpdated

ServiceDomainInfoUpdated o2::framework::ServiceSpec::domainInfoUpdated = nullptr

Callback invoked when we get updated about the oldest possible timeslice we can process.

Definition at line 206 of file ServiceSpec.h.

◆ driverInit

ServiceDriverInit o2::framework::ServiceSpec::driverInit = nullptr

Callback invoked on driver entering the INIT state.

Definition at line 192 of file ServiceSpec.h.

◆ driverStartup

ServiceDriverStartup o2::framework::ServiceSpec::driverStartup = nullptr

Callback invoked when starting the driver.

Definition at line 194 of file ServiceSpec.h.

◆ exit

ServiceExitCallback o2::framework::ServiceSpec::exit = nullptr

Callback invoked on exit.

Definition at line 190 of file ServiceSpec.h.

◆ finaliseOutputs

ServiceProcessingCallback o2::framework::ServiceSpec::finaliseOutputs = nullptr

Callback executed after the processing callback is completed and the user provided outputs have been created.

Definition at line 151 of file ServiceSpec.h.

◆ init

ServiceInit o2::framework::ServiceSpec::init = nullptr

Callback to initialise the service.

Definition at line 144 of file ServiceSpec.h.

◆ injectTopology

ServiceTopologyInject o2::framework::ServiceSpec::injectTopology = nullptr

Callback invoked when doing topology creation.

Definition at line 200 of file ServiceSpec.h.

◆ kind

ServiceKind o2::framework::ServiceSpec::kind = ServiceKind::Serial

Kind of service being specified.

Definition at line 221 of file ServiceSpec.h.

◆ metricHandling

ServiceMetricHandling o2::framework::ServiceSpec::metricHandling = nullptr

Callback executed after each metric is received by the driver.

Definition at line 177 of file ServiceSpec.h.

◆ name

std::string o2::framework::ServiceSpec::name = "please specify name"

Name of the service.

Definition at line 140 of file ServiceSpec.h.

◆ postDangling

ServiceDanglingCallback o2::framework::ServiceSpec::postDangling = nullptr

Callback executed after the dangling inputs loop.

Definition at line 157 of file ServiceSpec.h.

◆ postDispatching

ServicePostDispatching o2::framework::ServiceSpec::postDispatching = nullptr

Callback executed after a given input record has been successfully dispatched.

Definition at line 181 of file ServiceSpec.h.

◆ postEOS

ServiceEOSCallback o2::framework::ServiceSpec::postEOS = nullptr

Callback executed after the end of stream callback of the user happended.

Definition at line 161 of file ServiceSpec.h.

◆ postForkChild

ServicePostForkChild o2::framework::ServiceSpec::postForkChild = nullptr

Callback executed after forking a given device in the driver, but before doing exec / starting the device.

Definition at line 168 of file ServiceSpec.h.

◆ postForkParent

ServicePostForkParent o2::framework::ServiceSpec::postForkParent = nullptr

Callback executed after forking a given device in the driver.

Definition at line 170 of file ServiceSpec.h.

◆ postForwarding

ServicePostForwarding o2::framework::ServiceSpec::postForwarding = nullptr

Definition at line 183 of file ServiceSpec.h.

◆ postProcessing

ServiceProcessingCallback o2::framework::ServiceSpec::postProcessing = nullptr

Callback executed once actual processing happened.

Definition at line 153 of file ServiceSpec.h.

◆ postRenderGUI

ServicePostRenderGUI o2::framework::ServiceSpec::postRenderGUI = nullptr

Callback invoked after the main GUI has been drawn.

Definition at line 212 of file ServiceSpec.h.

◆ postSchedule

ServicePostSchedule o2::framework::ServiceSpec::postSchedule = nullptr

Definition at line 174 of file ServiceSpec.h.

◆ preDangling

ServiceDanglingCallback o2::framework::ServiceSpec::preDangling = nullptr

Callback executed before the dangling inputs loop.

Definition at line 155 of file ServiceSpec.h.

◆ preEOS

ServiceEOSCallback o2::framework::ServiceSpec::preEOS = nullptr

Callback executed before the end of stream callback of the user happended.

Definition at line 159 of file ServiceSpec.h.

◆ preFork

ServicePreFork o2::framework::ServiceSpec::preFork = nullptr

Callback executed before the forking of a given device in the driver Notice the forking can happen multiple times. It's responsibility of the service to track how many times it happens and act accordingly.

Definition at line 165 of file ServiceSpec.h.

◆ preLoop

ServicePreLoop o2::framework::ServiceSpec::preLoop = nullptr

Callback invoked before the loop starts.

Definition at line 197 of file ServiceSpec.h.

◆ preProcessing

ServiceProcessingCallback o2::framework::ServiceSpec::preProcessing = nullptr

Callback executed before actual processing happens.

Definition at line 148 of file ServiceSpec.h.

◆ preSchedule

ServicePreSchedule o2::framework::ServiceSpec::preSchedule = nullptr

Callback executed before and after we schedule a topology.

Definition at line 173 of file ServiceSpec.h.

◆ preSendingMessages

ServicePreSendingMessages o2::framework::ServiceSpec::preSendingMessages = nullptr

Callback invoked when we are about sending a message.

Definition at line 209 of file ServiceSpec.h.

◆ start

ServiceStartCallback o2::framework::ServiceSpec::start = nullptr

Callback invoked on Start.

Definition at line 186 of file ServiceSpec.h.

◆ stop

ServiceStopCallback o2::framework::ServiceSpec::stop = nullptr