periodic_task_control.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/testsuite/periodic_task_control.hpp
/// @brief @copybrief testsuite::PeriodicTaskControl
 
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>
 
#include <userver/concurrent/variable.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace utils {
class PeriodicTask;
}  // namespace utils
 
namespace testsuite {
 
/// @brief Periodic task control interface for testsuite
/// @details All methods are coro-safe.
class PeriodicTaskControl final {
 public:
  bool RunPeriodicTask(const std::string& name);
  void SuspendPeriodicTasks(const std::unordered_set<std::string>& names);
 
 private:
  friend class PeriodicTaskRegistrationHolder;
 
  void RegisterPeriodicTask(const std::string& name, utils::PeriodicTask& task);
 
  void UnregisterPeriodicTask(const std::string& name,
                              utils::PeriodicTask& task);
 
  utils::PeriodicTask& FindPeriodicTask(const std::string& name);
 
  concurrent::Variable<std::unordered_map<std::string, utils::PeriodicTask&>>
      periodic_tasks_;
};
 
/// RAII helper for testsuite registration
class PeriodicTaskRegistrationHolder {
 public:
  PeriodicTaskRegistrationHolder(PeriodicTaskControl& periodic_task_control,
                                 std::string name, utils::PeriodicTask& task);
  ~PeriodicTaskRegistrationHolder();
 
  PeriodicTaskRegistrationHolder(const PeriodicTaskRegistrationHolder&) =
      delete;
  PeriodicTaskRegistrationHolder(PeriodicTaskRegistrationHolder&&) = delete;
  PeriodicTaskRegistrationHolder& operator=(
      const PeriodicTaskRegistrationHolder&) = delete;
  PeriodicTaskRegistrationHolder& operator=(PeriodicTaskRegistrationHolder&&) =
      delete;
 
 private:
  PeriodicTaskControl& periodic_task_control_;
  std::string name_;
  utils::PeriodicTask& task_;
};
 
}  // namespace testsuite
 
USERVER_NAMESPACE_END