Data Structures | Functions
BCDS_Queue.h File Reference
#include "BCDS_Utils.h"
#include "BCDS_Basics.h"
#include "BCDS_Retcode.h"
#include "FreeRTOS.h"
#include "semphr.h"
+ Include dependency graph for BCDS_Queue.h:

Data Structures

struct  Queue_T
 The queue structure. More...
 
struct  QueueItem_T
 The queue item. More...
 

Functions

void Queue_Clear (Queue_T *Queue)
 Cleans the queue buffer from all messages. More...
 
uint32_t Queue_Count (const Queue_T *Queue)
 Gets number of messages available for receiving from the queue. More...
 
Retcode_T Queue_Create (Queue_T *Queue, uint8_t *Buffer, uint32_t BufferSize)
 Creates a queue by initializing its structure with provided buffer where queue items to be stored. More...
 
Retcode_T Queue_Delete (Queue_T *Queue)
 Deletes a queue by deinitializing its structure members. More...
 
Retcode_T Queue_Get (Queue_T *Queue, void **Data, uint32_t *DataSize, uint32_t Timeout)
 Gets an item with payload from the queue. More...
 
Retcode_T Queue_Purge (Queue_T *Queue)
 Purges a room in the queue buffer (dequeues message) occupied by received data. More...
 
Retcode_T Queue_Put (Queue_T *Queue, const void *Item, uint32_t ItemSize, const void *Payload, uint32_t PayloadSize)
 Puts an item with/without payload to the queue. More...
 

This documentation file has been automatically generated on Wed May 6 2020 20:45:18 by doxygen 1.8.8