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

#include <shm_transmitter.h>

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

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

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

Public 成员函数
	ShmTransmitter (const RoleAttributes &attr)
virtual	~ShmTransmitter ()
void	Enable () override
void	Disable () override
void	Enable (const RoleAttributes &opposite_attr)
void	Disable (const RoleAttributes &opposite_attr)
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::ShmTransmitter< M >

在文件 shm_transmitter.h 第 46 行定义.

成员类型定义说明

MessagePtr

template<typename M >

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

在文件 shm_transmitter.h 第 48 行定义.

构造及析构函数说明

ShmTransmitter()

template<typename M >

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

explicit

在文件 shm_transmitter.h 第 96 行定义.

    : Transmitter<M>(attr),
      segment_(nullptr),
      channel_id_(attr.channel_id()),
      notifier_(nullptr),
      serialized_receiver_count_(0),
      arena_receiver_count_(0) {
  host_id_ = common::Hash(attr.host_ip());
  arena_transmit_ = common::GlobalData::Instance()->IsChannelEnableArenaShm(
                        this->attr_.channel_id()) &&
                    !type_check<M, message::RawMessage>::value &&
                    !type_check<M, message::PyMessageWrap>::value;
}

~ShmTransmitter()

template<typename M >

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

virtual

在文件 shm_transmitter.h 第 111 行定义.

                                   {
  Disable();
}

成员函数说明

AcquireMessage()

template<typename M >

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

virtual

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

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

                                                            {
  if (this->enabled_) {
    auto msg_o = msg.get();
    auto arena_manager = ProtobufArenaManager::Instance();
    if (!arena_manager->Enable() ||
        !arena_manager->EnableSegment(this->attr_.channel_id())) {
      ADEBUG << "arena manager enable failed.";
      return false;
    }
    arena_manager->AcquireArenaMessage(channel_id_, msg);
    if (msg.get() != msg_o) {
      return true;
    } else {
      return false;
    }
  }
  return false;
}

Disable() [1/2]

template<typename M >

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

overridevirtual

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

在文件 shm_transmitter.h 第 186 行定义.

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

Disable() [2/2]

template<typename M >

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

virtual

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

在文件 shm_transmitter.h 第 135 行定义.

                                                                   {
  if (this->enabled_) {
    if (arena_transmit_) {
      if (opposite_attr.message_type() ==
              message::MessageType<message::RawMessage>() ||
          opposite_attr.message_type() ==
              message::MessageType<message::PyMessageWrap>()) {
        serialized_receiver_count_.fetch_sub(1);
      } else {
        arena_receiver_count_.fetch_sub(1);
      }
      if (serialized_receiver_count_.load() <= 0 &&
          arena_receiver_count_.load() <= 0) {
        this->Disable();
      }
    } else {
      serialized_receiver_count_.fetch_sub(1);
      if (serialized_receiver_count_.load() <= 0) {
        this->Disable();
      }
    }
  }
}

Enable() [1/2]

template<typename M >

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

overridevirtual

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

在文件 shm_transmitter.h 第 160 行定义.

                               {
  if (this->enabled_) {
    return;
  }
 
  if (serialized_receiver_count_.load() == 0 &&
      arena_receiver_count_.load() == 0) {
    AERROR << "please enable shm transmitter by passing role attr.";
    return;
  }
 
  if (arena_transmit_) {
    auto arena_manager = ProtobufArenaManager::Instance();
    if (!arena_manager->Enable() ||
        !arena_manager->EnableSegment(this->attr_.channel_id())) {
      AERROR << "arena manager enable failed.";
      return;
    }
  }
 
  segment_ = SegmentFactory::CreateSegment(channel_id_);
  notifier_ = NotifierFactory::CreateNotifier();
  this->enabled_ = true;
}

Enable() [2/2]

template<typename M >

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

virtual

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

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

                                                                  {
  if (arena_transmit_) {
    if (opposite_attr.message_type() ==
            message::MessageType<message::RawMessage>() ||
        opposite_attr.message_type() ==
            message::MessageType<message::PyMessageWrap>()) {
      serialized_receiver_count_.fetch_add(1);
    } else {
      arena_receiver_count_.fetch_add(1);
    }
  } else {
    serialized_receiver_count_.fetch_add(1);
  }
  if (!this->enabled_) {
    this->Enable();
  }
}

Transmit()

template<typename M >

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

overridevirtual

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

在文件 shm_transmitter.h 第 195 行定义.

                                                              {
  return Transmit(*msg, msg_info);
}

---

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

• cyber/transport/transmitter/shm_transmitter.h