apollo::cyber::transport::MessageInfo类 参考

#include <message_info.h>

apollo::cyber::transport::MessageInfo 的协作图:

Public 成员函数
	MessageInfo ()
	MessageInfo (const Identity &sender_id, uint64_t seq_num)
	MessageInfo (const Identity &sender_id, uint64_t seq_num, const Identity &spare_id)
	MessageInfo (const MessageInfo &another)
virtual	~MessageInfo ()
MessageInfo &	operator= (const MessageInfo &another)
bool	operator== (const MessageInfo &another) const
bool	operator!= (const MessageInfo &another) const
bool	SerializeTo (std::string *dst) const
bool	SerializeTo (char *dst, std::size_t len) const
bool	DeserializeFrom (const std::string &src)
bool	DeserializeFrom (const char *src, std::size_t len)
const Identity &	sender_id () const
void	set_sender_id (const Identity &sender_id)
uint64_t	channel_id () const
void	set_channel_id (uint64_t channel_id)
uint64_t	seq_num () const
void	set_seq_num (uint64_t seq_num)
const Identity &	spare_id () const
void	set_spare_id (const Identity &spare_id)
int32_t	msg_seq_num () const
void	set_msg_seq_num (int32_t msg_seq_num)
uint64_t	send_time () const
void	set_send_time (uint64_t send_time)

静态 Public 属性
static const std::size_t	kSize

详细描述

在文件 message_info.h 第 30 行定义.

构造及析构函数说明

MessageInfo() [1/4]

apollo::cyber::transport::MessageInfo::MessageInfo

(

)

在文件 message_info.cc 第 31 行定义.

: sender_id_(false), spare_id_(false) {}

MessageInfo() [2/4]

apollo::cyber::transport::MessageInfo::MessageInfo	(	const Identity &	sender_id,
		uint64_t	seq_num
	)

在文件 message_info.cc 第 33 行定义.

    : sender_id_(sender_id), seq_num_(seq_num), spare_id_(false) {}

MessageInfo() [3/4]

apollo::cyber::transport::MessageInfo::MessageInfo	(	const Identity &	sender_id,
		uint64_t	seq_num,
		const Identity &	spare_id
	)

在文件 message_info.cc 第 36 行定义.

    : sender_id_(sender_id), seq_num_(seq_num), spare_id_(spare_id) {}

MessageInfo() [4/4]

apollo::cyber::transport::MessageInfo::MessageInfo

(

const MessageInfo &

another

)

在文件 message_info.cc 第 40 行定义.

    : sender_id_(another.sender_id_),
      channel_id_(another.channel_id_),
      seq_num_(another.seq_num_),
      spare_id_(another.spare_id_) {}

~MessageInfo()

apollo::cyber::transport::MessageInfo::~MessageInfo ( )

virtual

在文件 message_info.cc 第 46 行定义.

{}

成员函数说明

channel_id()

uint64_t apollo::cyber::transport::MessageInfo::channel_id ( ) const

inline

在文件 message_info.h 第 52 行定义.

{ return channel_id_; }

DeserializeFrom() [1/2]

bool apollo::cyber::transport::MessageInfo::DeserializeFrom	(	const char *	src,
		std::size_t	len
	)

在文件 message_info.cc 第 112 行定义.

                                                                {
  RETURN_VAL_IF_NULL(src, false);
  if (len != kSize) {
    AWARN << "src size mismatch, given[" << len << "] target[" << kSize << "]";
    return false;
  }
 
  char* ptr = const_cast<char*>(src);
  sender_id_.set_data(ptr);
  ptr += ID_SIZE;
  std::memcpy(
    reinterpret_cast<char*>(&channel_id_), ptr, sizeof(channel_id_));
  ptr += sizeof(channel_id_);
  std::memcpy(
    reinterpret_cast<char*>(&seq_num_), ptr, sizeof(seq_num_));
  ptr += sizeof(seq_num_);
  spare_id_.set_data(ptr);
  ptr += ID_SIZE;
  std::memcpy(
    reinterpret_cast<char*>(&msg_seq_num_), ptr, sizeof(msg_seq_num_));
  ptr += sizeof(msg_seq_num_);
  std::memcpy(
    reinterpret_cast<char*>(&send_time_), ptr, sizeof(send_time_));
  return true;
}

DeserializeFrom() [2/2]

bool apollo::cyber::transport::MessageInfo::DeserializeFrom

(

const std::string &

src

)

在文件 message_info.cc 第 108 行定义.

                                                      {
  return DeserializeFrom(src.data(), src.size());
}

msg_seq_num()

int32_t apollo::cyber::transport::MessageInfo::msg_seq_num ( ) const

inline

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

{ return msg_seq_num_; }

operator!=()

bool apollo::cyber::transport::MessageInfo::operator!=

(

const MessageInfo &

another

)

const

在文件 message_info.cc 第 64 行定义.

                                                             {
  return !(*this == another);
}

