Timer< max_tasks, time_func > Class Template Reference

#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>
class Timer< max_tasks, time_func >

Definition at line 20 of file xtimer.h.

Member Typedef Documentation

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()

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 )

inlineprivate

Definition at line 110 of file xtimer.h.

    {
        struct task *const slot = next_task_slot();
 
        if (!slot){
            return NULL;
        }
 
        slot->handler = h;
        slot->opaque = opaque;
        slot->start = start;
        slot->expires = expires;
        slot->repeat = repeat;
 
        return slot;
    }

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.

    {
        const unsigned long now = time_func();
        return add_task(now, time - now, h, opaque);
    }

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.

    {
        return add_task(time_func(), interval, h, opaque, interval);
    }

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.

    {
        return add_task(time_func(), delay, h, opaque);
    }

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 ( )

inlineprivate

Definition at line 97 of file xtimer.h.

    {
        for (size_t i = 0; i < max_tasks; ++i)
        {
            struct task *const slot = &tasks[i];
            if (slot->handler == NULL)
                return slot;
        }
 
        return NULL;
    }

remove()

template<size_t max_tasks = TIMER_MAX_TASKS, unsigned long(*)() time_func = millis>

void Timer< max_tasks, time_func >::remove ( struct task * task )

inlineprivate

Definition at line 87 of file xtimer.h.

    {
        task->handler = NULL;
        task->opaque = NULL;
        task->start = 0;
        task->expires = 0;
        task->repeat = 0;
    }

tick() [1/2]

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.

    {
        tick(time_func());
    }

tick() [2/2]

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.

    {
        for (size_t i = 0; i < max_tasks; ++i)
        {
            struct task *const task = &tasks[i];
            const unsigned long duration = t - task->start;
 
            if (task->handler && duration >= task->expires)
            {
                task->repeat = task->handler(task->opaque) && task->repeat;
 
                if (task->repeat)
                    task->start = t;
                else
                    remove(task);
            }else{
            }
        }
    }

Member Data Documentation

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