#include <intra_reader.h>

类 apollo::cyber::blocker::IntraReader< MessageT > 继承关系图:

apollo::cyber::blocker::IntraReader< MessageT > 的协作图:

Public 类型
using	MessagePtr = std::shared_ptr< MessageT >

using	Callback = std::function< void(const std::shared_ptr< MessageT > &)>

using	Iterator = typename std::list< std::shared_ptr< MessageT > >::const_iterator

Public 类型继承自 apollo::cyber::Reader< MessageT >
using	BlockerPtr = std::unique_ptr< blocker::Blocker< MessageT > >

using	ReceiverPtr = std::shared_ptr< transport::Receiver< MessageT > >

using	ChangeConnection = typename service_discovery::Manager::ChangeConnection

using	Iterator = typename std::list< std::shared_ptr< MessageT > >::const_iterator

Public 成员函数
	IntraReader (const proto::RoleAttributes &attr, const Callback &callback)

virtual	~IntraReader ()

bool	Init () override
	Init the Reader object

void	Shutdown () override
	Shutdown the Reader object

void	ClearData () override
	Clear local data

void	Observe () override
	Get stored data

bool	Empty () const override
	Query whether the Reader has data to be handled

bool	HasReceived () const override
	Query whether we have received data since last clear

void	Enqueue (const std::shared_ptr< MessageT > &msg) override
	Push `msg` to Blocker's `PublishQueue`

void	SetHistoryDepth (const uint32_t &depth) override
	Set Blocker's `PublishQueue`'s capacity to `depth`

uint32_t	GetHistoryDepth () const override
	Get Blocker's `PublishQueue`'s capacity

std::shared_ptr< MessageT >	GetLatestObserved () const override
	Get the latest message we `Observe`

std::shared_ptr< MessageT >	GetOldestObserved () const override
	Get the oldest message we `Observe`

Iterator	Begin () const override
	Get the begin iterator of `ObserveQueue`, used to traverse

Iterator	End () const override
	Get the end iterator of `ObserveQueue`, used to traverse

Public 成员函数继承自 apollo::cyber::Reader< MessageT >
	Reader (const proto::RoleAttributes &role_attr, const CallbackFunc< MessageT > &reader_func=nullptr, uint32_t pending_queue_size=DEFAULT_PENDING_QUEUE_SIZE)
	Constructor a Reader object.

virtual	~Reader ()

bool	Init () override
	Init Reader

void	Shutdown () override
	Shutdown Reader

void	Observe () override
	Get All data that `Blocker` stores

void	ClearData () override
	Clear `Blocker`'s data

bool	HasReceived () const override
	Query whether we have received data since last clear

bool	Empty () const override
	Query whether the Reader has data to be handled

double	GetDelaySec () const override
	Get time interval of since last receive message

uint32_t	PendingQueueSize () const override
	Get pending_queue_size configuration

bool	HasWriter () override
	Is there is at least one writer publish the channel that we subscribes?

void	GetWriters (std::vector< proto::RoleAttributes > *writers) override
	Get all writers pushlish the channel we subscribes

Public 成员函数继承自 apollo::cyber::ReaderBase
	ReaderBase (const proto::RoleAttributes &role_attr)

virtual	~ReaderBase ()

const std::string &	GetChannelName () const
	Get Reader's Channel name

uint64_t	ChannelId () const
	Get Reader's Channel id

const proto::QosProfile &	QosProfile () const
	Get qos profile.

bool	IsInit () const
	Query whether the Reader is initialized

额外继承的成员函数
Protected 属性继承自 apollo::cyber::Reader< MessageT >
double	latest_recv_time_sec_ = -1.0

double	second_to_lastest_recv_time_sec_ = -1.0

uint32_t	pending_queue_size_

Protected 属性继承自 apollo::cyber::ReaderBase
proto::RoleAttributes	role_attr_

std::atomic< bool >	init_

详细描述

template<typename MessageT>
class apollo::cyber::blocker::IntraReader< MessageT >

在文件 intra_reader.h 第 34 行定义.

成员类型定义说明

◆ Callback

template<typename MessageT >

using apollo::cyber::blocker::IntraReader< MessageT >::Callback = std::function<void(const std::shared_ptr<MessageT>&)>

在文件 intra_reader.h 第 37 行定义.

◆ Iterator

template<typename MessageT >

using apollo::cyber::blocker::IntraReader< MessageT >::Iterator = typename std::list<std::shared_ptr<MessageT> >::const_iterator

在文件 intra_reader.h 第 38 行定义.

