apollo::cyber::blocker::Blocker< T > 模板类 参考

#include <blocker.h>

类 apollo::cyber::blocker::Blocker< T > 继承关系图:

apollo::cyber::blocker::Blocker< T > 的协作图:

Public 类型
using	MessageType = T
using	MessagePtr = std::shared_ptr< T >
using	MessageQueue = std::list< MessagePtr >
using	Callback = std::function< void(const MessagePtr &)>
using	CallbackMap = std::unordered_map< std::string, Callback >
using	Iterator = typename std::list< std::shared_ptr< T > >::const_iterator

Public 成员函数
	Blocker (const BlockerAttr &attr)
virtual	~Blocker ()
void	Publish (const MessageType &msg)
void	Publish (const MessagePtr &msg)
void	ClearObserved () override
void	ClearPublished () override
void	Observe () override
bool	IsObservedEmpty () const override
bool	IsPublishedEmpty () const override
bool	Subscribe (const std::string &callback_id, const Callback &callback)
bool	Unsubscribe (const std::string &callback_id) override
const MessageType &	GetLatestObserved () const
const MessagePtr	GetLatestObservedPtr () const
const MessagePtr	GetOldestObservedPtr () const
const MessagePtr	GetLatestPublishedPtr () const
Iterator	ObservedBegin () const
Iterator	ObservedEnd () const
size_t	capacity () const override
void	set_capacity (size_t capacity) override
const std::string &	channel_name () const override
Public 成员函数 继承自 apollo::cyber::blocker::BlockerBase
virtual	~BlockerBase ()=default

友元
class	BlockerManager

详细描述

template<typename T>
class apollo::cyber::blocker::Blocker< T >

在文件 blocker.h 第 64 行定义.

成员类型定义说明

Callback

template<typename T >

using apollo::cyber::blocker::Blocker< T >::Callback = std::function<void(const MessagePtr&)>

在文件 blocker.h 第 71 行定义.

CallbackMap

template<typename T >

using apollo::cyber::blocker::Blocker< T >::CallbackMap = std::unordered_map<std::string, Callback>

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

Iterator

template<typename T >

using apollo::cyber::blocker::Blocker< T >::Iterator = typename std::list<std::shared_ptr<T> >::const_iterator

在文件 blocker.h 第 73 行定义.

MessagePtr

template<typename T >

using apollo::cyber::blocker::Blocker< T >::MessagePtr = std::shared_ptr<T>

在文件 blocker.h 第 69 行定义.

MessageQueue

template<typename T >

using apollo::cyber::blocker::Blocker< T >::MessageQueue = std::list<MessagePtr>

在文件 blocker.h 第 70 行定义.

MessageType

template<typename T >

using apollo::cyber::blocker::Blocker< T >::MessageType = T

在文件 blocker.h 第 68 行定义.

构造及析构函数说明

Blocker()

template<typename T >

apollo::cyber::blocker::Blocker< T >::Blocker ( const BlockerAttr &  attr )

explicit

在文件 blocker.h 第 119 行定义.

: attr_(attr), dummy_msg_() {}

~Blocker()

template<typename T >

apollo::cyber::blocker::Blocker< T >::~Blocker ( )

virtual

在文件 blocker.h 第 122 行定义.

                     {
  published_msg_queue_.clear();
  observed_msg_queue_.clear();
  published_callbacks_.clear();
}

成员函数说明

capacity()

template<typename T >

size_t apollo::cyber::blocker::Blocker< T >::capacity ( ) const

overridevirtual

实现了 apollo::cyber::blocker::BlockerBase.

在文件 blocker.h 第 246 行定义.

                                  {
  return attr_.capacity;
}

channel_name()

template<typename T >

const std::string & apollo::cyber::blocker::Blocker< T >::channel_name ( ) const

overridevirtual

实现了 apollo::cyber::blocker::BlockerBase.

在文件 blocker.h 第 260 行定义.

                                                {
  return attr_.channel_name;
}

ClearObserved()

template<typename T >

void apollo::cyber::blocker::Blocker< T >::ClearObserved ( )

overridevirtual

实现了 apollo::cyber::blocker::BlockerBase.

在文件 blocker.h 第 153 行定义.

                               {
  std::lock_guard<std::mutex> lock(msg_mutex_);
  observed_msg_queue_.clear();
}

ClearPublished()

template<typename T >

void apollo::cyber::blocker::Blocker< T >::ClearPublished ( )

overridevirtual

实现了 apollo::cyber::blocker::BlockerBase.

在文件 blocker.h 第 159 行定义.

                                {
  std::lock_guard<std::mutex> lock(msg_mutex_);
  published_msg_queue_.clear();
}

GetLatestObserved()

template<typename T >

auto apollo::cyber::blocker::Blocker< T >::GetLatestObserved

(

)

const

在文件 blocker.h 第 200 行定义.

                                                               {
  std::lock_guard<std::mutex> lock(msg_mutex_);
  if (observed_msg_queue_.empty()) {
    return dummy_msg_;
  }
  return *observed_msg_queue_.front();
}

