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

#include <transmitter.h>

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

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

Public 类型
using	MessagePtr = std::shared_ptr< M >

Public 成员函数
	Transmitter (const RoleAttributes &attr)
virtual	~Transmitter ()
virtual void	Enable ()=0
virtual void	Disable ()=0
virtual bool	AcquireMessage (std::shared_ptr< M > &msg)=0
virtual void	Enable (const RoleAttributes &opposite_attr)
virtual void	Disable (const RoleAttributes &opposite_attr)
virtual bool	Transmit (const MessagePtr &msg)
virtual bool	Transmit (const MessagePtr &msg, const MessageInfo &msg_info)=0
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 属性
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::Transmitter< M >

在文件 transmitter.h 第 37 行定义.

成员类型定义说明

MessagePtr

template<typename M >

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

在文件 transmitter.h 第 39 行定义.

构造及析构函数说明

Transmitter()

template<typename M >

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

explicit

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

                                                      : Endpoint(attr) {
  msg_info_.set_sender_id(this->id_);
  msg_info_.set_seq_num(0);
  seq_num_ =
      statistics::Statistics::Instance()->CreateAdder<int>(Endpoint::attr_);
}

~Transmitter()

template<typename M >

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

virtual

在文件 transmitter.h 第 76 行定义.

{}

成员函数说明

AcquireMessage()

template<typename M >

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

pure virtual

在 apollo::cyber::transport::HybridTransmitter< M >, apollo::cyber::transport::IntraTransmitter< M >, apollo::cyber::transport::RtpsTransmitter< M > , 以及 apollo::cyber::transport::ShmTransmitter< M > 内被实现.

Disable() [1/2]

template<typename M >

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

pure virtual

在 apollo::cyber::transport::HybridTransmitter< M >, apollo::cyber::transport::IntraTransmitter< M >, apollo::cyber::transport::RtpsTransmitter< M > , 以及 apollo::cyber::transport::ShmTransmitter< M > 内被实现.

Disable() [2/2]

template<typename M >

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

virtual

被 apollo::cyber::transport::ShmTransmitter< M >, apollo::cyber::transport::HybridTransmitter< M >, apollo::cyber::transport::IntraTransmitter< M > , 以及 apollo::cyber::transport::RtpsTransmitter< M > 重载.

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

                                                                {
  (void)opposite_attr;
  Disable();
}

Enable() [1/2]

template<typename M >

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

pure virtual

在 apollo::cyber::transport::HybridTransmitter< M >, apollo::cyber::transport::IntraTransmitter< M >, apollo::cyber::transport::RtpsTransmitter< M > , 以及 apollo::cyber::transport::ShmTransmitter< M > 内被实现.

Enable() [2/2]

template<typename M >

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

virtual

被 apollo::cyber::transport::ShmTransmitter< M >, apollo::cyber::transport::HybridTransmitter< M >, apollo::cyber::transport::IntraTransmitter< M > , 以及 apollo::cyber::transport::RtpsTransmitter< M > 重载.

在文件 transmitter.h 第 88 行定义.

                                                               {
  (void)opposite_attr;
  Enable();
}

NextSeqNum()

template<typename M >

uint64_t apollo::cyber::transport::Transmitter< M >::NextSeqNum ( )

inline

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

                        {
    (*seq_num_) << 1;
    return seq_num_->get_value();
  }

seq_num()

template<typename M >

uint64_t apollo::cyber::transport::Transmitter< M >::seq_num ( ) const

inline

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

{ return seq_num_->get_value(); }

Transmit() [1/2]

template<typename M >

bool apollo::cyber::transport::Transmitter< M >::Transmit ( const MessagePtr &  msg )

virtual

在文件 transmitter.h 第 79 行定义.

                                                   {
  msg_info_.set_seq_num(NextSeqNum());
  msg_info_.set_send_time(Time::Now().ToNanosecond());
  PerfEventCache::Instance()->AddTransportEvent(
      TransPerf::TRANSMIT_BEGIN, attr_.channel_id(), msg_info_.seq_num());
  return Transmit(msg, msg_info_);
}

Transmit() [2/2]

template<typename M >

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

pure virtual

在 apollo::cyber::transport::HybridTransmitter< M >, apollo::cyber::transport::IntraTransmitter< M >, apollo::cyber::transport::RtpsTransmitter< M > , 以及 apollo::cyber::transport::ShmTransmitter< M > 内被实现.

类成员变量说明

msg_info_

template<typename M >

MessageInfo apollo::cyber::transport::Transmitter< M >::msg_info_

protected

在文件 transmitter.h 第 63 行定义.

seq_num_

template<typename M >

std::shared_ptr<::bvar::Adder<int> > apollo::cyber::transport::Transmitter< M >::seq_num_

protected

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

---

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

• cyber/transport/transmitter/transmitter.h