Group that contains macros & functions for timer deletion. More...
Macros | |
| #define | xTimerDelete(xTimer, xTicksToWait) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_DELETE, 0U, NULL, ( xTicksToWait ) ) |
| Delete a timer that was previously created using the xTimerCreate() API function. More... | |
Detailed Description
Group that contains macros & functions for timer deletion.
Macro Definition Documentation
◆ xTimerDelete
| #define xTimerDelete | ( | xTimer, | |
| xTicksToWait | |||
| ) | xTimerGenericCommand( ( xTimer ), tmrCOMMAND_DELETE, 0U, NULL, ( xTicksToWait ) ) |
#include <timers.h>
Delete a timer that was previously created using the xTimerCreate() API function.
Timer functionality is provided by a timer service/daemon task. Many of the public FreeRTOS timer API functions send commands to the timer service task through a queue called the timer command queue. The timer command queue is private to the kernel itself and is not directly accessible to application code. The length of the timer command queue is set by the configTIMER_QUEUE_LENGTH configuration constant.
The configUSE_TIMERS configuration constant must be set to 1 for xTimerDelete() to be available.
- Parameters
-
xTimer The handle of the timer being deleted. xTicksToWait Specifies the time, in ticks, that the calling task should be held in the Blocked state to wait for the delete command to be successfully sent to the timer command queue, should the queue already be full when xTimerDelete() was called. xTicksToWait is ignored if xTimerDelete() is called before the scheduler is started.
- Returns
- pdFAIL will be returned if the delete command could not be sent to the timer command queue even after xTicksToWait ticks had passed. pdPASS will be returned if the command was successfully sent to the timer command queue. When the command is actually processed will depend on the priority of the timer service/daemon task relative to other tasks in the system. The timer service/daemon task priority is set by the configTIMER_TASK_PRIORITY configuration constant.
Example usage:
See the xTimerChangePeriod() API function example usage scenario.
