qte_rarm.c File Reference

QTimeEvt_rearm() implementation. More...

#include "qf_pkg.h"
#include "qassert.h"

Go to the source code of this file.

Functions
uint8_t	QTimeEvt_rearm (QTimeEvt *me, QTimeEvtCtr nTicks)
	Rearm a time event.

---

Detailed Description

QTimeEvt_rearm() implementation.

Definition in file qte_rarm.c.

---

Function Documentation

uint8_t QTimeEvt_rearm	(	QTimeEvt *	me,
		QTimeEvtCtr	nTicks
	)

Rearm a time event.

The time event me gets rearmed with a new number of clock ticks nTicks. This facility can be used to prevent a one-shot time event from expiring (e.g., a watchdog time event), or to adjusts the current period of a periodic time event. Rearming a periodic timer leaves the interval unchanged and is a convenient method to adjust the phasing of the periodic time event.

The function returns 1 (TRUE) if the time event was running as it was re-armed. The return of 0 (FALSE) means that the time event was not truly rearmed because it was not running. The FALSE return is only possible for one-shot time events that have been automatically disarmed upon expiration. In this case the FALSE return means that the time event has already been posted or published and should be expected in the active object's state machine.

Definition at line 40 of file qte_rarm.c.

References QTimeEvt::prev, Q_REQUIRE, Q_USER_SIG, QF_timeEvtListHead_, QS_BEGIN_NOCRIT_, QS_END_NOCRIT_, QS_OBJ_, QS_QF_TIMEEVT_REARM, QS_teObj_, QS_TIME_, and QS_U8_.