LibXR::Topic::ASyncSubscriber< Data > Class Template Reference

异步订阅者类，用于订阅异步数据 Asynchronous subscriber class for subscribing to asynchronous data More...

#include <message.hpp>

Collaboration diagram for LibXR::Topic::ASyncSubscriber< Data >:

Public Member Functions
	ASyncSubscriber (const char *name, Domain *domain=nullptr)
	构造函数，通过名称和数据创建订阅者 Constructor to create a subscriber with a name and data
	ASyncSubscriber (Topic topic)
	构造函数，使用 Topic 进行初始化 Constructor using a Topic for initialization
bool	Available ()
	检查数据是否可用 Checks if data is available
Data &	GetData ()
	获取当前数据 Retrieves the current data
void	StartWaiting ()
	开始等待数据更新 Starts waiting for data update

Data Fields
LockFreeList::Node< ASyncBlock > *	block_
	订阅者数据块。Subscriber data block.

Detailed Description

template<typename Data>
class LibXR::Topic::ASyncSubscriber< Data >

异步订阅者类，用于订阅异步数据 Asynchronous subscriber class for subscribing to asynchronous data

Template Parameters

Data	订阅的数据类型 Subscribed data type

Definition at line 322 of file message.hpp.

Constructor & Destructor Documentation

ASyncSubscriber() [1/2]

template<typename Data >

LibXR::Topic::ASyncSubscriber< Data >::ASyncSubscriber ( const char * name, Domain * domain = nullptr )

inline

构造函数，通过名称和数据创建订阅者 Constructor to create a subscriber with a name and data

Parameters

name	订阅的主题名称 Name of the subscribed topic
domain	可选的域指针 Optional domain pointer (default: nullptr)

Note

包含动态内存分配。 Contains dynamic memory allocation.

Definition at line 334 of file message.hpp.

    {
      *this = ASyncSubscriber(WaitTopic(name, UINT32_MAX, domain));
    }

ASyncSubscriber() [2/2]

template<typename Data >

LibXR::Topic::ASyncSubscriber< Data >::ASyncSubscriber ( Topic topic )

inline

构造函数，使用 Topic 进行初始化 Constructor using a Topic for initialization

Parameters

topic

订阅的主题 Subscribed topic

Note

包含动态内存分配。 Contains dynamic memory allocation.

Definition at line 347 of file message.hpp.

    {
      if (topic.block_->data_.check_length)
      {
        ASSERT(topic.block_->data_.max_length == sizeof(Data));
      }
      else
      {
        ASSERT(topic.block_->data_.max_length <= sizeof(Data));
      }
 
      block_ = new LockFreeList::Node<ASyncBlock>;
      block_->data_.type = SuberType::ASYNC;
      block_->data_.buff = *(new Data);
      topic.block_->data_.subers.Add(*block_);
    }

Member Function Documentation

Available()

template<typename Data >

bool LibXR::Topic::ASyncSubscriber< Data >::Available ( )

inline

检查数据是否可用 Checks if data is available

Returns

true 如果数据已准备好，则返回 true true if data is ready

false 如果数据不可用，则返回 false false if data is not available

Definition at line 372 of file message.hpp.

    {
      return block_->data_.state.load(std::memory_order_acquire) ==
             ASyncSubscriberState::DATA_READY;
    }

GetData()

template<typename Data >

Data & LibXR::Topic::ASyncSubscriber< Data >::GetData ( )

inline

获取当前数据 Retrieves the current data

Returns

Data& 返回数据引用 Reference to the data

Definition at line 384 of file message.hpp.

    {
      block_->data_.state.store(ASyncSubscriberState::IDLE, std::memory_order_release);
      return *reinterpret_cast<Data *>(block_->data_.buff.addr_);
    }

StartWaiting()

template<typename Data >

void LibXR::Topic::ASyncSubscriber< Data >::StartWaiting ( )

inline

开始等待数据更新 Starts waiting for data update

Definition at line 394 of file message.hpp.

    {
      block_->data_.state.store(ASyncSubscriberState::WAITING, std::memory_order_release);
    }

Field Documentation

block_

template<typename Data >

LockFreeList::Node<ASyncBlock>* LibXR::Topic::ASyncSubscriber< Data >::block_

订阅者数据块。Subscriber data block.

Definition at line 399 of file message.hpp.

---

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

• src/middleware/message.hpp