TimestampEstimatorBase.hpp

Go to the documentation of this file.

 
#ifndef UTILITIES_INCLUDE_UTILITIES_TIMESTAMPESTIMATORBASE_HPP_
#define UTILITIES_INCLUDE_UTILITIES_TIMESTAMPESTIMATORBASE_HPP_
 
#include <atomic>
#include <chrono>
#include <limits>
 
namespace dunedaq::utilities {
 
class TimestampEstimatorBase
{
public:
  static constexpr uint64_t s_invalid_ts = std::numeric_limits<uint64_t>::max(); // NOLINT(build/unsigned)
 
  virtual ~TimestampEstimatorBase() = default;
  virtual uint64_t get_timestamp_estimate() const = 0;                        // NOLINT(build/unsigned)
  virtual std::chrono::microseconds get_wait_estimate(uint64_t ts) const = 0; // NOLINT(build/unsigned)
 
  enum WaitStatus
  {
    kFinished,
    kInterrupted
  };
 
  WaitStatus wait_for_valid_timestamp(std::atomic<bool>& continue_flag)
  {
    uint64_t ts_discard = s_invalid_ts; // NOLINT(build/unsigned)
    return wait_for_valid_timestamp(continue_flag, ts_discard);
  }
  WaitStatus wait_for_valid_timestamp(std::atomic<bool>& continue_flag,
                                      uint64_t& last_seen_ts); // NOLINT(build/unsigned)
 
  WaitStatus wait_for_requested_timestamp(uint64_t ts, std::atomic<bool>& continue_flag) // NOLINT(build/unsigned)
  {
    uint64_t ts_discard = s_invalid_ts; // NOLINT(build/unsigned)
    return wait_for_requested_timestamp(ts, continue_flag, ts_discard);
  }
  WaitStatus wait_for_requested_timestamp(uint64_t ts, // NOLINT(build/unsigned)
                                          std::atomic<bool>& continue_flag,
                                          uint64_t& last_seen_ts); // NOLINT(build/unsigned)
};
 
} // namespace dunedaq::utilities
 
#endif // UTILITIES_INCLUDE_UTILITIES_TIMESTAMPESTIMATORBASE_HPP_