operator=()

MessageInfo & apollo::cyber::transport::MessageInfo::operator=

(

const MessageInfo &

another

)

在文件 message_info.cc 第 48 行定义.

                                                              {
  if (this != &another) {
    sender_id_ = another.sender_id_;
    channel_id_ = another.channel_id_;
    seq_num_ = another.seq_num_;
    spare_id_ = another.spare_id_;
  }
  return *this;
}

operator==()

bool apollo::cyber::transport::MessageInfo::operator==

(

const MessageInfo &

another

)

const

在文件 message_info.cc 第 58 行定义.

                                                             {
  return sender_id_ == another.sender_id_ &&
         channel_id_ == another.channel_id_ && seq_num_ == another.seq_num_ &&
         spare_id_ == another.spare_id_;
}

send_time()

uint64_t apollo::cyber::transport::MessageInfo::send_time ( ) const

inline

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

{ return send_time_; }

sender_id()

const Identity & apollo::cyber::transport::MessageInfo::sender_id ( ) const

inline

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

{ return sender_id_; }

seq_num()

uint64_t apollo::cyber::transport::MessageInfo::seq_num ( ) const

inline

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

{ return seq_num_; }

SerializeTo() [1/2]

bool apollo::cyber::transport::MessageInfo::SerializeTo	(	char *	dst,
		std::size_t	len
	)		const

在文件 message_info.cc 第 84 行定义.

                                                            {
  if (dst == nullptr || len < kSize) {
    return false;
  }
 
  char* ptr = dst;
  std::memcpy(ptr, sender_id_.data(), ID_SIZE);
  ptr += ID_SIZE;
  std::memcpy(ptr,
    reinterpret_cast<const char*>(&channel_id_), sizeof(channel_id_));
  ptr += sizeof(channel_id_);
  std::memcpy(ptr,
    reinterpret_cast<const char*>(&seq_num_), sizeof(seq_num_));
  ptr += sizeof(seq_num_);
  std::memcpy(ptr, spare_id_.data(), ID_SIZE);
  ptr += ID_SIZE;
  std::memcpy(ptr,
    reinterpret_cast<const char*>(&msg_seq_num_), sizeof(msg_seq_num_));
  ptr += sizeof(msg_seq_num_);
  std::memcpy(ptr,
    reinterpret_cast<const char*>(&send_time_), sizeof(send_time_));
  return true;
}

SerializeTo() [2/2]

bool apollo::cyber::transport::MessageInfo::SerializeTo

(

std::string *

dst

)

const

在文件 message_info.cc 第 68 行定义.

                                                  {
  RETURN_VAL_IF_NULL(dst, false);
 
  dst->assign(sender_id_.data(), ID_SIZE);
  dst->append(
    reinterpret_cast<const char*>(&channel_id_), sizeof(channel_id_));
  dst->append(
    reinterpret_cast<const char*>(&seq_num_), sizeof(seq_num_));
  dst->append(spare_id_.data(), ID_SIZE);
  dst->append(reinterpret_cast<const char*>(
    &msg_seq_num_), sizeof(msg_seq_num_));
  dst->append(reinterpret_cast<const char*>(
    &send_time_), sizeof(send_time_));
  return true;
}

set_channel_id()

void apollo::cyber::transport::MessageInfo::set_channel_id ( uint64_t  channel_id )

inline

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

{ channel_id_ = channel_id; }

set_msg_seq_num()

void apollo::cyber::transport::MessageInfo::set_msg_seq_num ( int32_t  msg_seq_num )

inline

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

{ msg_seq_num_ = msg_seq_num; }

set_send_time()

void apollo::cyber::transport::MessageInfo::set_send_time ( uint64_t  send_time )

inline

在文件 message_info.h 第 67 行定义.

{ send_time_ = send_time; }

set_sender_id()

void apollo::cyber::transport::MessageInfo::set_sender_id ( const Identity &  sender_id )

inline

在文件 message_info.h 第 50 行定义.

{ sender_id_ = sender_id; }

set_seq_num()

void apollo::cyber::transport::MessageInfo::set_seq_num ( uint64_t  seq_num )

inline

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

{ seq_num_ = seq_num; }

set_spare_id()

void apollo::cyber::transport::MessageInfo::set_spare_id ( const Identity &  spare_id )

inline

在文件 message_info.h 第 59 行定义.

{ spare_id_ = spare_id; }

spare_id()

const Identity & apollo::cyber::transport::MessageInfo::spare_id ( ) const

inline

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

{ return spare_id_; }

类成员变量说明

kSize

const std::size_t apollo::cyber::transport::MessageInfo::kSize

static

初始值:

= 2 * ID_SIZE + sizeof(uint64_t) + 
                                        sizeof(uint64_t) + sizeof(int32_t) + 
                                        sizeof(uint64_t)

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

---

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

• cyber/transport/message/message_info.h
• cyber/transport/message/message_info.cc