Loading...
Searching...
No Matches
message_timer.h
/******************************************************************************
The MIT License(MIT)
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
Copyright(c) 2017 John Wellbelove
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files(the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
******************************************************************************/
#ifndef ETL_MESSAGE_TIMER_INCLUDED
#define ETL_MESSAGE_TIMER_INCLUDED
#include "platform.h"
#include "algorithm.h"
#include "atomic.h"
#include "delegate.h"
#include "message.h"
#include "message_bus.h"
#include "message_router.h"
#include "message_types.h"
#include "nullptr.h"
#include "static_assert.h"
#include "timer.h"
#include <stdint.h>
#if defined(ETL_IN_UNIT_TEST) && ETL_NOT_USING_STL
#define ETL_DISABLE_TIMER_UPDATES ((void)0)
#define ETL_ENABLE_TIMER_UPDATES ((void)0)
#define ETL_TIMER_UPDATES_ENABLED true
#undef ETL_MESSAGE_TIMER_USE_ATOMIC_LOCK
#undef ETL_MESSAGE_TIMER_USE_INTERRUPT_LOCK
#else
#if !defined(ETL_MESSAGE_TIMER_USE_ATOMIC_LOCK) && !defined(ETL_MESSAGE_TIMER_USE_INTERRUPT_LOCK)
#error ETL_MESSAGE_TIMER_USE_ATOMIC_LOCK or ETL_MESSAGE_TIMER_USE_INTERRUPT_LOCK not defined
#endif
#if defined(ETL_MESSAGE_TIMER_USE_ATOMIC_LOCK) && defined(ETL_MESSAGE_TIMER_USE_INTERRUPT_LOCK)
#error Only define one of ETL_MESSAGE_TIMER_USE_ATOMIC_LOCK or ETL_MESSAGE_TIMER_USE_INTERRUPT_LOCK
#endif
#if defined(ETL_MESSAGE_TIMER_USE_ATOMIC_LOCK)
#define ETL_DISABLE_TIMER_UPDATES (++process_semaphore)
#define ETL_ENABLE_TIMER_UPDATES (--process_semaphore)
#define ETL_TIMER_UPDATES_ENABLED (process_semaphore.load() == 0)
#endif
#if defined(ETL_MESSAGE_TIMER_USE_INTERRUPT_LOCK)
#if !defined(ETL_MESSAGE_TIMER_DISABLE_INTERRUPTS) || !defined(ETL_MESSAGE_TIMER_ENABLE_INTERRUPTS)
#error ETL_MESSAGE_TIMER_DISABLE_INTERRUPTS and/or ETL_MESSAGE_TIMER_ENABLE_INTERRUPTS not defined
#endif
#define ETL_DISABLE_TIMER_UPDATES ETL_MESSAGE_TIMER_DISABLE_INTERRUPTS
#define ETL_ENABLE_TIMER_UPDATES ETL_MESSAGE_TIMER_ENABLE_INTERRUPTS
#define ETL_TIMER_UPDATES_ENABLED true
#endif
#endif
namespace etl
{
//*************************************************************************
struct message_timer_data
{
//*******************************************
message_timer_data()
: p_message(ETL_NULLPTR)
, p_router(ETL_NULLPTR)
, period(0)
, delta(etl::timer::state::Inactive)
, destination_router_id(etl::imessage_bus::ALL_MESSAGE_ROUTERS)
, id(etl::timer::id::NO_TIMER)
, previous(etl::timer::id::NO_TIMER)
, next(etl::timer::id::NO_TIMER)
, repeating(true)
{
}
//*******************************************
message_timer_data(etl::timer::id::type id_, const etl::imessage& message_, etl::imessage_router& irouter_, uint32_t period_, bool repeating_,
etl::message_router_id_t destination_router_id_ = etl::imessage_bus::ALL_MESSAGE_ROUTERS)
: p_message(&message_)
, p_router(&irouter_)
, period(period_)
, delta(etl::timer::state::Inactive)
, destination_router_id(destination_router_id_)
, id(id_)
, previous(etl::timer::id::NO_TIMER)
, next(etl::timer::id::NO_TIMER)
, repeating(repeating_)
{
}
//*******************************************
//*******************************************
bool is_active() const
{
return delta != etl::timer::state::Inactive;
}
//*******************************************
//*******************************************
void set_inactive()
{
delta = etl::timer::state::Inactive;
}
const etl::imessage* p_message;
etl::imessage_router* p_router;
uint32_t period;
uint32_t delta;
etl::message_router_id_t destination_router_id;
etl::timer::id::type id;
uint_least8_t previous;
uint_least8_t next;
bool repeating;
private:
// Disabled.
message_timer_data(const message_timer_data& other);
message_timer_data& operator=(const message_timer_data& other);
};
namespace private_message_timer
{
//*************************************************************************
//*************************************************************************
class list
{
public:
//*******************************
list(etl::message_timer_data* ptimers_)
: head(etl::timer::id::NO_TIMER)
, tail(etl::timer::id::NO_TIMER)
, ptimers(ptimers_)
{
}
//*******************************
bool empty() const
{
return head == etl::timer::id::NO_TIMER;
}
//*******************************
// Inserts the timer at the correct delta position
//*******************************
void insert(etl::timer::id::type id_)
{
etl::message_timer_data& timer = ptimers[id_];
if (head == etl::timer::id::NO_TIMER)
{
// No entries yet.
head = id_;
tail = id_;
timer.previous = etl::timer::id::NO_TIMER;
timer.next = etl::timer::id::NO_TIMER;
}
else
{
// We already have entries.
etl::timer::id::type test_id = begin();
while (test_id != etl::timer::id::NO_TIMER)
{
etl::message_timer_data& test = ptimers[test_id];
// Find the correct place to insert.
if (timer.delta <= test.delta)
{
if (test.id == head)
{
head = timer.id;
}
// Insert before test.
timer.previous = test.previous;
test.previous = timer.id;
timer.next = test.id;
// Adjust the next delta to compensate.
test.delta -= timer.delta;
if (timer.previous != etl::timer::id::NO_TIMER)
{
ptimers[timer.previous].next = timer.id;
}
break;
}
else
{
timer.delta -= test.delta;
}
test_id = next(test_id);
}
// Reached the end?
if (test_id == etl::timer::id::NO_TIMER)
{
// Tag on to the tail.
ptimers[tail].next = timer.id;
timer.previous = tail;
timer.next = etl::timer::id::NO_TIMER;
tail = timer.id;
}
}
}
//*******************************
void remove(etl::timer::id::type id_, bool has_expired)
{
etl::message_timer_data& timer = ptimers[id_];
if (head == id_)
{
head = timer.next;
}
else
{
ptimers[timer.previous].next = timer.next;
}
if (tail == id_)
{
tail = timer.previous;
}
else
{
ptimers[timer.next].previous = timer.previous;
}
if (!has_expired)
{
// Adjust the next delta.
if (timer.next != etl::timer::id::NO_TIMER)
{
ptimers[timer.next].delta += timer.delta;
}
}
timer.previous = etl::timer::id::NO_TIMER;
timer.next = etl::timer::id::NO_TIMER;
timer.delta = etl::timer::state::Inactive;
}
//*******************************
etl::message_timer_data& front()
{
return ptimers[head];
}
//*******************************
const etl::message_timer_data& front() const
{
return ptimers[head];
}
//*******************************
etl::timer::id::type begin()
{
return head;
}
//*******************************
etl::timer::id::type next(etl::timer::id::type last)
{
return ptimers[last].next;
}
//*******************************
void clear()
{
etl::timer::id::type id = begin();
while (id != etl::timer::id::NO_TIMER)
{
etl::message_timer_data& timer = ptimers[id];
id = next(id);
timer.next = etl::timer::id::NO_TIMER;
}
head = etl::timer::id::NO_TIMER;
tail = etl::timer::id::NO_TIMER;
}
private:
etl::timer::id::type head;
etl::timer::id::type tail;
etl::message_timer_data* const ptimers;
};
} // namespace private_message_timer
//***************************************************************************
//***************************************************************************
class imessage_timer
{
public:
typedef etl::delegate<void(etl::timer::id::type)> event_callback_type;
//*******************************************
//*******************************************
etl::timer::id::type register_timer(const etl::imessage& message_, etl::imessage_router& router_, uint32_t period_, bool repeating_,
etl::message_router_id_t destination_router_id_ = etl::imessage_router::ALL_MESSAGE_ROUTERS)
{
etl::timer::id::type id = etl::timer::id::NO_TIMER;
bool is_space = (registered_timers < Max_Timers);
if (is_space)
{
// There's no point adding null message routers.
if (!router_.is_null_router())
{
// Search for the free space.
for (uint_least8_t i = 0U; i < Max_Timers; ++i)
{
etl::message_timer_data& timer = timer_array[i];
if (timer.id == etl::timer::id::NO_TIMER)
{
// Create in-place.
new (&timer) message_timer_data(i, message_, router_, period_, repeating_, destination_router_id_);
++registered_timers;
id = i;
break;
}
}
}
}
return id;
}
//*******************************************
//*******************************************
bool unregister_timer(etl::timer::id::type id_)
{
bool result = false;
if (id_ != etl::timer::id::NO_TIMER)
{
etl::message_timer_data& timer = timer_array[id_];
if (timer.id != etl::timer::id::NO_TIMER)
{
if (timer.is_active())
{
ETL_DISABLE_TIMER_UPDATES;
active_list.remove(timer.id, false);
remove_callback.call_if(timer.id);
ETL_ENABLE_TIMER_UPDATES;
}
// Reset in-place.
new (&timer) message_timer_data();
--registered_timers;
result = true;
}
}
return result;
}
//*******************************************
//*******************************************
void enable(bool state_)
{
enabled = state_;
}
//*******************************************
//*******************************************
bool is_running() const
{
return enabled;
}
//*******************************************
//*******************************************
void clear()
{
ETL_DISABLE_TIMER_UPDATES;
active_list.clear();
ETL_ENABLE_TIMER_UPDATES;
for (int i = 0; i < Max_Timers; ++i)
{
new (&timer_array[i]) message_timer_data();
}
registered_timers = 0;
}
//*******************************************
// Called by the timer service to indicate the
// amount of time that has elapsed since the last successful call to 'tick'.
// Returns true if the tick was processed,
// false if not.
//*******************************************
bool tick(uint32_t count)
{
if (enabled)
{
if (ETL_TIMER_UPDATES_ENABLED)
{
// We have something to do?
bool has_active = !active_list.empty();
if (has_active)
{
while (has_active && (count >= active_list.front().delta))
{
etl::message_timer_data& timer = active_list.front();
count -= timer.delta;
active_list.remove(timer.id, true);
remove_callback.call_if(timer.id);
if (timer.repeating)
{
timer.delta = timer.period;
active_list.insert(timer.id);
insert_callback.call_if(timer.id);
}
if (timer.p_router != ETL_NULLPTR)
{
timer.p_router->receive(timer.destination_router_id, *(timer.p_message));
}
has_active = !active_list.empty();
}
if (has_active)
{
// Subtract any remainder from the next due timeout.
active_list.front().delta -= count;
}
}
return true;
}
}
return false;
}
//*******************************************
//*******************************************
bool start(etl::timer::id::type id_, bool immediate_ = false)
{
bool result = false;
// Valid timer id?
if (id_ != etl::timer::id::NO_TIMER)
{
etl::message_timer_data& timer = timer_array[id_];
// Registered timer?
if (timer.id != etl::timer::id::NO_TIMER)
{
// Has a valid period.
if (timer.period != etl::timer::state::Inactive)
{
ETL_DISABLE_TIMER_UPDATES;
if (timer.is_active())
{
active_list.remove(timer.id, false);
remove_callback.call_if(timer.id);
}
timer.delta = immediate_ ? 0 : timer.period;
active_list.insert(timer.id);
insert_callback.call_if(timer.id);
ETL_ENABLE_TIMER_UPDATES;
result = true;
}
}
}
return result;
}
//*******************************************
//*******************************************
bool stop(etl::timer::id::type id_)
{
bool result = false;
// Valid timer id?
if (id_ != etl::timer::id::NO_TIMER)
{
etl::message_timer_data& timer = timer_array[id_];
// Registered timer?
if (timer.id != etl::timer::id::NO_TIMER)
{
if (timer.is_active())
{
ETL_DISABLE_TIMER_UPDATES;
active_list.remove(timer.id, false);
remove_callback.call_if(timer.id);
ETL_ENABLE_TIMER_UPDATES;
}
result = true;
}
}
return result;
}
//*******************************************
//*******************************************
bool set_period(etl::timer::id::type id_, uint32_t period_)
{
if (stop(id_))
{
timer_array[id_].period = period_;
return true;
}
return false;
}
//*******************************************
//*******************************************
bool set_mode(etl::timer::id::type id_, bool repeating_)
{
if (stop(id_))
{
timer_array[id_].repeating = repeating_;
return true;
}
return false;
}
//*******************************************
//*******************************************
bool has_active_timer() const
{
ETL_DISABLE_TIMER_UPDATES;
bool result = !active_list.empty();
ETL_ENABLE_TIMER_UPDATES;
return result;
}
//*******************************************
//*******************************************
uint32_t time_to_next() const
{
uint32_t delta = static_cast<uint32_t>(etl::timer::interval::No_Active_Interval);
ETL_DISABLE_TIMER_UPDATES;
if (!active_list.empty())
{
delta = active_list.front().delta;
}
ETL_ENABLE_TIMER_UPDATES;
return delta;
}
//*******************************************
//*******************************************
void set_insert_callback(event_callback_type insert_)
{
insert_callback = insert_;
}
//*******************************************
//*******************************************
void set_remove_callback(event_callback_type remove_)
{
remove_callback = remove_;
}
//*******************************************
void clear_insert_callback()
{
insert_callback.clear();
}
//*******************************************
void clear_remove_callback()
{
remove_callback.clear();
}
protected:
//*******************************************
//*******************************************
imessage_timer(message_timer_data* const timer_array_, const uint_least8_t Max_Timers_)
: timer_array(timer_array_)
, active_list(timer_array_)
, enabled(false)
,
#if defined(ETL_MESSAGE_TIMER_USE_ATOMIC_LOCK)
process_semaphore(0)
,
#endif
registered_timers(0)
, Max_Timers(Max_Timers_)
{
}
//*******************************************
//*******************************************
~imessage_timer() {}
private:
// The array of timer data structures.
message_timer_data* const timer_array;
// The list of active timers.
private_message_timer::list active_list;
bool enabled;
#if defined(ETL_MESSAGE_TIMER_USE_ATOMIC_LOCK)
#if defined(ETL_TIMER_SEMAPHORE_TYPE)
typedef ETL_TIMER_SEMAPHORE_TYPE timer_semaphore_t;
#else
#if ETL_HAS_ATOMIC
typedef etl::atomic_uint16_t timer_semaphore_t;
#else
#error No atomic type available
#endif
#endif
mutable etl::timer_semaphore_t process_semaphore;
#endif
uint_least8_t registered_timers;
event_callback_type insert_callback;
event_callback_type remove_callback;
public:
const uint_least8_t Max_Timers;
};
//***************************************************************************
//***************************************************************************
template <uint_least8_t Max_Timers_>
class message_timer : public etl::imessage_timer
{
public:
ETL_STATIC_ASSERT(Max_Timers_ <= 254, "No more than 254 timers are allowed");
//*******************************************
//*******************************************
message_timer()
: imessage_timer(timer_array, Max_Timers_)
{
}
private:
message_timer_data timer_array[Max_Timers_];
};
} // namespace etl
#undef ETL_DISABLE_TIMER_UPDATES
#undef ETL_ENABLE_TIMER_UPDATES
#undef ETL_TIMER_UPDATES_ENABLED
#endif
algorithm.h
etl::delegate
Declaration.
Definition delegate_cpp03.h:191
etl::imessage_router
This is the base of all message routers.
Definition message_router.h:141
etl::imessage_timer
Interface for message timer.
Definition message_timer.h:326
etl::imessage_timer::time_to_next
uint32_t time_to_next() const
Definition message_timer.h:599
etl::imessage_timer::has_active_timer
bool has_active_timer() const
Check if there is an active timer.
Definition message_timer.h:585
etl::imessage_timer::set_remove_callback
void set_remove_callback(event_callback_type remove_)
Set a callback when a timer is removed from list.
Definition message_timer.h:624
etl::imessage_timer::enable
void enable(bool state_)
Enable/disable the timer.
Definition message_timer.h:401
etl::imessage_timer::start
bool start(etl::timer::id::type id_, bool immediate_=false)
Starts a timer.
Definition message_timer.h:489
etl::imessage_timer::unregister_timer
bool unregister_timer(etl::timer::id::type id_)
Unregister a timer.
Definition message_timer.h:369
etl::imessage_timer::imessage_timer
imessage_timer(message_timer_data *const timer_array_, const uint_least8_t Max_Timers_)
Constructor.
Definition message_timer.h:646
etl::imessage_timer::register_timer
etl::timer::id::type register_timer(const etl::imessage &message_, etl::imessage_router &router_, uint32_t period_, bool repeating_, etl::message_router_id_t destination_router_id_=etl::imessage_router::ALL_MESSAGE_ROUTERS)
Register a timer.
Definition message_timer.h:334
etl::imessage_timer::is_running
bool is_running() const
Get the enable/disable state.
Definition message_timer.h:409
etl::imessage_timer::set_mode
bool set_mode(etl::timer::id::type id_, bool repeating_)
Sets a timer's mode.
Definition message_timer.h:571
etl::imessage_timer::set_insert_callback
void set_insert_callback(event_callback_type insert_)
Set a callback when a timer is inserted on list.
Definition message_timer.h:616
etl::imessage_timer::clear
void clear()
Clears the timer of data.
Definition message_timer.h:417
etl::imessage_timer::stop
bool stop(etl::timer::id::type id_)
Stops a timer.
Definition message_timer.h:527
etl::imessage_timer::~imessage_timer
~imessage_timer()
Destructor.
Definition message_timer.h:663
etl::imessage_timer::set_period
bool set_period(etl::timer::id::type id_, uint32_t period_)
Sets a timer's period.
Definition message_timer.h:557
etl::imessage
Definition message.h:73
etl::message_timer::message_timer
message_timer()
Constructor.
Definition message_timer.h:712
etl::private_message_timer::list
A specialised intrusive linked list for timer data.
Definition message_timer.h:153
delegate.h
etl
Definition absolute.h:40
nullptr.h
platform.h
etl::message_timer_data
The configuration of a timer.
Definition message_timer.h:84
etl::message_timer_data::is_active
bool is_active() const
Returns true if the timer is active.
Definition message_timer.h:117
etl::message_timer_data::set_inactive
void set_inactive()
Sets the timer to the inactive state.
Definition message_timer.h:125
etl::timer::id
Definition timer.h:88
etl::timer
Common definitions for the timer framework.
Definition timer.h:55