XDK API  3.6.0
Documentation
Files | Data Structures | Typedefs | Functions
GuardedTask

Guarded Task interface. More...

+ Collaboration diagram for GuardedTask:

Files

file  BCDS_GuardedTask.h
 

Data Structures

struct  GuardedTask_S
 

Typedefs

typedef void(* GuardedTask_Function_T )(void)
 
typedef void * GuardedTask_SemaphoreHandle_T
 
typedef struct GuardedTask_S GuardedTask_T
 
typedef void * GuardedTask_TaskHandle_T
 

Functions

 BCDS_DEPRECATED (Retcode_T GuardedTask_initialize(GuardedTask_T *handle, GuardedTask_Function_T taskRunFunction, const char *taskName, uint32_t taskPriority, uint32_t taskStackSize))
 This function initializes a given GuardedTask handle. More...
 
 BCDS_DEPRECATED (Retcode_T GuardedTask_deinitialize(GuardedTask_T *handle))
 This function deinitializes a given GuardTask handle and sets all attributes to NULL. More...
 
Retcode_T GuardedTask_Deinitialize (GuardedTask_T *handle)
 This function deinitializes a given GuardTask handle and sets all attributes to NULL. More...
 
Retcode_T GuardedTask_Initialize (GuardedTask_T *handle, GuardedTask_Function_T taskRunFunction, const char *taskName, uint32_t taskPriority, uint32_t taskStackSize)
 This function initializes a given GuardedTask handle. More...
 
Retcode_T GuardedTask_Signal (GuardedTask_T *handle)
 This function signals the GuardTask-task to execute its user run function. More...
 
Retcode_T GuardedTask_SignalFromIsr (GuardedTask_T *handle)
 This function signals the GuardTask-task to execute its user run function. More...
 

Detailed Description


Data Structure Documentation

struct GuardedTask_S

Typedef Documentation

typedef void(* GuardedTask_Function_T)(void)
typedef struct GuardedTask_S GuardedTask_T
typedef void* GuardedTask_TaskHandle_T

Function Documentation

BCDS_DEPRECATED ( Retcode_T   GuardedTask_initializeGuardedTask_T *handle, GuardedTask_Function_T taskRunFunction, const char *taskName, uint32_t taskPriority, uint32_t taskStackSize)
Deprecated:
since version vxx.xx.xx, replaced by GuardedTask_Initialize
Parameters
[in]handle- A pointer to an empty GuardedTask structure
[in]taskRunFunction- A function pointer to the user-code run function that should be called by the task
[in]taskName- A cstring representing the name of the task
[in]taskPriority- The task priority
[in]taskStackSize- The task stack size
Return values
RETCODE_OK- Guarded Task has been initialized successfully
RETCODE_INVALID_PARAM- One of the parameters was invalid
RETCODE_OUT_OF_RESOURCES- Unable to allocate resources for task or semaphore
BCDS_DEPRECATED ( Retcode_T   GuardedTask_deinitializeGuardedTask_T *handle)

This function signals the GuardTask-task to execute its user run function.

Deprecated:
since version vxx.xx.xx, replaced by GuardedTask_Deinitialize
Parameters
[in]handle- A pointer to an initialized GuardTask structure.
Return values
RETCODE_OK- Guarded Task has been deinitialized successfully
RETCODE_INVALID_PARAM- handle pointer is NULL
Deprecated:
since version vxx.xx.xx, replaced by GuardedTask_Signal
Parameters
[in]handle- A pointer to an initialized GuardTask structure
Note
This function may ONLY be called from NON-ISR context!
Return values
RETCODE_OK- Task has been signaled properly
RETCODE_GUARDEDTASK_SEMAPHORE_ALREADY_GIVEN- Indicates that the semaphore was already in a given state. This implicitly means that the encapsulated task is still in execution
RETCODE_INVALID_PARAM- Given parameter was invalid
Deprecated:
since version vxx.xx.xx, replaced by GuardedTask_SignalFromIsr
Parameters
[in]handle- A pointer to an initialized GuardTask structure
Note
This function may ONLY be called from ISR context!
Return values
RETCODE_OK- Task has been signaled properly
RETCODE_GUARDEDTASK_SEMAPHORE_ALREADY_GIVEN- Indicates that the semaphore was already in a given state. This implicitly means that the encapsulated task is still in execution
RETCODE_INVALID_PARAM- Given parameter was invalid
Retcode_T GuardedTask_Deinitialize ( GuardedTask_T handle)
Parameters
[in]handle- A pointer to an initialized GuardTask structure.
Return values
RETCODE_OK- Guarded Task has been deinitialized successfully
RETCODE_INVALID_PARAM- handle pointer is NULL

+ Here is the caller graph for this function:

Retcode_T GuardedTask_Initialize ( GuardedTask_T handle,
GuardedTask_Function_T  taskRunFunction,
const char *  taskName,
uint32_t  taskPriority,
uint32_t  taskStackSize 
)
Parameters
[in]handle- A pointer to an empty GuardedTask structure
[in]taskRunFunction- A function pointer to the user-code run function that should be called by the task
[in]taskName- A cstring representing the name of the task
[in]taskPriority- The task priority
[in]taskStackSize- The task stack size
Return values
RETCODE_OK- Guarded Task has been initialized successfully
RETCODE_INVALID_PARAM- One of the parameters was invalid
RETCODE_OUT_OF_RESOURCES- Unable to allocate resources for task or semaphore

+ Here is the caller graph for this function:

Retcode_T GuardedTask_Signal ( GuardedTask_T handle)
Parameters
[in]handle- A pointer to an initialized GuardTask structure
Note
This function may ONLY be called from NON-ISR context!
Return values
RETCODE_OK- Task has been signaled properly
RETCODE_GUARDEDTASK_SEMAPHORE_ALREADY_GIVEN- Indicates that the semaphore was already in a given state. This implicitly means that the encapsulated task is still in execution
RETCODE_INVALID_PARAM- Given parameter was invalid
Retcode_T GuardedTask_SignalFromIsr ( GuardedTask_T handle)
Parameters
[in]handle- A pointer to an initialized GuardTask structure
Note
This function may ONLY be called from ISR context!
Return values
RETCODE_OK- Task has been signaled properly
RETCODE_GUARDEDTASK_SEMAPHORE_ALREADY_GIVEN- Indicates that the semaphore was already in a given state. This implicitly means that the encapsulated task is still in execution
RETCODE_INVALID_PARAM- Given parameter was invalid

+ Here is the caller graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:52 by doxygen 1.8.8