apollo::cyber::transport::ShmReceiver< M > 模板类 参考

#include <shm_receiver.h>

类 apollo::cyber::transport::ShmReceiver< M > 继承关系图:

apollo::cyber::transport::ShmReceiver< M > 的协作图:

Public 成员函数
	ShmReceiver (const RoleAttributes &attr, const typename Receiver< M >::MessageListener &msg_listener)
virtual	~ShmReceiver ()
void	Enable () override
void	Disable () override
void	Enable (const RoleAttributes &opposite_attr) override
void	Disable (const RoleAttributes &opposite_attr) override
Public 成员函数 继承自 apollo::cyber::transport::Receiver< M >
	Receiver (const RoleAttributes &attr, const MessageListener &msg_listener)
virtual	~Receiver ()
Public 成员函数 继承自 apollo::cyber::transport::Endpoint
	Endpoint (const RoleAttributes &attr)
virtual	~Endpoint ()
const Identity &	id () const
const RoleAttributes &	attributes () const

额外继承的成员函数
Public 类型 继承自 apollo::cyber::transport::Receiver< M >
using	MessagePtr = std::shared_ptr< M >
using	MessageListener = std::function< void(const MessagePtr &, const MessageInfo &, const RoleAttributes &)>
Protected 成员函数 继承自 apollo::cyber::transport::Receiver< M >
void	OnNewMessage (const MessagePtr &msg, const MessageInfo &msg_info)
Protected 属性 继承自 apollo::cyber::transport::Receiver< M >
MessageListener	msg_listener_
Protected 属性 继承自 apollo::cyber::transport::Endpoint
bool	enabled_
Identity	id_
RoleAttributes	attr_

详细描述

template<typename M>
class apollo::cyber::transport::ShmReceiver< M >

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

构造及析构函数说明

ShmReceiver()

template<typename M >

apollo::cyber::transport::ShmReceiver< M >::ShmReceiver	(	const RoleAttributes &	attr,
		const typename Receiver< M >::MessageListener &	msg_listener
	)

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

    : Receiver<M>(attr, msg_listener) {
  dispatcher_ = ShmDispatcher::Instance();
}

~ShmReceiver()

template<typename M >

apollo::cyber::transport::ShmReceiver< M >::~ShmReceiver ( )

virtual

在文件 shm_receiver.h 第 57 行定义.

                             {
  Disable();
}

成员函数说明

Disable() [1/2]

template<typename M >

void apollo::cyber::transport::ShmReceiver< M >::Disable ( )

overridevirtual

实现了 apollo::cyber::transport::Receiver< M >.

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

                             {
  if (!this->enabled_) {
    return;
  }
 
  dispatcher_->RemoveListener<M>(this->attr_);
  this->enabled_ = false;
}

Disable() [2/2]

template<typename M >

void apollo::cyber::transport::ShmReceiver< M >::Disable ( const RoleAttributes &  opposite_attr )

overridevirtual

实现了 apollo::cyber::transport::Receiver< M >.

在文件 shm_receiver.h 第 113 行定义.

                                                                {
  dispatcher_->RemoveListener<M>(this->attr_, opposite_attr);
}

Enable() [1/2]

template<typename M >

void apollo::cyber::transport::ShmReceiver< M >::Enable ( )

overridevirtual

实现了 apollo::cyber::transport::Receiver< M >.

在文件 shm_receiver.h 第 62 行定义.

                            {
  if (this->enabled_) {
    return;
  }
 
  if (cyber::common::GlobalData::Instance()->IsChannelEnableArenaShm(
          this->attr_.channel_id()) && message::MessageType<M>() != \
            message::MessageType<message::RawMessage>()) {
    auto arena_manager = ProtobufArenaManager::Instance();
    if (!arena_manager->Enable() ||
        !arena_manager->EnableSegment(this->attr_.channel_id())) {
      AERROR << "arena manager enable failed.";
      return;
    }
  }
 
  dispatcher_->AddListener<M>(
      this->attr_, std::bind(&ShmReceiver<M>::OnNewMessage, this,
                             std::placeholders::_1, std::placeholders::_2));
  this->enabled_ = true;
}

Enable() [2/2]

template<typename M >

void apollo::cyber::transport::ShmReceiver< M >::Enable ( const RoleAttributes &  opposite_attr )

overridevirtual

实现了 apollo::cyber::transport::Receiver< M >.

在文件 shm_receiver.h 第 95 行定义.

                                                               {
  if (cyber::common::GlobalData::Instance()->IsChannelEnableArenaShm(
          this->attr_.channel_id()) && message::MessageType<M>() != \
            message::MessageType<message::RawMessage>()) {
    auto arena_manager = ProtobufArenaManager::Instance();
    if (!arena_manager->Enable() ||
        !arena_manager->EnableSegment(this->attr_.channel_id())) {
      AERROR << "arena manager enable failed.";
      return;
    }
  }
  dispatcher_->AddListener<M>(
      this->attr_, opposite_attr,
      std::bind(&ShmReceiver<M>::OnNewMessage, this, std::placeholders::_1,
                std::placeholders::_2));
}

---

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

• cyber/transport/receiver/shm_receiver.h