Lamp-Da 0.1
A compact lantern project
Loading...
Searching...
No Matches
Namespaces | Typedefs | Enumerations | Functions
queues.h File Reference

Interface for platform-specific queue operations (e.g., FreeRTOS xQueue). More...

Go to the source code of this file.

Namespaces

namespace  lampda
 Program scope.
 
namespace  lampda::hal
 Hardware Abstraction Layer, handle the platform specific interactions. Can be changed to support different platforms.
 
namespace  lampda::hal::queues
 Implementation of inter thread queues.
 

Typedefs

typedef void * lampda::hal::queues::QueueHandle_t
 

Enumerations

enum  lampda::hal::queues::HAL_queue_status_t {
  HAL_QUEUE_OK = 0 , HAL_QUEUE_ERR_INVALID_PARAM = -1 , HAL_QUEUE_ERR_TIMEOUT = -2 , HAL_QUEUE_ERR_FULL = -3 ,
  HAL_QUEUE_ERR_EMPTY = -4 , HAL_QUEUE_ERR_OTHER = -5
}
 Queue operation status codes.
 

Functions

QueueHandle_t lampda::hal::queues::HAL_create_queue (size_t itemSize, uint32_t queueLength)
 Create a queue with the specified item size and maximum length.
 
void lampda::hal::queues::HAL_delete_queue (QueueHandle_t handle)
 Delete/free a queue and release its underlying resources.
 
HAL_queue_status_t lampda::hal::queues::HAL_queue_send (QueueHandle_t handle, const void *item, uint32_t timeoutMs)
 Send an item to the queue.
 
HAL_queue_status_t lampda::hal::queues::HAL_queue_receive (QueueHandle_t handle, void *const outItem, uint32_t timeoutMs)
 Receive an item from the queue. Blocks until an item is available or timeout expires.
 

Detailed Description

Interface for platform-specific queue operations (e.g., FreeRTOS xQueue).