apollo::cyber::blocker::IntraWriter< MessageT > 模板类 参考

#include <intra_writer.h>

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

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

Public 类型
using	MessagePtr = std::shared_ptr< MessageT >
using	BlockerManagerPtr = std::shared_ptr< BlockerManager >
Public 类型 继承自 apollo::cyber::Writer< MessageT >
using	TransmitterPtr = std::shared_ptr< transport::Transmitter< MessageT > >
using	ChangeConnection = typename service_discovery::Manager::ChangeConnection

Public 成员函数
	IntraWriter (const proto::RoleAttributes &attr)
virtual	~IntraWriter ()
bool	Init () override
	Init the Writer
void	Shutdown () override
	Shutdown the Writer
bool	Write (const MessageT &msg) override
	Write a MessageT instance
bool	Write (const MessagePtr &msg_ptr) override
	Write a shared ptr of MessageT
Public 成员函数 继承自 apollo::cyber::Writer< MessageT >
	Writer (const proto::RoleAttributes &role_attr)
	Construct a new Writer object
virtual	~Writer ()
bool	Init () override
	Init the Writer
void	Shutdown () override
	Shutdown the Writer
bool	HasReader () override
	Is there any Reader that subscribes our Channel? You can publish message when this return true
void	GetReaders (std::vector< proto::RoleAttributes > *readers) override
	Get all Readers that subscriber our writing channel
std::shared_ptr< MessageT >	AcquireMessage ()
	Acquire message instance to send
Public 成员函数 继承自 apollo::cyber::WriterBase
	WriterBase (const proto::RoleAttributes &role_attr)
	Construct a new Writer Base object
virtual	~WriterBase ()
const std::string &	GetChannelName () const
	Get Writer's Channel name
const uint64_t	GetChannelId () const
	Get Writer's Channel id
bool	IsInit () const
	Is Writer initialized?

额外继承的成员函数
Protected 属性 继承自 apollo::cyber::WriterBase
proto::RoleAttributes	role_attr_
std::mutex	lock_
bool	init_

详细描述

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

在文件 intra_writer.h 第 30 行定义.

成员类型定义说明

BlockerManagerPtr

template<typename MessageT >

using apollo::cyber::blocker::IntraWriter< MessageT >::BlockerManagerPtr = std::shared_ptr<BlockerManager>

在文件 intra_writer.h 第 33 行定义.

MessagePtr

template<typename MessageT >

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

在文件 intra_writer.h 第 32 行定义.

构造及析构函数说明

IntraWriter()

template<typename MessageT >

apollo::cyber::blocker::IntraWriter< MessageT >::IntraWriter ( const proto::RoleAttributes &  attr )

explicit

在文件 intra_writer.h 第 49 行定义.

    : Writer<MessageT>(attr) {}

~IntraWriter()

template<typename MessageT >

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

virtual

在文件 intra_writer.h 第 53 行定义.

                                    {
  Shutdown();
}

成员函数说明

Init()

template<typename MessageT >

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

overridevirtual

Init the Writer

返回

true if init success

false if init failed

实现了 apollo::cyber::WriterBase.

在文件 intra_writer.h 第 58 行定义.

                                 {
  {
    std::lock_guard<std::mutex> g(this->lock_);
    if (this->init_) {
      return true;
    }
    blocker_manager_ = BlockerManager::Instance();
    blocker_manager_->GetOrCreateBlocker<MessageT>(
        BlockerAttr(this->role_attr_.channel_name()));
    this->init_ = true;
  }
  return true;
}

Shutdown()

template<typename MessageT >

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

overridevirtual

Shutdown the Writer

实现了 apollo::cyber::WriterBase.

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

                                     {
  {
    std::lock_guard<std::mutex> g(this->lock_);
    if (!this->init_) {
      return;
    }
    this->init_ = false;
  }
  blocker_manager_ = nullptr;
}

Write() [1/2]

template<typename MessageT >

bool apollo::cyber::blocker::IntraWriter< MessageT >::Write ( const MessagePtr &  msg_ptr )

overridevirtual

Write a shared ptr of MessageT

参数

msg_ptr

the message shared ptr we want to write

返回

true if write successfully

false if write failed

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

在文件 intra_writer.h 第 94 行定义.

                                                           {
  if (!WriterBase::IsInit()) {
    return false;
  }
  return blocker_manager_->Publish<MessageT>(this->role_attr_.channel_name(),
                                             msg_ptr);
}

Write() [2/2]

template<typename MessageT >

bool apollo::cyber::blocker::IntraWriter< MessageT >::Write ( const MessageT &  msg )

overridevirtual

Write a MessageT instance

参数

msg	the message we want to write

返回

true if write successfully

false if write failed

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

在文件 intra_writer.h 第 85 行定义.

                                                     {
  if (!WriterBase::IsInit()) {
    return false;
  }
  return blocker_manager_->Publish<MessageT>(this->role_attr_.channel_name(),
                                             msg);
}

---

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

• cyber/blocker/intra_writer.h