RTI Connext Java API  Version 5.3.1
 All Classes Namespaces Functions Variables Groups Pages
LoggingQosPolicy Class Reference

Configures the RTI Connext logging facility. More...

Inheritance diagram for LoggingQosPolicy:
QosPolicy

Public Attributes

LogVerbosity verbosity
 The verbosities at which RTI Connext diagnostic information is logged.
 
LogCategory category
 Categories of logged messages.
 
LogPrintFormat print_format
 The format used to output RTI Connext diagnostic information.
 
String output_file
 Specifies the file to which log messages will be redirected to.
 
String output_file_suffix
 Sets the file suffix when logging to a set of files.
 
int max_bytes_per_file
 Specifies the maximum number of bytes a single file can contain.
 
int max_files
 Specifies the maximum number of files to create before overwritting the previous ones.
 
- Public Attributes inherited from QosPolicy
final QosPolicyId_t id
 The ID of this QoS policy.
 
final String policy_name
 The name of this QoS policy.
 

Additional Inherited Members

- Public Member Functions inherited from Struct
abstract boolean equals (Object obj)
 
abstract int hashCode ()
 
String toString ()
 
- Protected Member Functions inherited from Struct
 Struct ()
 
abstract void pull_from_nativeI (long native_status)
 
abstract void push_to_nativeI (long native_status)
 

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:
com.rti.dds.domain.DomainParticipantFactory
Properties:
RxO = NO
Changeable = Changeable

Member Data Documentation

LogVerbosity verbosity

The verbosities at which RTI Connext diagnostic information is logged.

[default] com.rti.ndds.config.LogVerbosity.NDDS_CONFIG_LOG_VERBOSITY_ERROR

LogCategory category

Categories of logged messages.

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

LogPrintFormat print_format

The format used to output RTI Connext diagnostic information.

[default] com.rti.ndds.config.LogPrintFormat.NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT.

String 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 com.rti.dds.infrastructure.LoggingQosPolicy.max_bytes_per_file is not com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED, this is used as the file name preffix for a set of numbered files.

[default] NULL

See Also
com.rti.ndds.config.Logger.set_output_file_set
String 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 com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED.

It specifies the suffix to use for the set of files used to redirect the logging output. The preffix is com.rti.dds.infrastructure.LoggingQosPolicy.output_file.

[default] NULL

[default] No suffix

See Also
com.rti.ndds.config.Logger.set_output_file_set
int max_bytes_per_file

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

When this field is different than com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED, it enables logging to separate files as they reach this size.

[default] com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED (a single file is used)

See Also
com.rti.ndds.config.Logger.set_output_file_set
int 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 com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED.

When this field is different than com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED, and the number of files reaches this number, future logging messages overwrite the previously created files.

[default] com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED (files aren't overwritten)

See Also
com.rti.ndds.config.Logger.set_output_file_set

RTI Connext Java API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc