RTEMS 4.6.99.3 On-Line Library

Timer Manager TIMER_RESET - Reset an interval timer

RTEMS C User's Guide

8.4.10: TIMER_RESET - Reset an interval timer

CALLING SEQUENCE:

rtems_status_code rtems_timer_reset(
  rtems_id   id
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - timer reset successfully
RTEMS_INVALID_ID - invalid timer id
RTEMS_NOT_DEFINED - attempted to reset a when or newly created timer

DESCRIPTION:

This directive resets the timer associated with id. This timer must have been previously initiated with either the rtems_timer_fire_after or rtems_timer_server_fire_after directive. If active the timer is canceled, after which the timer is reinitiated using the same interval and timer service routine which the original rtems_timer_fire_after rtems_timer_server_fire_after directive used.

NOTES:

If the timer has not been used or the last usage of this timer was by a rtems_timer_fire_when or rtems_timer_server_fire_when directive, then the RTEMS_NOT_DEFINED error is returned.

Restarting a cancelled after timer results in the timer being reinitiated with its previous timer service routine and interval.

This directive will not cause the running task to be preempted.

RTEMS C User's Guide