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

#include <receiver.h>

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

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

Public 类型
using	MessagePtr = std::shared_ptr< M >
using	MessageListener = std::function< void(const MessagePtr &, const MessageInfo &, const RoleAttributes &)>

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

Protected 成员函数
void	OnNewMessage (const MessagePtr &msg, const MessageInfo &msg_info)

Protected 属性
MessageListener	msg_listener_
Protected 属性 继承自 apollo::cyber::transport::Endpoint
bool	enabled_
Identity	id_
RoleAttributes	attr_

详细描述

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

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

成员类型定义说明

MessageListener

template<typename M >

using apollo::cyber::transport::Receiver< M >::MessageListener = std::function<void( const MessagePtr&, const MessageInfo&, const RoleAttributes&)>

在文件 receiver.h 第 35 行定义.

MessagePtr

template<typename M >

using apollo::cyber::transport::Receiver< M >::MessagePtr = std::shared_ptr<M>

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

构造及析构函数说明

Receiver()

template<typename M >

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

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

    : Endpoint(attr), msg_listener_(msg_listener) {}

~Receiver()

template<typename M >

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

virtual

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

{}

成员函数说明

Disable() [1/2]

template<typename M >

virtual void apollo::cyber::transport::Receiver< M >::Disable ( )

pure virtual

在 apollo::cyber::transport::HybridReceiver< M >, apollo::cyber::transport::IntraReceiver< M >, apollo::cyber::transport::RtpsReceiver< M > , 以及 apollo::cyber::transport::ShmReceiver< M > 内被实现.

Disable() [2/2]

template<typename M >

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

pure virtual

在 apollo::cyber::transport::HybridReceiver< M >, apollo::cyber::transport::IntraReceiver< M >, apollo::cyber::transport::RtpsReceiver< M > , 以及 apollo::cyber::transport::ShmReceiver< M > 内被实现.

Enable() [1/2]

template<typename M >

virtual void apollo::cyber::transport::Receiver< M >::Enable ( )

pure virtual

在 apollo::cyber::transport::HybridReceiver< M >, apollo::cyber::transport::IntraReceiver< M >, apollo::cyber::transport::RtpsReceiver< M > , 以及 apollo::cyber::transport::ShmReceiver< M > 内被实现.

Enable() [2/2]

template<typename M >

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

pure virtual

在 apollo::cyber::transport::HybridReceiver< M >, apollo::cyber::transport::IntraReceiver< M >, apollo::cyber::transport::RtpsReceiver< M > , 以及 apollo::cyber::transport::ShmReceiver< M > 内被实现.

OnNewMessage()

template<typename M >

void apollo::cyber::transport::Receiver< M >::OnNewMessage ( const MessagePtr &  msg, const MessageInfo &  msg_info  )

protected

在文件 receiver.h 第 61 行定义.

                                                            {
  if (msg_listener_ != nullptr) {
    msg_listener_(msg, msg_info, attr_);
  }
}

类成员变量说明

msg_listener_

template<typename M >

MessageListener apollo::cyber::transport::Receiver< M >::msg_listener_

protected

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

---

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

• cyber/transport/receiver/receiver.h