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 (*TimeFunction)();
  28
  29 /**
  30  * @struct FrequencyClock
  31  * @brief A frequency counting clock.
  32  *
  33  * @var FrequencyClock::frequency
  34  *  the clock frequency in Hz.
  35  * @var FrequencyClock::last_time
  36  *  the last time (in milliseconds since startup) that the clock
  37  *      ticked.
  38  * @var FrequencyClock::time_function
  39  *  a function returning current time
  40  */
  41 typedef struct {
  42                 float frequency;
  43                 unsigned long lastTick;
  44                 TimeFunction timeFunction;
  45 } FrequencyClock;