Timer< max_tasks, time_func > Class Template Reference
Timer< max_tasks, time_func >
#include <xtimer.h>
Classes
struct task
Public Types
typedef bool(* handler_t) (void *opaque)
Public Member Functions
bool at (unsigned long time, handler_t h, void *opaque=NULL)
bool every (unsigned long interval, handler_t h, void *opaque=NULL)
bool in (unsigned long delay, handler_t h, void *opaque=NULL)
void tick ()
void tick (unsigned long t)
Private Member Functions
struct task * add_task (unsigned long start, unsigned long expires, handler_t h, void *opaque, bool repeat=0)
struct task * next_task_slot ()
void remove (struct task *task)
Private Attributes
struct Timer::task tasks [max_tasks]
Detailed Description
template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis><?linebreak?>class Timer< max_tasks, time_func >
Definition at line 20 of file xtimer.h.
Member Typedef Documentation
handler_t
handler_tTimer< max_tasks, time_func >
Timer< max_tasks, time_func >handler_t
template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis> typedef bool(* Timer< max_tasks, time_func >::handler_t) (void *opaque)
Definition at line 23 of file xtimer.h.
Member Function Documentation
add_task()
add_taskTimer< max_tasks, time_func >
Timer< max_tasks, time_func >add_task
template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis> struct task * Timer< max_tasks, time_func >::add_task (unsigned long start, unsigned long expires, handler_t h, void * opaque, bool repeat = 0
)[inline], [private]
Definition at line 110 of file xtimer.h.
00112 {
00113 struct task *const slot = next_task_slot();
00114
00115 if (!slot){
00116 return NULL;
00117 }
00118
00119 slot->handler = h;
00120 slot->opaque = opaque;
00121 slot->start = start;
00122 slot->expires = expires;
00123 slot->repeat = repeat;
00124
00125 return slot;
00126 }
at()
atTimer< max_tasks, time_func >
Timer< max_tasks, time_func >at
template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis> bool Timer< max_tasks, time_func >::at (unsigned long time, handler_t h, void * opaque = NULL
)[inline]
Definition at line 33 of file xtimer.h.
00034 {
00035 const unsigned long now = time_func();
00036 return add_task(now, time - now, h, opaque);
00037 }
every()
everyTimer< max_tasks, time_func >
Timer< max_tasks, time_func >every
template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis> bool Timer< max_tasks, time_func >::every (unsigned long interval, handler_t h, void * opaque = NULL
)[inline]
Definition at line 41 of file xtimer.h.
00042 {
00043 return add_task(time_func(), interval, h, opaque, interval);
00044 }
in()
inTimer< max_tasks, time_func >
Timer< max_tasks, time_func >in
template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis> bool Timer< max_tasks, time_func >::in (unsigned long delay, handler_t h, void * opaque = NULL
)[inline]
Definition at line 26 of file xtimer.h.
00027 {
00028 return add_task(time_func(), delay, h, opaque);
00029 }
next_task_slot()
next_task_slotTimer< max_tasks, time_func >
Timer< max_tasks, time_func >next_task_slot
template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis> struct task * Timer< max_tasks, time_func >::next_task_slot ( )[inline], [private]
Definition at line 97 of file xtimer.h.
00098 {
00099 for (size_t i = 0; i < max_tasks; ++i)
00100 {
00101 struct task *const slot = &tasks[i];
00102 if (slot->handler == NULL)
00103 return slot;
00104 }
00105
00106 return NULL;
00107 }
remove()
removeTimer< max_tasks, time_func >
Timer< max_tasks, time_func >remove
template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis> void Timer< max_tasks, time_func >::remove (struct task * task)[inline], [private]
Definition at line 87 of file xtimer.h.
00088 {
00089 task->handler = NULL;
00090 task->opaque = NULL;
00091 task->start = 0;
00092 task->expires = 0;
00093 task->repeat = 0;
00094 }
tick()<computeroutput>[1/2]</computeroutput>
tickTimer< max_tasks, time_func >
Timer< max_tasks, time_func >tick
template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis> void Timer< max_tasks, time_func >::tick ( )[inline]
Definition at line 49 of file xtimer.h.
00050 {
00051 tick(time_func());
00052 }
tick()<computeroutput>[2/2]</computeroutput>
tickTimer< max_tasks, time_func >
Timer< max_tasks, time_func >tick
template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis> void Timer< max_tasks, time_func >::tick (unsigned long t)[inline]
Definition at line 56 of file xtimer.h.
00057 {
00058 for (size_t i = 0; i < max_tasks; ++i)
00059 {
00060 struct task *const task = &tasks[i];
00061 const unsigned long duration = t - task->start;
00062
00063 if (task->handler && duration >= task->expires)
00064 {
00065 task->repeat = task->handler(task->opaque) && task->repeat;
00066
00067 if (task->repeat)
00068 task->start = t;
00069 else
00070 remove(task);
00071 }else{
00072 }
00073 }
00074 }
Member Data Documentation
tasks
tasksTimer< max_tasks, time_func >
Timer< max_tasks, time_func >tasks
template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis> struct Timer::task Timer< max_tasks, time_func >::tasks[max_tasks][private]
The documentation for this class was generated from the following file:
xtimer.h