ts::AsyncReportArgs Class Reference

Parameters and command line arguments for asynchronous log. More...

#include <tsAsyncReportArgs.h>

Public Member Functions
	AsyncReportArgs ()=default
	Default constructor.
void	defineArgs (Args &args)
	Add command line option definitions in an Args.
bool	loadArgs (Args &args)
	Load arguments from command line.

Public Attributes
size_t	log_msg_count = MAX_LOG_MESSAGES
	Maximum buffered log messages.
bool	sync_log = false
	Synchronous log.
bool	timed_log = false
	Add time stamps in log messages.

Static Public Attributes
static constexpr size_t	MAX_LOG_MESSAGES = 512
	Default maximum number of messages in the queue.

Detailed Description

Parameters and command line arguments for asynchronous log.

Member Function Documentation

defineArgs()

void ts::AsyncReportArgs::defineArgs

(

Args &

args

)

Add command line option definitions in an Args.

Parameters

[in,out]

args

Command line arguments to update.

loadArgs()

bool ts::AsyncReportArgs::loadArgs

(

Args &

args

)

Load arguments from command line.

Args error indicator is set in case of incorrect arguments.

Parameters

[in,out]

args

Command line arguments.

Returns

True on success, false on error in argument line.

Member Data Documentation

MAX_LOG_MESSAGES

constexpr size_t ts::AsyncReportArgs::MAX_LOG_MESSAGES = 512

staticconstexpr

Default maximum number of messages in the queue.

Must be limited since the logging thread has a low priority. If a high priority thread loops on report, it would exhaust the memory.

---

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

• tsAsyncReportArgs.h