RTI Connext Traditional C++ API Version 7.2.0
DDS_LoggingQosPolicy Struct Reference

Configures the RTI Connext logging facility. More...

Public Attributes

NDDS_Config_LogVerbosity verbosity
 The verbosities at which RTI Connext diagnostic information is logged. More...
 
NDDS_Config_LogCategory category
 Categories of logged messages. More...
 
NDDS_Config_LogPrintFormat print_format
 The format used to output RTI Connext diagnostic information. More...
 
char * output_file
 Specifies the file to which log messages will be redirected to. More...
 
char * output_file_suffix
 Sets the file suffix when logging to a set of files. More...
 
DDS_Long max_bytes_per_file
 Specifies the maximum number of bytes a single file can contain. More...
 
DDS_Long max_files
 Specifies the maximum number of files to create before overwritting the previous ones. More...
 

Detailed Description

Configures the RTI Connext logging facility.

All the properties associated with RTI Connext logging can be configured using this QoS policy. This allows you to configure logging using XML QoS Profiles. See the "Troubleshooting" chapter in the User's Manual for details.

Entity:
DDSDomainParticipantFactory
Properties:
RxO = NO
Changeable = Changeable

Member Data Documentation

◆ verbosity

NDDS_Config_LogVerbosity DDS_LoggingQosPolicy::verbosity

The verbosities at which RTI Connext diagnostic information is logged.

[default] NDDS_CONFIG_LOG_VERBOSITY_ERROR

◆ category

NDDS_Config_LogCategory DDS_LoggingQosPolicy::category

Categories of logged messages.

[default] Logging will be enabled for all the categories.

◆ print_format

NDDS_Config_LogPrintFormat DDS_LoggingQosPolicy::print_format

The format used to output RTI Connext diagnostic information.

[default] NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT.

◆ output_file

char* DDS_LoggingQosPolicy::output_file

Specifies the file to which log messages will be redirected to.

If the value of ouput_file is set to NULL, log messages will sent to standard output.

If DDS_LoggingQosPolicy::max_bytes_per_file is not DDS_LENGTH_UNLIMITED, this is used as the file name preffix for a set of numbered files.

Important: This value must be an allocated string with DDS_String_alloc or DDS_String_dup. It should not be assigned to a string constant.

[default] NULL

See also
NDDSConfigLogger::set_output_file_set

◆ output_file_suffix

char* DDS_LoggingQosPolicy::output_file_suffix

Sets the file suffix when logging to a set of files.

Note
This field only applies when idref_LoggingQosPolicy_max_bytes_per_file is different than DDS_LENGTH_UNLIMITED.

It specifies the suffix to use for the set of files used to redirect the logging output. The preffix is DDS_LoggingQosPolicy::output_file.

Important: This value must be an allocated string with DDS_String_alloc or DDS_String_dup. It should not be assigned to a string constant.

[default] NULL

[default] No suffix

See also
NDDSConfigLogger::set_output_file_set

◆ max_bytes_per_file

DDS_Long DDS_LoggingQosPolicy::max_bytes_per_file

Specifies the maximum number of bytes a single file can contain.

When this field is different than DDS_LENGTH_UNLIMITED, it enables logging to separate files as they reach this size.

[default] DDS_LENGTH_UNLIMITED (a single file is used)

See also
NDDSConfigLogger::set_output_file_set

◆ max_files

DDS_Long DDS_LoggingQosPolicy::max_files

Specifies the maximum number of files to create before overwritting the previous ones.

Note
This field only applies when idref_LoggingQosPolicy_max_bytes_per_file is differenet than DDS_LENGTH_UNLIMITED.

When this field is different than DDS_LENGTH_UNLIMITED, and the number of files reaches this number, future logging messages overwrite the previously created files.

[default] DDS_LENGTH_UNLIMITED (files aren't overwritten)

See also
NDDSConfigLogger::set_output_file_set