Add unit test measurements to CommOutQueue. More...

#include <comm_out_queue.h>

Inheritance diagram for MeasuredCommOutQueue:

Public Member Functions
	MeasuredCommOutQueue (unsigned max_buffered, std::chrono::duration< unsigned, std::milli > min_msg_gap)

	MeasuredCommOutQueue (unsigned max_buffered)

bool	push_back (const std::string &line) override
	Insert valid line of NMEA0183 data in buffer.

std::string	pop () override
	Return next line to send and remove it from buffer, throws exception if empty.

Public Member Functions inherited from CommOutQueue
virtual int	size () const
	Return number of lines in queue.

	CommOutQueue (unsigned max_buffered, std::chrono::duration< unsigned, std::milli > min_msg_gap)
	Create a buffer which stores at most max_buffered items of each message, applying rate limits if messages are entered "too" fast.

	CommOutQueue (unsigned max_buffered)
	Create a buffer which stores at most max_buffered items of each message.

	CommOutQueue ()
	Default buffer, allows 10 buffered messages of each type, applies rate limits when repeated with less than 600 ms intervals.

	CommOutQueue (const CommOutQueue &other)=delete

CommOutQueue &	operator= (const CommOutQueue &)=delete

Public Attributes
std::unordered_map< unsigned long, PerfCounter >	msg_perf

PerfCounter	perf

double	push_time

double	pop_time

Additional Inherited Members
Protected Types inherited from CommOutQueue
using	duration_ms = std::chrono::duration< unsigned, std::milli >

Protected Attributes inherited from CommOutQueue
std::vector< BufferItem >	m_buffer

std::mutex	m_mutex

int	m_size

duration_ms	m_min_msg_gap

bool	m_overrun_reported

std::set< uint64_t >	m_rate_limits_logged

Detailed Description

Add unit test measurements to CommOutQueue.

Definition at line 154 of file comm_out_queue.h.

Constructor & Destructor Documentation

◆ MeasuredCommOutQueue() [1/2]

MeasuredCommOutQueue::MeasuredCommOutQueue	(	unsigned	max_buffered,
		std::chrono::duration< unsigned, std::milli >	min_msg_gap
	)

inline

Definition at line 156 of file comm_out_queue.h.

◆ MeasuredCommOutQueue() [2/2]

MeasuredCommOutQueue::MeasuredCommOutQueue ( unsigned max_buffered )

inline

Definition at line 160 of file comm_out_queue.h.

Member Function Documentation

◆ pop()

std::string MeasuredCommOutQueue::pop ( )

overridevirtual

Return next line to send and remove it from buffer, throws exception if empty.

Reimplemented from CommOutQueue.

Definition at line 166 of file comm_out_queue.cpp.

◆ push_back()

bool MeasuredCommOutQueue::push_back ( const std::string & line )

overridevirtual

Insert valid line of NMEA0183 data in buffer.

Returns: false on errors including invalid input, else true.

Reimplemented from CommOutQueue.

Definition at line 151 of file comm_out_queue.cpp.

Member Data Documentation

◆ msg_perf

std::unordered_map<unsigned long, PerfCounter> MeasuredCommOutQueue::msg_perf

Definition at line 167 of file comm_out_queue.h.

◆ perf

PerfCounter MeasuredCommOutQueue::perf

Definition at line 169 of file comm_out_queue.h.

◆ pop_time

double MeasuredCommOutQueue::pop_time

Definition at line 171 of file comm_out_queue.h.

◆ push_time

double MeasuredCommOutQueue::push_time

Definition at line 170 of file comm_out_queue.h.

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

/home/runner/work/main/main/opencpn/model/include/model/comm_out_queue.h
/home/runner/work/main/main/opencpn/model/src/comm_out_queue.cpp

Public Member Functions

Public Attributes

Additional Inherited Members