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

#include <intra_transmitter.h>

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

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

Public 类型
using	MessagePtr = std::shared_ptr< M >
Public 类型 继承自 apollo::cyber::transport::Transmitter< M >
using	MessagePtr = std::shared_ptr< M >

Public 成员函数
	IntraTransmitter (const RoleAttributes &attr)
virtual	~IntraTransmitter ()
void	Enable () override
void	Disable () override
void	Enable (const RoleAttributes &opposite_attr) override
void	Disable (const RoleAttributes &opposite_attr) override
bool	Transmit (const MessagePtr &msg, const MessageInfo &msg_info) override
bool	AcquireMessage (std::shared_ptr< M > &msg)
Public 成员函数 继承自 apollo::cyber::transport::Transmitter< M >
	Transmitter (const RoleAttributes &attr)
virtual	~Transmitter ()
virtual bool	Transmit (const MessagePtr &msg)
uint64_t	NextSeqNum ()
uint64_t	seq_num () const
Public 成员函数 继承自 apollo::cyber::transport::Endpoint
	Endpoint (const RoleAttributes &attr)
virtual	~Endpoint ()
const Identity &	id () const
const RoleAttributes &	attributes () const

额外继承的成员函数
Protected 属性 继承自 apollo::cyber::transport::Transmitter< M >
MessageInfo	msg_info_
std::shared_ptr<::bvar::Adder< int > >	seq_num_
Protected 属性 继承自 apollo::cyber::transport::Endpoint
bool	enabled_
Identity	id_
RoleAttributes	attr_

详细描述

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

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

成员类型定义说明

MessagePtr

template<typename M >

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

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

构造及析构函数说明

IntraTransmitter()

template<typename M >

apollo::cyber::transport::IntraTransmitter< M >::IntraTransmitter ( const RoleAttributes &  attr )

explicit

在文件 intra_transmitter.h 第 60 行定义.

    : Transmitter<M>(attr),
      channel_id_(attr.channel_id()),
      dispatcher_(nullptr) {}

~IntraTransmitter()

template<typename M >

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

virtual

在文件 intra_transmitter.h 第 66 行定义.

                                       {
  Disable();
}

成员函数说明

AcquireMessage()

template<typename M >

bool apollo::cyber::transport::IntraTransmitter< M >::AcquireMessage ( std::shared_ptr< M > &  msg )

virtual

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

在文件 intra_transmitter.h 第 55 行定义.

                                                              {
  return false;
}

Disable() [1/2]

template<typename M >

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

overridevirtual

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

在文件 intra_transmitter.h 第 91 行定义.

                                  {
  if (this->enabled_) {
    dispatcher_ = nullptr;
    this->enabled_ = false;
  }
}

Disable() [2/2]

template<typename M >

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

overridevirtual

重载 apollo::cyber::transport::Transmitter< M > .

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

                                                                     {
  (void)opposite_attr;
  this->Disable();
}

Enable() [1/2]

template<typename M >

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

overridevirtual

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

在文件 intra_transmitter.h 第 83 行定义.

                                 {
  if (!this->enabled_) {
    dispatcher_ = IntraDispatcher::Instance();
    this->enabled_ = true;
  }
}

Enable() [2/2]

template<typename M >

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

overridevirtual

重载 apollo::cyber::transport::Transmitter< M > .

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

                                                                    {
  (void)opposite_attr;
  this->Enable();
}

Transmit()

template<typename M >

bool apollo::cyber::transport::IntraTransmitter< M >::Transmit ( const MessagePtr &  msg, const MessageInfo &  msg_info  )

overridevirtual

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

在文件 intra_transmitter.h 第 99 行定义.

                                                                {
  if (!this->enabled_) {
    ADEBUG << "not enable.";
    return false;
  }
 
  dispatcher_->OnMessage(channel_id_, msg, msg_info);
  return true;
}

---

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

• cyber/transport/transmitter/intra_transmitter.h