GetLatestObservedPtr()

template<typename T >

auto apollo::cyber::blocker::Blocker< T >::GetLatestObservedPtr

(

)

const

在文件 blocker.h 第 209 行定义.

                                                                {
  std::lock_guard<std::mutex> lock(msg_mutex_);
  if (observed_msg_queue_.empty()) {
    return nullptr;
  }
  return observed_msg_queue_.front();
}

GetLatestPublishedPtr()

template<typename T >

auto apollo::cyber::blocker::Blocker< T >::GetLatestPublishedPtr

(

)

const

在文件 blocker.h 第 227 行定义.

                                                                 {
  std::lock_guard<std::mutex> lock(msg_mutex_);
  if (published_msg_queue_.empty()) {
    return nullptr;
  }
  return published_msg_queue_.front();
}

GetOldestObservedPtr()

template<typename T >

auto apollo::cyber::blocker::Blocker< T >::GetOldestObservedPtr

(

)

const

在文件 blocker.h 第 218 行定义.

                                                                {
  std::lock_guard<std::mutex> lock(msg_mutex_);
  if (observed_msg_queue_.empty()) {
    return nullptr;
  }
  return observed_msg_queue_.back();
}

IsObservedEmpty()

template<typename T >

bool apollo::cyber::blocker::Blocker< T >::IsObservedEmpty ( ) const

overridevirtual

实现了 apollo::cyber::blocker::BlockerBase.

在文件 blocker.h 第 171 行定义.

                                       {
  std::lock_guard<std::mutex> lock(msg_mutex_);
  return observed_msg_queue_.empty();
}

IsPublishedEmpty()

template<typename T >

bool apollo::cyber::blocker::Blocker< T >::IsPublishedEmpty ( ) const

overridevirtual

实现了 apollo::cyber::blocker::BlockerBase.

在文件 blocker.h 第 177 行定义.

                                        {
  std::lock_guard<std::mutex> lock(msg_mutex_);
  return published_msg_queue_.empty();
}

Observe()

template<typename T >

void apollo::cyber::blocker::Blocker< T >::Observe ( )

overridevirtual

实现了 apollo::cyber::blocker::BlockerBase.

在文件 blocker.h 第 165 行定义.

                         {
  std::lock_guard<std::mutex> lock(msg_mutex_);
  observed_msg_queue_ = published_msg_queue_;
}

ObservedBegin()

template<typename T >

auto apollo::cyber::blocker::Blocker< T >::ObservedBegin

(

)

const

在文件 blocker.h 第 236 行定义.

                                                 {
  return observed_msg_queue_.begin();
}

ObservedEnd()

template<typename T >

auto apollo::cyber::blocker::Blocker< T >::ObservedEnd

(

)

const

在文件 blocker.h 第 241 行定义.

                                               {
  return observed_msg_queue_.end();
}

Publish() [1/2]

template<typename T >

void apollo::cyber::blocker::Blocker< T >::Publish

(

const MessagePtr &

msg

)

在文件 blocker.h 第 134 行定义.

                                              {
  Enqueue(msg);
  Notify(msg);
}

Publish() [2/2]

template<typename T >

void apollo::cyber::blocker::Blocker< T >::Publish

(

const MessageType &

msg

)

在文件 blocker.h 第 129 行定义.

                                               {
  Publish(std::make_shared<MessageType>(msg));
}

set_capacity()

template<typename T >

void apollo::cyber::blocker::Blocker< T >::set_capacity ( size_t  capacity )

overridevirtual

实现了 apollo::cyber::blocker::BlockerBase.

在文件 blocker.h 第 251 行定义.

                                             {
  std::lock_guard<std::mutex> lock(msg_mutex_);
  attr_.capacity = capacity;
  while (published_msg_queue_.size() > capacity) {
    published_msg_queue_.pop_back();
  }
}

Subscribe()

template<typename T >

bool apollo::cyber::blocker::Blocker< T >::Subscribe	(	const std::string &	callback_id,
		const Callback &	callback
	)

在文件 blocker.h 第 183 行定义.

                                                     {
  std::lock_guard<std::mutex> lock(cb_mutex_);
  if (published_callbacks_.find(callback_id) != published_callbacks_.end()) {
    return false;
  }
  published_callbacks_[callback_id] = callback;
  return true;
}

Unsubscribe()

template<typename T >

bool apollo::cyber::blocker::Blocker< T >::Unsubscribe ( const std::string &  callback_id )

overridevirtual

实现了 apollo::cyber::blocker::BlockerBase.

在文件 blocker.h 第 194 行定义.

                                                         {
  std::lock_guard<std::mutex> lock(cb_mutex_);
  return published_callbacks_.erase(callback_id) != 0;
}

友元及相关函数文档

BlockerManager

template<typename T >

friend class BlockerManager

friend

在文件 blocker.h 第 65 行定义.

---

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

• cyber/blocker/blocker.h