queues.h

Go to the documentation of this file.

 
// do not use pragma once here, has this can be mocked
#ifndef HAL_QUEUES_H
#define HAL_QUEUES_H
 
#ifdef __cplusplus
 
#include <cstddef>
#include <cstdint>
 
namespace lampda {
namespace hal {
namespace queues {
 
extern "C" {
#endif
 
  typedef void* QueueHandle_t;
 
  static constexpr uint32_t MaxStaticQueues = 5;
 
  typedef enum
  {
    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
  } HAL_queue_status_t;
 
  QueueHandle_t HAL_create_queue(size_t itemSize, uint32_t queueLength, uint32_t staticIndex, uint8_t* buffer);
 
  void HAL_delete_queue(QueueHandle_t handle);
 
  HAL_queue_status_t HAL_queue_send(QueueHandle_t handle, const void* item, uint32_t timeoutMs);
 
  HAL_queue_status_t HAL_queue_receive(QueueHandle_t handle, void* const outItem, uint32_t timeoutMs);
 
  size_t HAL_queue_get_number_of_items(QueueHandle_t handle);
 
#ifdef __cplusplus
}
} // namespace queues
} // namespace hal
} // namespace lampda
#endif
 
#endif