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

同步订阅者类，允许同步方式接收数据。Synchronous subscriber class allowing data reception in a synchronous manner. More...

#include <message.hpp>

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

Public Member Functions
	SyncSubscriber (const char *name, Data &data, Domain *domain=nullptr)
	通过主题名称构造同步订阅者。Constructs a synchronous subscriber by topic name.
	SyncSubscriber (Topic topic, Data &data)
	通过 Topic 句柄构造同步订阅者。Constructs a synchronous subscriber using a Topic handle.
ErrorCode	Wait (uint32_t timeout=UINT32_MAX)
	等待接收数据。Waits for data reception.

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

Detailed Description

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

同步订阅者类，允许同步方式接收数据。Synchronous subscriber class allowing data reception in a synchronous manner.

Template Parameters

Data	订阅的数据类型。Type of data being subscribed to.

Definition at line 236 of file message.hpp.

Constructor & Destructor Documentation

SyncSubscriber() [1/2]

template<typename Data >

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

inline

通过主题名称构造同步订阅者。Constructs a synchronous subscriber by topic name.

Parameters

name	主题名称。Topic name.
data	存储接收数据的变量。Variable to store received data.
domain	可选的主题域。Optional topic domain.

Definition at line 246 of file message.hpp.

    {
      *this = SyncSubscriber<Data>(WaitTopic(name, UINT32_MAX, domain), data);
    }

SyncSubscriber() [2/2]

template<typename Data >

LibXR::Topic::SyncSubscriber< Data >::SyncSubscriber ( Topic topic, Data & data )

inline

通过 Topic 句柄构造同步订阅者。Constructs a synchronous subscriber using a Topic handle.

Parameters

topic	订阅的主题。Topic being subscribed to.
data	存储接收数据的变量。Variable to store received data.

Definition at line 257 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<SyncBlock>;
      block_->data_.type = SuberType::SYNC;
      block_->data_.buff = RawData(data);
      topic.block_->data_.subers.Add(*block_);
    }

Member Function Documentation

Wait()

template<typename Data >

ErrorCode LibXR::Topic::SyncSubscriber< Data >::Wait ( uint32_t timeout = UINT32_MAX )

inline

等待接收数据。Waits for data reception.

Parameters

timeout

超时时间（默认最大值）。Timeout period (default is maximum).

Returns

操作结果的错误码。Error code indicating the operation result.

Definition at line 279 of file message.hpp.

    {
      // TODO: Reset sem
      return block_->data_.sem.Wait(timeout);
    }

Field Documentation

block_

template<typename Data >

LockFreeList::Node<SyncBlock>* LibXR::Topic::SyncSubscriber< Data >::block_

订阅者数据块。Subscriber data block.

Definition at line 285 of file message.hpp.

---

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

• src/middleware/message.hpp