Helper class which holds commonly used policies. More...

#include <CompletionPolicyHelpers.h>

Static Public Member Functions
static CompletionPolicy	consumeWhenAll (const char *name, CompletionPolicy::Matcher matcher)
	Default Completion policy. When all the parts of a record have arrived, consume them.

static CompletionPolicy	consumeWhenAll (CompletionPolicy::Matcher matcher=[](auto const &) -> bool { return true;})
	Default matcher applies for all devices.

static CompletionPolicy	consumeWhenAllOrdered (const char *name, CompletionPolicy::Matcher matcher)
	as consumeWhenAll, but ensures that records are processed with incremental timeSlice (DataHeader::startTime)

static CompletionPolicy	consumeWhenAllOrdered (CompletionPolicy::Matcher matcher=[](auto const &) -> bool { return true;})
	Default matcher applies for all devices.

static CompletionPolicy	consumeWhenAllOrdered (std::string matchName)

static CompletionPolicy	consumeWhenAny (const char *name, CompletionPolicy::Matcher matcher)
	When any of the parts of the record have been received, consume them.

static CompletionPolicy	consumeWhenAnyZeroCount (const char *name, CompletionPolicy::Matcher matcher)
	When any of the parts which has arrived has a refcount of 1.

static CompletionPolicy	consumeWhenAny (CompletionPolicy::Matcher matcher=[](auto const &) -> bool { return true;})
	Default matcher applies for all devices.

static CompletionPolicy	consumeWhenAny (std::string matchName)

static CompletionPolicy	consumeWhenPastOldestPossibleTimeframe (const char *name, CompletionPolicy::Matcher matcher)

static CompletionPolicy	consumeWhenAnyWithAllConditions (const char *name, CompletionPolicy::Matcher matcher)
	When any of the parts of the record have been received, consume them.

static CompletionPolicy	consumeWhenAnyWithAllConditions (CompletionPolicy::Matcher matcher=[](auto const &) -> bool { return true;})
	Default matcher applies for all devices.

static CompletionPolicy	consumeWhenAnyWithAllConditions (std::string matchName)

static CompletionPolicy	consumeExistingWhenAny (const char *name, CompletionPolicy::Matcher matcher)

static CompletionPolicy	processWhenAny (const char *name, CompletionPolicy::Matcher matcher)

static CompletionPolicy	processWhenAny (CompletionPolicy::Matcher matcher=[](auto const &) -> bool { return true;})
	Default matcher applies for all devices.

.
Attach a given op to a device matching
static CompletionPolicy	defineByName (std::string const &name, CompletionPolicy::CompletionOp op)

, check message of origin @origin is available
Attach a given op to a device matching
static CompletionPolicy	defineByNameOrigin (std::string const &name, std::string const &origin, CompletionPolicy::CompletionOp op)

template<typename T , typename U >
static auto	getHeader (U const &input)
	Get a specific header from the input.

Detailed Description

Helper class which holds commonly used policies.

Definition at line 26 of file CompletionPolicyHelpers.h.

Member Function Documentation

◆ consumeExistingWhenAny()

CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeExistingWhenAny	(	const char *	name,
		CompletionPolicy::Matcher	matcher
	)

static

When any of the parts of the record have been received, process the existing and free the associated payloads. This allows freeing things as early as possible, while still being able to wait all the parts before disposing the timeslice completely

Definition at line 208 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenAll() [1/2]

static CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAll ( CompletionPolicy::Matcher matcher = [](auto const&) -> bool { return true; } )

inlinestatic

Default matcher applies for all devices.

Definition at line 30 of file CompletionPolicyHelpers.h.

◆ consumeWhenAll() [2/2]

CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAll	(	const char *	name,
		CompletionPolicy::Matcher	matcher
	)

static

Default Completion policy. When all the parts of a record have arrived, consume them.

Definition at line 112 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenAllOrdered() [1/3]

static CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAllOrdered ( CompletionPolicy::Matcher matcher = [](auto const&) -> bool { return true; } )

inlinestatic

Default matcher applies for all devices.

Definition at line 38 of file CompletionPolicyHelpers.h.

◆ consumeWhenAllOrdered() [2/3]

CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAllOrdered	(	const char *	name,
		CompletionPolicy::Matcher	matcher
	)

static

as consumeWhenAll, but ensures that records are processed with incremental timeSlice (DataHeader::startTime)