◆ MessagePtr

template<typename MessageT >

using apollo::cyber::blocker::IntraReader< MessageT >::MessagePtr = std::shared_ptr<MessageT>

在文件 intra_reader.h 第 36 行定义.

构造及析构函数说明

◆ IntraReader()

template<typename MessageT >

apollo::cyber::blocker::IntraReader< MessageT >::IntraReader	(	const proto::RoleAttributes &	attr,
		const Callback &	callback
	)

在文件 intra_reader.h 第 67 行定义.

69 : Reader<MessageT>(attr), msg_callback_(callback) {}

◆ ~IntraReader()

template<typename MessageT >

apollo::cyber::blocker::IntraReader< MessageT >::~IntraReader ( )

virtual

在文件 intra_reader.h 第 72 行定义.

                                    {
  Shutdown();
}

成员函数说明

◆ Begin()

template<typename MessageT >

auto apollo::cyber::blocker::IntraReader< MessageT >::Begin ( ) const

overridevirtual

Get the begin iterator of ObserveQueue, used to traverse

返回: Iterator begin iterator

重载 apollo::cyber::Reader< MessageT > .

在文件 intra_reader.h 第 182 行定义.

                                                    {
  auto blocker = BlockerManager::Instance()->GetBlocker<MessageT>(
      this->role_attr_.channel_name());
  ACHECK(blocker != nullptr);
  return blocker->ObservedBegin();
}

◆ ClearData()

template<typename MessageT >

void apollo::cyber::blocker::IntraReader< MessageT >::ClearData ( )

overridevirtual

Clear local data

实现了 apollo::cyber::ReaderBase.

在文件 intra_reader.h 第 98 行定义.

                                      {
  auto blocker = BlockerManager::Instance()->GetBlocker<MessageT>(
      this->role_attr_.channel_name());
  if (blocker != nullptr) {
    blocker->ClearObserved();
    blocker->ClearPublished();
  }
}

◆ Empty()

template<typename MessageT >

bool apollo::cyber::blocker::IntraReader< MessageT >::Empty ( ) const

overridevirtual

Query whether the Reader has data to be handled

返回: true if data container is empty; false if data container has data

实现了 apollo::cyber::ReaderBase.

在文件 intra_reader.h 第 117 行定义.

                                        {
  auto blocker = BlockerManager::Instance()->GetBlocker<MessageT>(
      this->role_attr_.channel_name());
  if (blocker != nullptr) {
    return blocker->IsObservedEmpty();
  }
  return true;
}

◆ End()

template<typename MessageT >

auto apollo::cyber::blocker::IntraReader< MessageT >::End ( ) const

overridevirtual

Get the end iterator of ObserveQueue, used to traverse

返回: Iterator begin iterator

重载 apollo::cyber::Reader< MessageT > .

在文件 intra_reader.h 第 190 行定义.

                                                  {
  auto blocker = BlockerManager::Instance()->GetBlocker<MessageT>(
      this->role_attr_.channel_name());
  ACHECK(blocker != nullptr);
  return blocker->ObservedEnd();
}

◆ Enqueue()

template<typename MessageT >

void apollo::cyber::blocker::IntraReader< MessageT >::Enqueue ( const std::shared_ptr< MessageT > & msg )

overridevirtual

Push msg to Blocker's PublishQueue

参数

msg	message ptr to be pushed

重载 apollo::cyber::Reader< MessageT > .

在文件 intra_reader.h 第 137 行定义.

                                                                      {
  BlockerManager::Instance()->Publish<MessageT>(this->role_attr_.channel_name(),
                                                msg);
}

◆ GetHistoryDepth()

template<typename MessageT >

uint32_t apollo::cyber::blocker::IntraReader< MessageT >::GetHistoryDepth ( ) const

overridevirtual

Get Blocker's PublishQueue's capacity

返回: uint32_t depth of the history

重载 apollo::cyber::Reader< MessageT > .

在文件 intra_reader.h 第 152 行定义.

                                                      {
  auto blocker = BlockerManager::Instance()->GetBlocker<MessageT>(
      this->role_attr_.channel_name());
  if (blocker != nullptr) {
    return static_cast<uint32_t>(blocker->capacity());
  }
  return 0;
}

◆ GetLatestObserved()

template<typename MessageT >

std::shared_ptr< MessageT > apollo::cyber::blocker::IntraReader< MessageT >::GetLatestObserved ( ) const

overridevirtual

Get the latest message we Observe

返回: std::shared_ptr<MessageT> the latest message

