CompletionPolicyHelpers.h

Go to the documentation of this file.

// Copyright 2019-2026 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
#ifndef O2_FRAMEWORK_COMPLETIONPOLICYHELPERS_H_
#define O2_FRAMEWORK_COMPLETIONPOLICYHELPERS_H_
 
#include "Framework/ChannelSpec.h"
#include "Framework/CompletionPolicy.h"
#include "Headers/DataHeader.h"
 
#include <functional>
#include <string>
#include <type_traits>
 
namespace o2::framework
{
 
struct CompletionPolicyHelpers {
  static CompletionPolicy consumeWhenAll(const char* name, CompletionPolicy::Matcher matcher);
  static CompletionPolicy consumeWhenAll(CompletionPolicy::Matcher matcher = [](auto const&) -> bool { return true; })
  {
    return consumeWhenAll("consume-all", matcher);
  }
 
  static CompletionPolicy consumeWhenAllOrdered(const char* name, CompletionPolicy::Matcher matcher);
  static CompletionPolicy consumeWhenAllOrdered(CompletionPolicy::Matcher matcher = [](auto const&) -> bool { return true; })
  {
    return consumeWhenAllOrdered("consume-all-ordered", matcher);
  }
  static CompletionPolicy consumeWhenAllOrdered(std::string matchName);
 
  static CompletionPolicy consumeWhenAny(const char* name, CompletionPolicy::Matcher matcher);
 
  static CompletionPolicy consumeWhenAnyZeroCount(const char* name, CompletionPolicy::Matcher matcher);
 
  static CompletionPolicy consumeWhenAny(CompletionPolicy::Matcher matcher = [](auto const&) -> bool { return true; })
  {
    return consumeWhenAny("consume-any", matcher);
  }
  static CompletionPolicy consumeWhenAny(std::string matchName);
 
  // Consume all the data captured until the oldest possible timeframe
  // in input indicates that nothing else can be added to this timeslice.
  // Useful in case of wildcards which multiplex multiple subspecs on the
  // same input.
  static CompletionPolicy consumeWhenPastOldestPossibleTimeframe(const char* name, CompletionPolicy::Matcher matcher);
 
  static CompletionPolicy consumeWhenAnyWithAllConditions(const char* name, CompletionPolicy::Matcher matcher);
  static CompletionPolicy consumeWhenAnyWithAllConditions(CompletionPolicy::Matcher matcher = [](auto const&) -> bool { return true; })
  {
    return consumeWhenAnyWithAllConditions("consume-any-all-conditions", matcher);
  }
  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; })
  {
    return processWhenAny("process-any", matcher);
  }
  static CompletionPolicy defineByName(std::string const& name, CompletionPolicy::CompletionOp op);
  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)
  {
    // DataHeader interface requires to specify header pointer type, need to check if the template parameter
    // is already pointer type, and add pointer if not
    using return_type = typename std::conditional<std::is_pointer<T>::value, T, typename std::add_pointer<T>::type>::type;
    return o2::header::get<return_type>(input.header);
  }
};
 
} // namespace o2::framework
 
#endif // O2_FRAMEWORK_COMPLETIONPOLICYHELPERS_H_