TickType_t xTicksToWait );
Used to pend the execution of a function to the RTOS daemon task (the timer
service task, hence this function is pre-fixed with 'Timer').
Functions that can be deferred to the RTOS daemon task must have the following
void vPendableFunction( void * pvParameter1, uint32_t ulParameter2 );
The pvParameter1 and ulParameter2 are provided for use by the
INCLUDE_xTimerPendFunctionCall() and configUSE_TIMERS must both be set to
1 for xTimerPendFunctionCall() to be available.
The function to execute from the timer service/
daemon task. The function must conform to the PendedFunction_t
prototype as shown above.
The value of the callback function's first parameter.
The parameter has a void * type to allow it to be used to pass any type.
For example, integer types can be cast to a void *, or the void * can be
used to point to a structure.
The value of the callback function's second parameter.
Calling this function will result in a message being
sent to the timer daemon task on a queue. xTicksToWait is the amount of
time the calling task should remain in the Blocked state (so not using any
processing time) for space to become available on the timer queue if the
queue is found to be full. The length of the queue is set by the
value of configTIMER_QUEUE_LENGTH in FreeRTOSConfig.h.
pdPASS is returned if the message was successfully sent to the RTOS
timer daemon task, otherwise pdFALSE is returned.
Copyright (C) 2004-2010 Richard Barry. Copyright (C) 2010-2016 Real Time Engineers Ltd.
Any and all data, files, source code, html content and documentation included in the FreeRTOSTM distribution or available on this site are the exclusive property of Real Time Engineers Ltd..
See the files license.txt (included in the distribution) and this copyright notice for more information. FreeRTOSTM and FreeRTOS.orgTM are trade marks of Real Time Engineers Ltd.