mirror of
https://github.com/esp8266/Arduino.git
synced 2025-10-30 04:26:50 +03:00
89837fcea5
* lib/Ticker: add bool active() Makes it easier to self detach, and check if a timer is still operating. Signed-off-by: Karl Palsson <karlp@tweak.net.au> * Code cleanup Ticker.cpp
109 lines
3.4 KiB
C++
109 lines
3.4 KiB
C++
/*
|
|
Ticker.h - esp8266 library that calls functions periodically
|
|
|
|
Copyright (c) 2014 Ivan Grokhotkov. All rights reserved.
|
|
This file is part of the esp8266 core for Arduino environment.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef TICKER_H
|
|
#define TICKER_H
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
|
|
extern "C" {
|
|
typedef struct _ETSTIMER_ ETSTimer;
|
|
}
|
|
|
|
class Ticker
|
|
{
|
|
public:
|
|
Ticker();
|
|
~Ticker();
|
|
typedef void (*callback_t)(void);
|
|
typedef void (*callback_with_arg_t)(void*);
|
|
|
|
void attach(float seconds, callback_t callback)
|
|
{
|
|
_attach_ms(seconds * 1000, true, reinterpret_cast<callback_with_arg_t>(callback), 0);
|
|
}
|
|
|
|
void attach_ms(uint32_t milliseconds, callback_t callback)
|
|
{
|
|
_attach_ms(milliseconds, true, reinterpret_cast<callback_with_arg_t>(callback), 0);
|
|
}
|
|
|
|
template<typename TArg>
|
|
void attach(float seconds, void (*callback)(TArg), TArg arg)
|
|
{
|
|
static_assert(sizeof(TArg) <= sizeof(uint32_t), "attach() callback argument size must be <= 4 bytes");
|
|
// C-cast serves two purposes:
|
|
// static_cast for smaller integer types,
|
|
// reinterpret_cast + const_cast for pointer types
|
|
uint32_t arg32 = (uint32_t)arg;
|
|
_attach_ms(seconds * 1000, true, reinterpret_cast<callback_with_arg_t>(callback), arg32);
|
|
}
|
|
|
|
template<typename TArg>
|
|
void attach_ms(uint32_t milliseconds, void (*callback)(TArg), TArg arg)
|
|
{
|
|
static_assert(sizeof(TArg) <= sizeof(uint32_t), "attach_ms() callback argument size must be <= 4 bytes");
|
|
uint32_t arg32 = (uint32_t)arg;
|
|
_attach_ms(milliseconds, true, reinterpret_cast<callback_with_arg_t>(callback), arg32);
|
|
}
|
|
|
|
void once(float seconds, callback_t callback)
|
|
{
|
|
_attach_ms(seconds * 1000, false, reinterpret_cast<callback_with_arg_t>(callback), 0);
|
|
}
|
|
|
|
void once_ms(uint32_t milliseconds, callback_t callback)
|
|
{
|
|
_attach_ms(milliseconds, false, reinterpret_cast<callback_with_arg_t>(callback), 0);
|
|
}
|
|
|
|
template<typename TArg>
|
|
void once(float seconds, void (*callback)(TArg), TArg arg)
|
|
{
|
|
static_assert(sizeof(TArg) <= sizeof(uint32_t), "attach() callback argument size must be <= 4 bytes");
|
|
uint32_t arg32 = (uint32_t)(arg);
|
|
_attach_ms(seconds * 1000, false, reinterpret_cast<callback_with_arg_t>(callback), arg32);
|
|
}
|
|
|
|
template<typename TArg>
|
|
void once_ms(uint32_t milliseconds, void (*callback)(TArg), TArg arg)
|
|
{
|
|
static_assert(sizeof(TArg) <= sizeof(uint32_t), "attach_ms() callback argument size must be <= 4 bytes");
|
|
uint32_t arg32 = (uint32_t)(arg);
|
|
_attach_ms(milliseconds, false, reinterpret_cast<callback_with_arg_t>(callback), arg32);
|
|
}
|
|
|
|
void detach();
|
|
bool active();
|
|
|
|
protected:
|
|
void _attach_ms(uint32_t milliseconds, bool repeat, callback_with_arg_t callback, uint32_t arg);
|
|
|
|
|
|
protected:
|
|
ETSTimer* _timer;
|
|
};
|
|
|
|
|
|
#endif//TICKER_H
|