EspPeriodicTimer.h

Go to the documentation of this file.

 
#pragma once
 
#include "BasePeriodicTimer.h"
#include "EspTypes.h"
#include <cstdint>
 
class EspPeriodicTimer : public BasePeriodicTimer {
public:
  EspPeriodicTimer(hf_timer_callback_t callback = nullptr, void* user_data = nullptr) noexcept;
 
  ~EspPeriodicTimer() noexcept override;
 
  // Copy/move constructors and assignment operators
  EspPeriodicTimer(const EspPeriodicTimer&) = delete;
  EspPeriodicTimer& operator=(const EspPeriodicTimer&) = delete;
  EspPeriodicTimer(EspPeriodicTimer&&) = delete;
  EspPeriodicTimer& operator=(EspPeriodicTimer&&) = delete;
 
  //==============================================//
  // OVERRIDDEN PURE VIRTUAL FUNCTIONS            //
  //==============================================//
 
  hf_timer_err_t Initialize() noexcept override;
 
  hf_timer_err_t Deinitialize() noexcept override;
 
  hf_timer_err_t Start(hf_u64_t period_us) noexcept override;
 
  hf_timer_err_t Stop() noexcept override;
 
  hf_timer_err_t SetPeriod(hf_u64_t new_period_us) noexcept override;
 
  hf_timer_err_t GetPeriod(hf_u64_t& period_us) noexcept override;
 
  hf_timer_err_t GetStats(hf_u64_t& callback_count, hf_u64_t& missed_callbacks,
                          hf_timer_err_t& last_error) noexcept override;
 
  hf_timer_err_t ResetStats() noexcept override;
 
  const char* GetDescription() const noexcept override;
 
  hf_u64_t GetMinPeriod() const noexcept override;
 
  hf_u64_t GetMaxPeriod() const noexcept override;
 
  hf_u64_t GetResolution() const noexcept override;
 
  hf_timer_err_t GetStatistics(hf_timer_statistics_t& statistics) const noexcept override;
 
  hf_timer_err_t GetDiagnostics(hf_timer_diagnostics_t& diagnostics) const noexcept override;
 
private:
  hf_timer_handle_t timer_handle_; 
  hf_u64_t period_us_;             
  hf_timer_stats_t stats_;         
 
  hf_timer_err_t ConvertError(int platform_error) const noexcept;
 
  bool ValidatePeriod(hf_u64_t period_us) const noexcept;
 
  bool CreateTimerHandle() noexcept;
 
  void DestroyTimerHandle() noexcept;
 
  static void InternalTimerCallback(void* arg);
};