apollo::common::monitor::MonitorLogBuffer类 参考

class MonitorLogBuffer 更多...

#include <monitor_log_buffer.h>

apollo::common::monitor::MonitorLogBuffer 的协作图:

Public 成员函数
	MonitorLogBuffer (const MonitorMessageItem::MessageSource &source)
	The constructor of MonitorBuffer.
virtual	~MonitorLogBuffer ()
	REG_MSG_TYPE (INFO)
	record an INFO type message
	REG_MSG_TYPE (WARN)
	record a WARN type message
	REG_MSG_TYPE (ERROR)
	record an ERROR type message
	REG_MSG_TYPE (FATAL)
	record a FATAL type message
void	AddMonitorMsgItem (const MonitorMessageItem::LogLevel log_level, const std::string &msg)
	Add monitor message with MonitorMessageItem::LogLevel
void	Publish ()
	publish the monitor messages

详细描述

class MonitorLogBuffer

This class help collect MonitorMessage pb to monitor topic. The messages can be published automatically when the MonitorBuffer object's destructor is called, or can be published by calling function Publish().

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

构造及析构函数说明

MonitorLogBuffer()

apollo::common::monitor::MonitorLogBuffer::MonitorLogBuffer ( const MonitorMessageItem::MessageSource &  source )

explicit

The constructor of MonitorBuffer.

参数

a	Monitor instance pointer;

在文件 monitor_log_buffer.cc 第 25 行定义.

    : source_(source) {}

~MonitorLogBuffer()

apollo::common::monitor::MonitorLogBuffer::~MonitorLogBuffer ( )

virtual

在文件 monitor_log_buffer.cc 第 37 行定义.

{ Publish(); }

成员函数说明

AddMonitorMsgItem()

void apollo::common::monitor::MonitorLogBuffer::AddMonitorMsgItem	(	const MonitorMessageItem::LogLevel	log_level,
		const std::string &	msg
	)

Add monitor message with MonitorMessageItem::LogLevel

参数

log_level	defined in modules/common/monitor/proto/monitor.proto
msg	the string to send to monitor

在文件 monitor_log_buffer.cc 第 39 行定义.

                                                                      {
  level_ = log_level;
  monitor_msg_items_.push_back(std::make_pair(log_level, msg));
}

Publish()

void apollo::common::monitor::MonitorLogBuffer::Publish

(

)

publish the monitor messages

在文件 monitor_log_buffer.cc 第 29 行定义.

                               {
  if (!monitor_msg_items_.empty()) {
    logger_->Publish(source_, monitor_msg_items_);
    monitor_msg_items_.clear();
    level_ = MonitorMessageItem::INFO;
  }
}

REG_MSG_TYPE() [1/4]

apollo::common::monitor::MonitorLogBuffer::REG_MSG_TYPE

(

ERROR

)

record an ERROR type message

REG_MSG_TYPE() [2/4]

apollo::common::monitor::MonitorLogBuffer::REG_MSG_TYPE

(

FATAL

)

record a FATAL type message

REG_MSG_TYPE() [3/4]

apollo::common::monitor::MonitorLogBuffer::REG_MSG_TYPE

(

INFO

)

record an INFO type message

REG_MSG_TYPE() [4/4]

apollo::common::monitor::MonitorLogBuffer::REG_MSG_TYPE

(

WARN

)

record a WARN type message

---

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

• modules/common/monitor_log/monitor_log_buffer.h
• modules/common/monitor_log/monitor_log_buffer.cc