CompletionPolicy.h

Go to the documentation of this file.

// Copyright 2019-2020 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_COMPLETIONPOLICY_H_
#define O2_FRAMEWORK_COMPLETIONPOLICY_H_
 
#include "Framework/DataRef.h"
#include "Framework/InputSpec.h"
#include "Framework/ServiceRegistryRef.h"
 
#include <functional>
#include <string>
#include <utility>
#include <vector>
 
namespace o2::framework
{
 
struct DeviceSpec;
struct InputRecord;
struct InputSpan;
class DataRelayer;
 
struct CompletionPolicy {
  enum struct CompletionOp {
    Consume,
    Process,
    Wait,
    Discard,
    ConsumeExisting,
    ConsumeAndRescan,
    Retry,
  };
 
  enum struct CompletionOrder {
    Any,
    Timeslice,
    Slot
  };
 
  using Matcher = std::function<bool(DeviceSpec const& device)>;
  using InputSetElement = DataRef;
  using CallbackFull = std::function<CompletionOp(InputSpan const&, std::vector<InputSpec> const&, ServiceRegistryRef&)>;
  using CallbackConfigureRelayer = std::function<void(DataRelayer&)>;
 
  CompletionPolicy()
    : name{}, matcher{}, callbackFull{} {}
  CompletionPolicy(std::string _name, Matcher _matcher, CallbackFull _callback, bool _balanceChannels = true)
    : name(std::move(_name)), matcher(std::move(_matcher)), callbackFull{std::move(_callback)}, balanceChannels{_balanceChannels} {}
 
  std::string name = "";
  Matcher matcher = nullptr;
  CallbackFull callbackFull = nullptr;
  CallbackConfigureRelayer configureRelayer = nullptr;
  bool balanceChannels = true;
 
  CompletionOrder order = CompletionOrder::Any;
 
  static std::vector<CompletionPolicy> createDefaultPolicies();
};
 
std::ostream& operator<<(std::ostream& oss, CompletionPolicy::CompletionOp const& val);
 
} // namespace o2::framework
 
#endif // O2_FRAMEWORK_COMPLETIONPOLICY_H_