libxr  1.0
Want to be the best embedded framework
Loading...
Searching...
No Matches
basic_queue.hpp
1#pragma once
2
3#include <cstddef>
4#include <cstdint>
5
6#include "queue_base.hpp"
7#include "queue_typed_base.hpp"
8
9namespace LibXR
10{
23template <typename Data>
24class Queue final : public QueueTypedBase<Queue<Data>, Data>, public QueueBase
25{
26 public:
27 using ValueType = Data;
32
40 explicit Queue(size_t length) : QueueBase(sizeof(Data), length) {}
41
52 Queue(size_t length, uint8_t* buffer) : QueueBase(sizeof(Data), length, buffer) {}
53
68 Data& operator[](int32_t index)
69 {
70 if (index >= 0)
71 {
72 index = (head_ + index) % length_;
73 }
74 else
75 {
76 index = (tail_ + index + length_) % length_;
77 }
78
79 return *reinterpret_cast<Data*>(&queue_array_[index * ELEMENT_SIZE]);
80 }
81
89 ErrorCode Peek(Data& data) { return QueueBase::PeekBytes(&data); }
90
99 ErrorCode PushBatch(const Data* data, size_t size)
100 {
101 return QueueBase::PushBatchBytes(data, size);
102 }
103
112 ErrorCode PopBatch(Data* data, size_t size)
113 {
114 return QueueBase::PopBatchBytes(data, size);
115 }
116
125 ErrorCode PeekBatch(Data* data, size_t size)
126 {
127 return QueueBase::PeekBatchBytes(data, size);
128 }
129
136 ErrorCode Overwrite(const Data& data) { return QueueBase::OverwriteBytes(&data); }
137
143 [[nodiscard]] size_t MaxSize() const { return QueueBase::MaxSize(); }
144};
145} // namespace LibXR
提供固定大小循环缓冲区的字节 FIFO 队列。
const uint16_t ELEMENT_SIZE
单个元素的字节数。 Byte size of one element.
uint8_t * queue_array_
队列数据缓冲区。 Queue data buffer.
ErrorCode PopBatchBytes(void *data, size_t size)
按字节批量出队多个元素。
ErrorCode OverwriteBytes(const void *data)
清空当前状态后,用一个新元素覆盖队列内容。
ErrorCode PeekBatchBytes(void *data, size_t size)
按字节批量查看多个元素但不出队。
size_t MaxSize() const
获取队列最大容量。
ErrorCode PushBatchBytes(const void *data, size_t size)
按字节批量入队多个元素。
size_t length_
队列最大容量。 Maximum queue capacity.
size_t head_
当前队头物理槽位下标。 Physical slot index of the current head.
size_t tail_
下一个待写入物理槽位下标。 Physical slot index of the next enqueue position.
ErrorCode PeekBytes(void *data)
按字节查看队头元素但不出队。
基于 QueueBase 的泛型队列模板类。
ErrorCode PopBatch(Data *data, size_t size)
批量移除多个元素并复制到输出数组。
Queue(size_t length, uint8_t *buffer)
使用外部缓冲区构造强类型队列。
ErrorCode PeekBatch(Data *data, size_t size)
批量查看多个元素但不移除。
ErrorCode PushBatch(const Data *data, size_t size)
批量推入多个元素。
ErrorCode Peek(Data &data)
查看队头元素但不出队。
ErrorCode Overwrite(const Data &data)
清空当前状态后,用一个新元素覆盖队列内容。
size_t MaxSize() const
获取队列最大容量。
Queue(size_t length)
构造一个由内部缓冲区支撑的强类型队列。
Data & operator[](int32_t index)
按逻辑索引访问队列中的元素。
强类型队列的公共薄包装。
LibXR 命名空间
Definition ch32_can.hpp:14
ErrorCode
定义错误码枚举