mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-02-18 19:03:16 +00:00
415096c3b2
Improved the docs for the 3 main Tactility projects. I also fixed some inaccuracies and bugs in certain APIs as I went through the code.
81 lines
2.0 KiB
C++
81 lines
2.0 KiB
C++
/**
|
|
* @file MessageQueue.h
|
|
*
|
|
* MessageQueue is a wrapper for FreeRTOS xQueue functionality.
|
|
* There is no additional thread-safety on top of the xQueue functionality,
|
|
* so make sure you create a lock if needed.
|
|
*/
|
|
#pragma once
|
|
|
|
#include "CoreTypes.h"
|
|
|
|
#ifdef ESP_PLATFORM
|
|
#include "freertos/FreeRTOS.h"
|
|
#include "freertos/queue.h"
|
|
#else
|
|
#include "FreeRTOS.h"
|
|
#include "queue.h"
|
|
#endif
|
|
|
|
namespace tt {
|
|
|
|
/**
|
|
* Message Queue implementation.
|
|
* Calls can be done from ISR/IRQ mode unless otherwise specified.
|
|
*/
|
|
class MessageQueue {
|
|
private:
|
|
QueueHandle_t queue_handle;
|
|
|
|
public:
|
|
/** Allocate message queue
|
|
* @param[in] capacity Maximum messages in queue
|
|
* @param[in] messageSize The size in bytes of a single message
|
|
*/
|
|
MessageQueue(uint32_t capacity, uint32_t messageSize);
|
|
|
|
~MessageQueue();
|
|
|
|
/** Post a message to the queue.
|
|
* The message is queued by copy, not by reference.
|
|
* @param[in] message A pointer to a message. The message will be copied into a buffer.
|
|
* @param[in] timeoutTicks
|
|
* @return success result
|
|
*/
|
|
bool put(const void* message, uint32_t timeoutTicks);
|
|
|
|
/** Get message from queue
|
|
* @param[out] message A pointer to an already allocated message object
|
|
* @param[in] timeoutTicks
|
|
* @return success result
|
|
*/
|
|
bool get(void* message, uint32_t timeoutTicks);
|
|
|
|
/**
|
|
* @return The maximum amount of messages that can be in the queue at any given time.
|
|
*/
|
|
uint32_t getCapacity() const;
|
|
|
|
/**
|
|
* @return The size of a single message in bytes
|
|
*/
|
|
uint32_t getMessageSize() const;
|
|
|
|
/**
|
|
* @return How many messages are currently in the queue.
|
|
*/
|
|
uint32_t getCount() const;
|
|
|
|
/**
|
|
* @return How many messages can be added to the queue before the put() method starts blocking.
|
|
*/
|
|
uint32_t getSpace() const;
|
|
|
|
/** Reset queue (cannot be called in ISR/IRQ mode)
|
|
* @return success result
|
|
*/
|
|
bool reset();
|
|
};
|
|
|
|
} // namespace
|