Class CallbackTimer

Sming/Core/CallbackTimer.h:73–425

 * This class template provides basic C-style callbacks for best performance
 */
template <typename TimerApi> class CallbackTimer : protected TimerApi
{
public:
	using typename TimerApi::Clock;
	using typename TimerApi::TickType;
	using typename TimerApi::TimeType;
	using Millis = NanoTime::TimeSource<Clock, NanoTime::Milliseconds, uint32_t>;
	using Micros = NanoTime::TimeSource<Clock, NanoTime::Microseconds, TimeType>;

	using TimerApi::maxTicks;
	using TimerApi::minTicks;
	using TimerApi::toString;
	using TimerApi::typeName;
	using TimerApi::operator String;

	/** @brief Get a millisecond time source */
	static constexpr Millis millis()
	{
		return Millis();
	}

	/** @brief Get a microsecond time source */
	static constexpr Micros micros()
	{
		return Micros();
	}

	/** @brief Convert microsecond count into timer ticks */
	template <uint64_t us> static constexpr uint64_t usToTicks()
	{
		return Micros::template timeToTicks<us>();
	}

	/** @brief Convert microsecond count into timer ticks */
	static TickType usToTicks(TimeType time)
	{
		return Micros::timeToTicks(time);
	}

	/** @brief Convert timer ticks into microseconds */
	template <uint64_t ticks> static constexpr uint64_t ticksToUs()
	{
		return Micros::template ticksToTime<ticks>();
	}

	/** @brief Convert timer ticks into microseconds */
	static TimeType ticksToUs(TickType ticks)
	{
		return Micros::ticksToTime(ticks);
	}

	/** @brief  Initialise timer with an interval (static check) and callback
	 *  @tparam unit Time unit for interval
     *  @tparam time Timer interval
     *  @param  callback Callback function to call when timer triggers
     *  @param  arg Optional argument passed to callback
     *  @retval CallbackTimer& Reference to timer
     *  @note   If interval out of range compilation will fail with error