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

#include <hybrid_transmitter.h>

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

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

Public 类型
using	MessagePtr = std::shared_ptr< M >
using	HistoryPtr = std::shared_ptr< History< M > >
using	TransmitterPtr = std::shared_ptr< Transmitter< M > >
using	TransmitterMap = std::unordered_map< OptionalMode, TransmitterPtr, std::hash< int > >
using	ReceiverMap = std::unordered_map< OptionalMode, std::set< uint64_t >, std::hash< int > >
using	CommunicationModePtr = std::shared_ptr< proto::CommunicationMode >
using	MappingTable = std::unordered_map< Relation, OptionalMode, std::hash< int > >
Public 类型 继承自 apollo::cyber::transport::Transmitter< M >
using	MessagePtr = std::shared_ptr< M >

Public 成员函数
	HybridTransmitter (const RoleAttributes &attr, const ParticipantPtr &participant)
virtual	~HybridTransmitter ()
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::HybridTransmitter< M >

在文件 hybrid_transmitter.h 第 51 行定义.

成员类型定义说明

CommunicationModePtr

template<typename M >

using apollo::cyber::transport::HybridTransmitter< M >::CommunicationModePtr = std::shared_ptr<proto::CommunicationMode>

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

HistoryPtr

template<typename M >

using apollo::cyber::transport::HybridTransmitter< M >::HistoryPtr = std::shared_ptr<History<M> >

在文件 hybrid_transmitter.h 第 54 行定义.

MappingTable

template<typename M >

using apollo::cyber::transport::HybridTransmitter< M >::MappingTable = std::unordered_map<Relation, OptionalMode, std::hash<int> >

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

MessagePtr

template<typename M >

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

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

ReceiverMap

template<typename M >

using apollo::cyber::transport::HybridTransmitter< M >::ReceiverMap = std::unordered_map<OptionalMode, std::set<uint64_t>, std::hash<int> >

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

TransmitterMap

template<typename M >

using apollo::cyber::transport::HybridTransmitter< M >::TransmitterMap = std::unordered_map<OptionalMode, TransmitterPtr, std::hash<int> >

在文件 hybrid_transmitter.h 第 56 行定义.

TransmitterPtr

template<typename M >

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

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

构造及析构函数说明

HybridTransmitter()

template<typename M >

apollo::cyber::transport::HybridTransmitter< M >::HybridTransmitter	(	const RoleAttributes &	attr,
		const ParticipantPtr &	participant
	)

在文件 hybrid_transmitter.h 第 102 行定义.

    : Transmitter<M>(attr),
      history_(nullptr),
      mode_(nullptr),
      participant_(participant) {
  InitMode();
  ObtainConfig();
  InitHistory();
  InitTransmitters();
  InitReceivers();
}

~HybridTransmitter()

template<typename M >

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

virtual

在文件 hybrid_transmitter.h 第 116 行定义.

                                         {
  ClearReceivers();
  ClearTransmitters();
}

成员函数说明

AcquireMessage()

template<typename M >

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

virtual

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

在文件 hybrid_transmitter.h 第 177 行定义.

                                                               {
  bool result = false;
  for (auto& item : transmitters_) {
    result = item.second->AcquireMessage(msg);
    if (result) {
      return true;
    }
  }
  return false;
}

Disable() [1/2]

template<typename M >

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

overridevirtual

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

在文件 hybrid_transmitter.h 第 130 行定义.

                                   {
  std::lock_guard<std::mutex> lock(mutex_);
  for (auto& item : transmitters_) {
    item.second->Disable();
  }
}

Disable() [2/2]

template<typename M >

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

overridevirtual

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

在文件 hybrid_transmitter.h 第 152 行定义.

                                                                      {
  auto relation = GetRelation(opposite_attr);
  if (relation == NO_RELATION) {
    return;
  }
 
  uint64_t id = opposite_attr.id();
  std::lock_guard<std::mutex> lock(mutex_);
  receivers_[mapping_table_[relation]].erase(id);
  transmitters_[mapping_table_[relation]]->Disable(opposite_attr);
}

Enable() [1/2]

template<typename M >

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

overridevirtual

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

在文件 hybrid_transmitter.h 第 122 行定义.

                                  {
  std::lock_guard<std::mutex> lock(mutex_);
  for (auto& item : transmitters_) {
    item.second->Enable();
  }
}

Enable() [2/2]

template<typename M >

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

overridevirtual

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

在文件 hybrid_transmitter.h 第 138 行定义.

                                                                     {
  auto relation = GetRelation(opposite_attr);
  if (relation == NO_RELATION) {
    return;
  }
 
  uint64_t id = opposite_attr.id();
  std::lock_guard<std::mutex> lock(mutex_);
  receivers_[mapping_table_[relation]].insert(id);
  transmitters_[mapping_table_[relation]]->Enable(opposite_attr);
  TransmitHistoryMsg(opposite_attr);
}

Transmit()

template<typename M >

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

overridevirtual

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

在文件 hybrid_transmitter.h 第 165 行定义.

                                                                 {
  std::lock_guard<std::mutex> lock(mutex_);
  history_->Add(msg, msg_info);
  bool return_val = false;
  for (auto& item : transmitters_) {
    item.second->Transmit(msg, msg_info);
  }
  return true;
}

---

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

• cyber/transport/transmitter/hybrid_transmitter.h