2 * Copyright (C) 2015, 2016 "IoT.bzh"
3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
23 /// @brief return epoch in milliseconds
25 /// @return long long int epoch in milliseconds
26 typedef long long int (*time_function_t)();
28 long long int system_time_us();
29 long long int system_time_ms();
30 long long int system_time_s();
33 /// @brief A frequency counting clock.
34 /// Utility class allowing some time function.
35 class frequency_clock_t
38 float unit_; ///< unit_ - multiplicator to make operation to be in the right unit (milli, micro, nano, etc)
39 float frequency_; ///< the clock frequency in Hz.
40 uint64_t last_tick_; ///< the last time (in microseconds since startup) that the clock ticked.
41 time_function_t time_function_; ///< a function returning current time
45 explicit frequency_clock_t(float frequency);
46 frequency_clock_t(float frequency, uint64_t last_tick, time_function_t time_function);
48 float get_frequency() const;
49 const struct timeval get_timeval_from_period() const;
51 float frequency_to_period() const;
53 time_function_t get_time_function();
54 bool elapsed(bool stagger);
56 uint64_t get_last_tick() const;
57 void tick(uint64_t timestamp);