LifetimeHelpers.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_LIFETIMEHELPERS_H_
#define O2_FRAMEWORK_LIFETIMEHELPERS_H_
 
#include "Framework/ExpirationHandler.h"
#include "Framework/PartRef.h"
#include "InputRoute.h"
 
#include <chrono>
#include <functional>
#include <string>
 
namespace o2::framework
{
 
struct ConcreteDataMatcher;
struct DeviceState;
 
struct LifetimeHelpers {
  static ExpirationHandler::Creator dataDrivenCreation();
  static ExpirationHandler::Creator enumDrivenCreation(size_t first, size_t last, size_t step, size_t inputTimeslice, size_t maxTimeSliceId, size_t repetitions);
 
  static ExpirationHandler::Creator timeDrivenCreation(std::vector<std::chrono::microseconds> periods, std::vector<std::chrono::seconds> intervals, std::function<bool(void)> hasTimerFired, std::function<void(uint64_t, uint64_t)> updateTimerPeriod);
 
  static ExpirationHandler::Creator uvDrivenCreation(int loopReason, DeviceState& state);
 
  static ExpirationHandler::Checker expireNever();
  static ExpirationHandler::Checker expireAlways();
  static ExpirationHandler::Checker expireIfPresent(std::vector<InputRoute> const& schema, ConcreteDataMatcher matcher);
 
  static ExpirationHandler::Checker expireTimed(std::chrono::microseconds period);
 
  static ExpirationHandler::Handler doNothing();
 
  static ExpirationHandler::Checker expectCTP(std::string const& serverUrl, bool waitForCTP);
  static ExpirationHandler::Handler fetchFromCCDBCache(InputSpec const& spec,
                                                       std::string const& prefix,
                                                       std::string const& overrideTimestamp,
                                                       std::string const& sourceChannel);
 
  static ExpirationHandler::Handler fetchFromFairMQ(InputSpec const& spec,
                                                    std::string const& channelName);
 
  static ExpirationHandler::Handler fetchFromQARegistry();
 
  static ExpirationHandler::Handler fetchFromObjectRegistry();
 
  static ExpirationHandler::Handler enumerate(ConcreteDataMatcher const& spec, std::string const& sourceChannel,
                                              int64_t orbitOffset, int64_t orbitMultiplier);
 
  static ExpirationHandler::Handler dummy(ConcreteDataMatcher const& spec, std::string const& sourceChannel);
};
 
std::ostream& operator<<(std::ostream& oss, Lifetime const& val);
 
} // namespace o2::framework
 
#endif // O2_FRAMEWORK_LIFETIMEHELPERS_H_