apollo::common::monitor::MonitorLogBuffer Class Reference

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(). More...

#include <monitor_log_buffer.h>

Collaboration diagram for apollo::common::monitor::MonitorLogBuffer:

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

Detailed Description

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().

class MonitorLogBuffer

Constructor & Destructor Documentation

MonitorLogBuffer()

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

explicit

The constructor of MonitorBuffer.

Parameters

a	Monitor instance pointer;

~MonitorLogBuffer()

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

virtual

Member Function Documentation

AddMonitorMsgItem()

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

Add monitor message with MonitorMessageItem::LogLevel.

Parameters

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

Publish()

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

(

)

publish the monitor messages

REG_MSG_TYPE() [1/4]

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

(

INFO

)

record an INFO type message

REG_MSG_TYPE() [2/4]

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

(

WARN

)

record a WARN type message

REG_MSG_TYPE() [3/4]

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

(

ERROR

)

record an ERROR type message

REG_MSG_TYPE() [4/4]

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

(

FATAL

)

record a FATAL type message

---

The documentation for this class was generated from the following file:

• modules/common/monitor_log/monitor_log_buffer.h