CHERIoT RTOS
A compartmentalised RTOS for CHERIoT hardware
Loading...
Searching...
No Matches
MessageQueue Struct Reference

Structure representing a queue. More...

#include <queue.h>

Public Member Functions

 _Atomic (uint32_t) producer
 The producer counter.
 _Atomic (uint32_t) consumer
 The consumer counter.
 MessageQueue (size_t elementSize, size_t queueSize)

Public Attributes

size_t elementSize
 The size of one element in this queue.
size_t queueSize
 The size of the queue.

Detailed Description

Structure representing a queue.

This structure represents the queue metadata, the buffer is stored at the end.

A queue is a ring buffer of fixed-sized elements with a producer and consumer counter.

Definition at line 43 of file queue.h.

Constructor & Destructor Documentation

◆ MessageQueue()

MessageQueue::MessageQueue ( size_t elementSize,
size_t queueSize )
inline

Definition at line 63 of file queue.h.

Member Data Documentation

◆ elementSize

size_t MessageQueue::elementSize

The size of one element in this queue.

This should not be modified after construction.

Definition at line 49 of file queue.h.

Referenced by _Atomic().

◆ queueSize

size_t MessageQueue::queueSize

The size of the queue.

This should not be modified after construction.

Definition at line 53 of file queue.h.

Referenced by _Atomic(), and xStreamBufferSpacesAvailable().


The documentation for this struct was generated from the following file: