* Added ctimer_restart(). Patch by Moritz Struebe.

* Added ctimer_expired().
This commit is contained in:
nifi 2009-11-19 18:32:05 +00:00
parent 3c1a7f3bc7
commit 1f2c226d8e
2 changed files with 101 additions and 2 deletions

View File

@ -33,7 +33,7 @@
* *
* This file is part of the Contiki operating system. * This file is part of the Contiki operating system.
* *
* $Id: ctimer.c,v 1.5 2007/11/13 15:13:03 nifi Exp $ * $Id: ctimer.c,v 1.6 2009/11/19 18:32:05 nifi Exp $
*/ */
/** /**
@ -131,6 +131,19 @@ ctimer_reset(struct ctimer *c)
} }
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
void void
ctimer_restart(struct ctimer *c)
{
if(initialized) {
PROCESS_CONTEXT_BEGIN(&ctimer_process);
etimer_restart(&c->etimer);
PROCESS_CONTEXT_END(&ctimer_process);
}
list_remove(ctimer_list, c);
list_add(ctimer_list, c);
}
/*---------------------------------------------------------------------------*/
void
ctimer_stop(struct ctimer *c) ctimer_stop(struct ctimer *c)
{ {
if(initialized) { if(initialized) {
@ -142,4 +155,19 @@ ctimer_stop(struct ctimer *c)
list_remove(ctimer_list, c); list_remove(ctimer_list, c);
} }
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
int
ctimer_expired(struct ctimer *c)
{
struct ctimer *t;
if(initialized) {
return etimer_expired(&c->etimer);
}
for(t = list_head(ctimer_list); t != NULL; t = t->next) {
if(t == c) {
return 0;
}
}
return 1;
}
/*---------------------------------------------------------------------------*/
/** @} */ /** @} */

View File

@ -42,7 +42,7 @@
* *
* This file is part of the Contiki operating system. * This file is part of the Contiki operating system.
* *
* $Id: ctimer.h,v 1.3 2007/03/31 18:31:27 adamdunkels Exp $ * $Id: ctimer.h,v 1.4 2009/11/19 18:32:05 nifi Exp $
*/ */
/** /**
@ -65,12 +65,83 @@ struct ctimer {
void *ptr; void *ptr;
}; };
/**
* \brief Reset a callback timer with the same interval as was
* previously set.
* \param c A pointer to the callback timer.
*
* This function resets the callback timer with the same
* interval that was given to the callback timer with the
* ctimer_set() function. The start point of the interval
* is the exact time that the callback timer last
* expired. Therefore, this function will cause the timer
* to be stable over time, unlike the ctimer_restart()
* function.
*
* \sa ctimer_restart()
*/
void ctimer_reset(struct ctimer *c); void ctimer_reset(struct ctimer *c);
/**
* \brief Restart a callback timer from the current point in time
* \param c A pointer to the callback timer.
*
* This function restarts the callback timer with the same
* interval that was given to the ctimer_set()
* function. The callback timer will start at the current
* time.
*
* \note A periodic timer will drift if this function is
* used to reset it. For periodic timers, use the
* ctimer_reset() function instead.
*
* \sa ctimer_reset()
*/
void ctimer_restart(struct ctimer *c);
/**
* \brief Set a callback timer.
* \param c A pointer to the callback timer.
* \param t The interval before the timer expires.
* \param f A function to be called when the timer expires.
* \param ptr An opaque pointer that will be supplied as an argument to the callback function.
*
* This function is used to set a callback timer for a time
* sometime in the future. When the callback timer expires,
* the callback function f will be called with ptr as argument.
*
*/
void ctimer_set(struct ctimer *c, clock_time_t t, void ctimer_set(struct ctimer *c, clock_time_t t,
void (*f)(void *), void *ptr); void (*f)(void *), void *ptr);
/**
* \brief Stop a pending callback timer.
* \param c A pointer to the pending callback timer.
*
* This function stops a callback timer that has previously
* been set with ctimer_set(), ctimer_reset(), or ctimer_restart().
* After this function has been called, the callback timer will be
* expired and will not call the callback function.
*
*/
void ctimer_stop(struct ctimer *c); void ctimer_stop(struct ctimer *c);
/**
* \brief Check if a callback timer has expired.
* \param c A pointer to the callback timer
* \return Non-zero if the timer has expired, zero otherwise.
*
* This function tests if a callback timer has expired and
* returns true or false depending on its status.
*/
int ctimer_expired(struct ctimer *c);
/**
* \brief Initialize the callback timer library.
*
* This function initializes the callback timer library and
* should be called from the system boot up code.
*/
void ctimer_init(void); void ctimer_init(void);
#endif /* __CTIMER_H__ */ #endif /* __CTIMER_H__ */