Definition at line 176 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenAllOrdered() [3/3]

CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAllOrdered ( std::string matchName )

static

Definition at line 200 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenAny() [1/3]

static CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAny ( CompletionPolicy::Matcher matcher = [](auto const&) -> bool { return true; } )

inlinestatic

Default matcher applies for all devices.

Definition at line 51 of file CompletionPolicyHelpers.h.

◆ consumeWhenAny() [2/3]

CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAny	(	const char *	name,
		CompletionPolicy::Matcher	matcher
	)

static

When any of the parts of the record have been received, consume them.

Definition at line 293 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenAny() [3/3]

CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAny ( std::string matchName )

static

Definition at line 306 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenAnyWithAllConditions() [1/3]

static CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAnyWithAllConditions ( CompletionPolicy::Matcher matcher = [](auto const&) -> bool { return true; } )

inlinestatic

Default matcher applies for all devices.

Definition at line 66 of file CompletionPolicyHelpers.h.

◆ consumeWhenAnyWithAllConditions() [2/3]

CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAnyWithAllConditions	(	const char *	name,
		CompletionPolicy::Matcher	matcher
	)

static

When any of the parts of the record have been received, consume them.

Definition at line 314 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenAnyWithAllConditions() [3/3]

CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAnyWithAllConditions ( std::string matchName )

static

Definition at line 375 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenAnyZeroCount()

CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenAnyZeroCount	(	const char *	name,
		CompletionPolicy::Matcher	matcher
	)

static

When any of the parts which has arrived has a refcount of 1.

Definition at line 254 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenPastOldestPossibleTimeframe()

CompletionPolicy o2::framework::CompletionPolicyHelpers::consumeWhenPastOldestPossibleTimeframe	(	const char *	name,
		CompletionPolicy::Matcher	matcher
	)

static

Definition at line 267 of file CompletionPolicyHelpers.cxx.

◆ defineByName()

CompletionPolicy o2::framework::CompletionPolicyHelpers::defineByName	(	std::string const &	name,
		CompletionPolicy::CompletionOp	op
	)

static

Definition at line 78 of file CompletionPolicyHelpers.cxx.

◆ defineByNameOrigin()

CompletionPolicy o2::framework::CompletionPolicyHelpers::defineByNameOrigin	(	std::string const &	name,
		std::string const &	origin,
		CompletionPolicy::CompletionOp	op
	)

static

Definition at line 33 of file CompletionPolicyHelpers.cxx.

◆ getHeader()

template<typename T , typename U >

static auto o2::framework::CompletionPolicyHelpers::getHeader ( U const & input )

inlinestatic

Get a specific header from the input.

Definition at line 91 of file CompletionPolicyHelpers.h.

◆ processWhenAny() [1/2]

static CompletionPolicy o2::framework::CompletionPolicyHelpers::processWhenAny ( CompletionPolicy::Matcher matcher = [](auto const&) -> bool { return true; } )

inlinestatic

Default matcher applies for all devices.

Definition at line 81 of file CompletionPolicyHelpers.h.

◆ processWhenAny() [2/2]

CompletionPolicy o2::framework::CompletionPolicyHelpers::processWhenAny	(	const char *	name,
		CompletionPolicy::Matcher	matcher
	)

static

When any of the parts of the record have been received, process them, without actually consuming them.

Definition at line 383 of file CompletionPolicyHelpers.cxx.

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

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

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ consumeExistingWhenAny()

◆ consumeWhenAll() [1/2]

◆ consumeWhenAll() [2/2]

◆ consumeWhenAllOrdered() [1/3]

◆ consumeWhenAllOrdered() [2/3]

◆ consumeWhenAllOrdered() [3/3]

◆ consumeWhenAny() [1/3]

◆ consumeWhenAny() [2/3]

◆ consumeWhenAny() [3/3]

◆ consumeWhenAnyWithAllConditions() [1/3]

◆ consumeWhenAnyWithAllConditions() [2/3]

◆ consumeWhenAnyWithAllConditions() [3/3]

◆ consumeWhenAnyZeroCount()

◆ consumeWhenPastOldestPossibleTimeframe()

◆ defineByName()

◆ defineByNameOrigin()

◆ getHeader()

◆ processWhenAny() [1/2]

◆ processWhenAny() [2/2]