src/utils/timer.hpp

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 /*
  21  * @brief return epoch in milliseconds
  22  *
  23  * @return long long int epoch in milliseconds
  24  */
  25 typedef long long int (*time_function_t)();
  26
  27 long long int system_time_us();
  28 long long int system_time_ms();
  29 long long int system_time_s();
  30
  31 /**
  32  * @class frequency_clock_t
  33  * @brief A frequency counting clock.
  34  *
  35  * @var frequency_clock_t::frequency
  36  *  the clock frequency in Hz.
  37  * @var frequency_clock_t::last_time
  38  *  the last time (in milliseconds since startup) that the clock
  39  *      ticked.
  40  * @var frequency_clock_t::time_function
  41  *  a function returning current time
  42  */
  43 class frequency_clock_t
  44 {
  45 private:
  46         float frequency_;
  47         unsigned long last_tick_;
  48         time_function_t time_function_;
  49
  50 public:
  51         frequency_clock_t();
  52         frequency_clock_t(float frequency);
  53         frequency_clock_t(float frequency, unsigned long last_tick, time_function_t time_function);
  54
  55         float get_frequency() const;
  56         static float frequency_to_period(float frequency);
  57         bool started();
  58         time_function_t get_time_function();
  59         bool elapsed(bool stagger);
  60
  61         void tick();
  62 };