OSAPI_LogProperty Struct Reference

Configuration of logging functionality. More...

#include <osapi_log.h>

Data Fields
RTI_SIZE_T	max_buffer_size
	The maximum number of bytes allocated to the log buffer.
RTI_UINT32	log_detail
	Bitmap to control the fidelity of what is stored in the log entry.
OSAPI_Log_write_buffer_T	write_buffer
	Function pointer to output a log buffer.

Detailed Description

Configuration of logging functionality.

Field Documentation

max_buffer_size

RTI_SIZE_T OSAPI_LogProperty::max_buffer_size

The maximum number of bytes allocated to the log buffer.

Log entries are of variable length. When this limit has been reached, no more log entries can be stored unless the buffer is cleared.

log_detail

RTI_UINT32 OSAPI_LogProperty::log_detail

Bitmap to control the fidelity of what is stored in the log entry.

This is an OR-combination of OSAPI_LOG_DETAIL_MODULENAME and related constants into a 32-bit bitmap (RTI_UINT32). Each flag controls whether a specific field is recorded in each OSAPI_LogEntry:

OSAPI_LOG_DETAIL_MODULENAME — records the module name of the code that logged the entry.

OSAPI_LOG_DETAIL_SOURCEFILE — records the source file name of the logging call site.

OSAPI_LOG_DETAIL_LINENUMBER — records the source line number of the logging call site.

OSAPI_LOG_DETAIL_FUNCTIONAME — records the function name of the logging call site.

OSAPI_LOG_DETAIL_DATA_ONLY — records only the log data and argument fields; no call-site location information is stored.

OSAPI_LOG_DETAIL_ALL — enables all of the above fields combined (the default).

OSAPI_LOG_DETAIL_NO_DATA — enables all call-site location fields (module, file, line, function) but excludes the data-only fields.

Enabling more flags increases memory consumed per log entry. The default value is OSAPI_LOG_DETAIL_ALL, as set by OSAPI_LogProperty_INITIALIZER.

write_buffer

OSAPI_Log_write_buffer_T OSAPI_LogProperty::write_buffer

Function pointer to output a log buffer.