libxr
Embedded C++ framework for bare-metal, RTOS and Linux
Loading...
Searching...
No Matches
sync.hpp
1#pragma once
2
3#include "../topic.hpp"
4
5namespace LibXR
6{
12{
23 enum WaitState : uint32_t
24 {
26 WAITING = 1,
27 WAIT_CLAIMED = 2
29 };
30
31 void* buff_addr;
32 void (*copy_payload)(
33 void* dst,
34 void* payload_addr);
38 std::atomic<uint32_t> wait_state =
39 WAIT_IDLE;
41};
42
49template <typename Data>
51{
52 public:
66 SyncSubscriber(const char* name, Data& data, Domain* domain = nullptr)
67 : SyncSubscriber(Topic(WaitTopic(name, UINT32_MAX, domain)), data)
68 {
69 }
70
84 SyncSubscriber(Topic topic, Data& data)
85 {
86 Topic::CheckSubscriberType<Data>(topic);
87
90 block_->data_.timestamp = MicrosecondTimestamp();
91 block_->data_.wait_state.store(SyncBlock::WAIT_IDLE, std::memory_order_relaxed);
92 block_->data_.buff_addr = &data;
93 block_->data_.copy_payload = &Topic::CopyPayload<Data>;
94 topic.block_->data_.subers.Add(*block_);
95 }
96
102 SyncSubscriber(const SyncSubscriber& other) = delete;
103
110 SyncSubscriber& operator=(const SyncSubscriber& other) = delete;
111
120 SyncSubscriber(SyncSubscriber&& other) noexcept : block_(other.block_)
121 {
122 other.block_ = nullptr;
123 }
124
136 {
137 if (this != &other)
138 {
139 block_ = other.block_;
140 other.block_ = nullptr;
141 }
142 return *this;
143 }
144
159 ErrorCode Wait(uint32_t timeout = UINT32_MAX)
160 {
161 ASSERT(block_ != nullptr);
162
163 auto& data = block_->data_;
164 uint32_t expected = SyncBlock::WAIT_IDLE;
165 if (!data.wait_state.compare_exchange_strong(expected, SyncBlock::WAITING,
166 std::memory_order_acq_rel,
167 std::memory_order_acquire))
168 {
169 return ErrorCode::BUSY;
170 }
171
172 auto wait_ans = data.sem.Wait(timeout);
173 if (wait_ans == ErrorCode::OK)
174 {
175 data.wait_state.store(SyncBlock::WAIT_IDLE, std::memory_order_release);
176 return ErrorCode::OK;
177 }
178
179 expected = SyncBlock::WAITING;
180 if (data.wait_state.compare_exchange_strong(expected, SyncBlock::WAIT_IDLE,
181 std::memory_order_acq_rel,
182 std::memory_order_acquire))
183 {
184 return wait_ans;
185 }
186
187 DEV_ASSERT(data.wait_state.load(std::memory_order_acquire) ==
189
190 ErrorCode finish_wait_ans;
191 do
192 {
193 finish_wait_ans = data.sem.Wait(UINT32_MAX);
194 } while (finish_wait_ans == ErrorCode::TIMEOUT);
195 REQUIRE(finish_wait_ans == ErrorCode::OK);
196 data.wait_state.store(SyncBlock::WAIT_IDLE, std::memory_order_release);
197 return ErrorCode::OK;
198 }
199
204 MicrosecondTimestamp GetTimestamp() const { return block_->data_.timestamp; }
205
207 nullptr;
208};
209} // namespace LibXR
数据节点模板,继承自 BaseNode,用于存储具体数据类型。 Template data node that inherits from BaseNode to store specific data...
Data data_
存储的数据 / The stored data.
微秒时间戳 / Microsecond timestamp
Data data_
存储的数据 / Stored data.
Definition rbt.hpp:98
信号量类,实现线程同步机制 Semaphore class implementing thread synchronization
Definition semaphore.hpp:23
topic 所属的命名域 / Naming domain that groups topics
Definition topic.hpp:207
调用 Wait() 收消息的订阅者 / Subscriber that receives messages by calling Wait()
Definition topic.hpp:255
SyncSubscriber(Topic topic, Data &data)
通过 Topic 句柄构造同步订阅者 / Construct a synchronous subscriber using a Topic handle
Definition sync.hpp:84
ErrorCode Wait(uint32_t timeout=UINT32_MAX)
等待接收数据 / Wait for data reception
Definition sync.hpp:159
LockFreeList::Node< SyncBlock > * block_
订阅者数据块 / Subscriber data block.
Definition sync.hpp:206
SyncSubscriber & operator=(const SyncSubscriber &other)=delete
禁止拷贝赋值同步订阅者 / Copy assignment is disabled for synchronous subscribers
MicrosecondTimestamp GetTimestamp() const
获取最近一次接收的消息时间戳 / Get the latest received message timestamp
Definition sync.hpp:204
SyncSubscriber(const char *name, Data &data, Domain *domain=nullptr)
通过主题名称构造同步订阅者 / Construct a synchronous subscriber by topic name
Definition sync.hpp:66
SyncSubscriber(SyncSubscriber &&other) noexcept
移动构造同步订阅者 / Move-construct one synchronous subscriber
Definition sync.hpp:120
SyncSubscriber & operator=(SyncSubscriber &&other) noexcept
移动赋值同步订阅者 / Move-assign one synchronous subscriber
Definition sync.hpp:135
SyncSubscriber(const SyncSubscriber &other)=delete
禁止拷贝同步订阅者 / Copy construction is disabled for synchronous subscribers
发布订阅主题 / Publish-subscribe topic
Definition topic.hpp:56
@ SYNC
同步等待型订阅者 / Synchronous wait-based subscriber.
static TopicHandle WaitTopic(const char *name, uint32_t timeout=UINT32_MAX, Domain *domain=nullptr)
等待指定名称的 topic 出现 / Wait until a topic with the given name exists
Definition topic.cpp:206
LibXR 命名空间 / LibXR namespace.
Definition ch32_can.hpp:14
ErrorCode
定义错误码枚举 / Defines an enumeration for error codes
@ TIMEOUT
超时 / Timeout
@ BUSY
忙碌 / Busy
@ OK
操作成功 / Operation successful
所有订阅块共用的公共头 / Common header shared by all subscriber blocks
Definition topic.hpp:237
同步订阅者自己挂的数据块 / Data block owned by one synchronous subscriber
Definition sync.hpp:12
void(* copy_payload)(void *dst, void *payload_addr)
Definition sync.hpp:32
void * buff_addr
收到消息后要拷到这里 / Received payloads are copied here.
Definition sync.hpp:31
std::atomic< uint32_t > wait_state
当前 Wait() 的挂起状态 / Current pending state of Wait().
Definition sync.hpp:38
Semaphore sem
用来唤醒 Wait() 的信号量 / Semaphore used to wake Wait().
Definition sync.hpp:40
WaitState
同步等待状态 / Synchronous wait state
Definition sync.hpp:24
@ WAIT_IDLE
当前没有挂起等待 / No wait is currently pending.
Definition sync.hpp:25
@ WAITING
当前有一个挂起的等待者 / One waiter is currently pending.
Definition sync.hpp:26
MicrosecondTimestamp timestamp
这里对应那份数据的时间戳 / Timestamp paired with the buffered data.
Definition sync.hpp:37