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 #include <sys/timeb.h>
  21
  22 /*
  23  * @brief return epoch in milliseconds
  24  *
  25  * @return long long int epoch in milliseconds
  26  */
  27 typedef long long int (*time_function_t)();
  28
  29
  30 long long int system_time_ms();
  31
  32 /**
  33  * @class frequency_clock_t
  34  * @brief A frequency counting clock.
  35  *
  36  * @var frequency_clock_t::frequency
  37  *  the clock frequency in Hz.
  38  * @var frequency_clock_t::last_time
  39  *  the last time (in milliseconds since startup) that the clock
  40  *      ticked.
  41  * @var frequency_clock_t::time_function
  42  *  a function returning current time
  43  */
  44 class frequency_clock_t
  45 {
  46 private:
  47         float frequency_;
  48         unsigned long last_tick_;
  49         time_function_t time_function_;
  50
  51 public:
  52         frequency_clock_t();
  53         frequency_clock_t(float frequency);
  54
  55         static float frequency_to_period(float frequency);
  56         bool started();
  57         time_function_t get_time_function();
  58         bool elapsed(bool stagger);
  59
  60         void tick();
  61 };