RTI Connext .Net APIs  Version 5.3.1
DDS::LoggingQosPolicy Class Reference

Configures the RTI Connext logging facility. More...

#include <managed_infrastructure.h>

Static Public Member Functions

static System::String ^ get_logging_qos_policy_name ()
 Stringified human-readable name for DDS::LoggingQosPolicy. More...
 

Public Attributes

NDDS::LogVerbosity verbosity
 The verbosities at which RTI Connext diagnostic information is logged. More...
 
NDDS::LogCategory category
 Categories of logged messages. More...
 
NDDS::LogPrintFormat print_format
 The format used to output RTI Connext diagnostic information. More...
 
System::String ^ output_file
 Specifies the file to which log messages will be redirected to. More...
 
System::String ^ output_file_suffix
 Sets the file suffix when logging to a set of files. More...
 
System::Int32 max_bytes_per_file
 Specifies the maximum number of bytes a single file can contain. More...
 
System::Int32 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:
DDS::DomainParticipantFactory
Properties:
RxO = NO
Changeable = Changeable

Member Data Documentation

◆ verbosity

NDDS::LogVerbosity DDS::LoggingQosPolicy::verbosity

The verbosities at which RTI Connext diagnostic information is logged.

[default] NDDS::LogVerbosity::NDDS_CONFIG_LOG_VERBOSITY_ERROR

◆ category

NDDS::LogCategory DDS::LoggingQosPolicy::category

Categories of logged messages.

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

◆ print_format

NDDS::LogPrintFormat DDS::LoggingQosPolicy::print_format

The format used to output RTI Connext diagnostic information.

[default] NDDS::LogPrintFormat::NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT.

◆ output_file

System::String ^ 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::ResourceLimitsQosPolicy::LENGTH_UNLIMITED, this is used as the file name preffix for a set of numbered files.

[default] NULL

See also
NDDS::ConfigLogger::set_output_file_set

◆ output_file_suffix

System::String ^ 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::ResourceLimitsQosPolicy::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.

[default] NULL

[default] No suffix

See also
NDDS::ConfigLogger::set_output_file_set

◆ max_bytes_per_file

System::Int32 DDS::LoggingQosPolicy::max_bytes_per_file

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

When this field is different than DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED, it enables logging to separate files as they reach this size.

[default] DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED (a single file is used)

See also
NDDS::ConfigLogger::set_output_file_set

◆ max_files

System::Int32 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::ResourceLimitsQosPolicy::LENGTH_UNLIMITED.

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

[default] DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED (files aren't overwritten)

See also
NDDS::ConfigLogger::set_output_file_set

RTI Connext .Net APIs Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc