XDK API  3.6.0
Documentation
Data Structures | Macros | Typedefs | Enumerations | Functions
BCDS_CmdProcessor.h File Reference
#include "BCDS_Utils.h"
#include "BCDS_Basics.h"
#include "BCDS_Retcode.h"
+ Include dependency graph for BCDS_CmdProcessor.h:

Data Structures

struct  _CmdProcessor_S
 

Macros

#define CMDPROCESSOR_MAX_NAME_LEN   UINT32_C(32)
 

Typedefs

typedef void(* CmdProcessor_Func_T )(void *param1, uint32_t param2)
 This data type represents a function pointer for the functions which can be handled by the command processor. More...
 
typedef struct _CmdProcessor_S CmdProcessor_T
 
typedef void * cmdProcessorQueueHandle_t
 
typedef void * cmdProcessorTaskHandle_t
 

Enumerations

enum  CmdProcessor_Retcode_E
 

Functions

 BCDS_DEPRECATED (Retcode_T CmdProcessor_initialize(CmdProcessor_T *cmdProcessor, char *name, uint32_t taskPriority, uint32_t taskStackDepth, uint32_t queueSize))
 This function initializes the command processor instance. It creates a queue which will carry the command functions and a task which will process the queue. More...
 
 BCDS_DEPRECATED (Retcode_T CmdProcessor_enqueue(CmdProcessor_T *cmdProcessor, CmdProcessor_Func_T func, void *param1, uint32_t param2))
 This routine is used to hand-over a function to the command processor for execution. The function is added to the queue which is processed in a FIFO manner. More...
 
 BCDS_DEPRECATED (void CmdProcessor_suspend(CmdProcessor_T *cmdProcessor))
 The API suspends the command processor service. It is used to stop the execution of the command processor task functionality. More...
 
Retcode_T CmdProcessor_Enqueue (CmdProcessor_T *cmdProcessor, CmdProcessor_Func_T func, void *param1, uint32_t param2)
 This routine is used to hand-over a function to the command processor for execution. The function is added to the queue which is processed in a FIFO manner. More...
 
Retcode_T CmdProcessor_EnqueueFromIsr (CmdProcessor_T *cmdProcessor, CmdProcessor_Func_T func, void *param1, uint32_t param2)
 This routine is used to hand-over a function to the command processor from ISR context. The function is added to the queue which is processed in a FIFO manner. More...
 
Retcode_T CmdProcessor_Initialize (CmdProcessor_T *cmdProcessor, char *name, uint32_t taskPriority, uint32_t taskStackDepth, uint32_t queueSize)
 This function initializes the command processor instance. It creates a queue which will carry the command functions and a task which will process the queue. More...
 
void CmdProcessor_Resume (CmdProcessor_T *cmdProcessor)
 The API resumes the command processor service. It is used to execute the suspended command processor task functionality. More...
 
void CmdProcessor_Suspend (CmdProcessor_T *cmdProcessor)
 The API suspends the command processor service. It is used to stop the execution of the command processor task functionality. More...
 

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:49 by doxygen 1.8.8