重载 apollo::cyber::Reader< MessageT > .

在文件 intra_reader.h 第 162 行定义.

                                                                       {
  auto blocker = BlockerManager::Instance()->GetBlocker<MessageT>(
      this->role_attr_.channel_name());
  if (blocker != nullptr) {
    return blocker->GetLatestObservedPtr();
  }
  return nullptr;
}

◆ GetOldestObserved()

template<typename MessageT >

std::shared_ptr< MessageT > apollo::cyber::blocker::IntraReader< MessageT >::GetOldestObserved ( ) const

overridevirtual

Get the oldest message we Observe

返回: std::shared_ptr<MessageT> the oldest message

重载 apollo::cyber::Reader< MessageT > .

在文件 intra_reader.h 第 172 行定义.

                                                                       {
  auto blocker = BlockerManager::Instance()->GetBlocker<MessageT>(
      this->role_attr_.channel_name());
  if (blocker != nullptr) {
    return blocker->GetOldestObservedPtr();
  }
  return nullptr;
}

◆ HasReceived()

template<typename MessageT >

bool apollo::cyber::blocker::IntraReader< MessageT >::HasReceived ( ) const

overridevirtual

Query whether we have received data since last clear

返回: true if the reader has received data; false if the reader has not received data

实现了 apollo::cyber::ReaderBase.

在文件 intra_reader.h 第 127 行定义.

                                              {
  auto blocker = BlockerManager::Instance()->GetBlocker<MessageT>(
      this->role_attr_.channel_name());
  if (blocker != nullptr) {
    return !blocker->IsPublishedEmpty();
  }
  return false;
}

◆ Init()

template<typename MessageT >

bool apollo::cyber::blocker::IntraReader< MessageT >::Init ( )

overridevirtual

Init the Reader object

返回: true if init successfully; false if init failed

实现了 apollo::cyber::ReaderBase.

在文件 intra_reader.h 第 77 行定义.

                                 {
  if (this->init_.exchange(true)) {
    return true;
  }
  return BlockerManager::Instance()->Subscribe<MessageT>(
      this->role_attr_.channel_name(), this->role_attr_.qos_profile().depth(),
      this->role_attr_.node_name(),
      std::bind(&IntraReader<MessageT>::OnMessage, this,
                std::placeholders::_1));
}

◆ Observe()

template<typename MessageT >

void apollo::cyber::blocker::IntraReader< MessageT >::Observe ( )

overridevirtual

Get stored data

实现了 apollo::cyber::ReaderBase.

在文件 intra_reader.h 第 108 行定义.

                                    {
  auto blocker = BlockerManager::Instance()->GetBlocker<MessageT>(
      this->role_attr_.channel_name());
  if (blocker != nullptr) {
    blocker->Observe();
  }
}

◆ SetHistoryDepth()

template<typename MessageT >

void apollo::cyber::blocker::IntraReader< MessageT >::SetHistoryDepth ( const uint32_t & depth )

overridevirtual

Set Blocker's PublishQueue's capacity to depth

参数

depth the value you want to set

重载 apollo::cyber::Reader< MessageT > .

在文件 intra_reader.h 第 143 行定义.

                                                                 {
  auto blocker = BlockerManager::Instance()->GetBlocker<MessageT>(
      this->role_attr_.channel_name());
  if (blocker != nullptr) {
    blocker->set_capacity(depth);
  }
}

◆ Shutdown()

template<typename MessageT >

void apollo::cyber::blocker::IntraReader< MessageT >::Shutdown ( )

overridevirtual

Shutdown the Reader object

实现了 apollo::cyber::ReaderBase.

在文件 intra_reader.h 第 89 行定义.

                                     {
  if (!this->init_.exchange(false)) {
    return;
  }
  BlockerManager::Instance()->Unsubscribe<MessageT>(
      this->role_attr_.channel_name(), this->role_attr_.node_name());
}

该类的文档由以下文件生成:

cyber/blocker/intra_reader.h

Public 类型

Public 成员函数

额外继承的成员函数

详细描述

成员类型定义说明

◆ Callback

◆ Iterator

◆ MessagePtr

构造及析构函数说明

◆ IntraReader()

◆ ~IntraReader()

成员函数说明

◆ Begin()

◆ ClearData()

◆ Empty()

◆ End()

◆ Enqueue()

◆ GetHistoryDepth()

◆ GetLatestObserved()

◆ GetOldestObserved()

◆ HasReceived()

◆ Init()

◆ Observe()

◆ SetHistoryDepth()

◆ Shutdown()