xTimerPendFunctionCall() function

BaseType_t xTimerPendFunctionCall( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait ); Used to defer the execution of a function to the RTOS daemon task (the timer service task, hence this function is implemented in timers.c and is prefixed with 'Timer').

Syntax

Show:

Summary

Declaration

from timers.h:1221

BaseType_t xTimerPendFunctionCall( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait );

Arguments

Argument

Declared as

Description

xFunctionToPend

PendedFunction_t

The function to execute from the timer service/ daemon task. The function must conform to the PendedFunction_t prototype.

pvParameter1

void *

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, unsigned longs can be cast to a void *, or the void * can be used to point to a structure.

ulParameter2

uint32_t

The value of the callback function's second parameter.

xTicksToWait

TickType_t

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.

Return value

pdPASS is returned if the message was successfully sent to the timer daemon task, otherwise pdFALSE is returned.

Examples

References

from examples

xTimerPendFunctionCall() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle