Project
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
o2::framework::CompletionPolicyHelpers Struct Reference

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 consumeWhenAny (CompletionPolicy::Matcher matcher=[](auto const &) -> bool { return true;})
 Default matcher applies for all devices.
 
static CompletionPolicy consumeWhenAny (std::string matchName)
 
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 209 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 113 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 177 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenAllOrdered() [3/3]

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

Definition at line 201 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 52 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 270 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenAny() [3/3]

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

Definition at line 283 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 61 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 291 of file CompletionPolicyHelpers.cxx.

◆ consumeWhenAnyWithAllConditions() [3/3]

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

Definition at line 352 of file CompletionPolicyHelpers.cxx.

◆ defineByName()

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

Definition at line 79 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 34 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 86 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 76 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 360 of file CompletionPolicyHelpers.cxx.

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