RTI Connext Traditional C++ API  Version 6.1.2

Configure how much debugging information is reported during runtime and where it is logged. More...

Modules

 Activity Context
 Add contextual information to log messages.
 

Classes

struct  NDDS_Config_LogMessage
 Log message. More...
 
class  NDDSConfigLoggerDevice
 <<interface>> Logging device interface. Use for user-defined logging devices. More...
 
class  NDDSConfigLogger
 <<interface>> The singleton type used to configure RTI Connext logging. More...
 

Enumerations

enum  NDDS_Config_LogVerbosity {
  NDDS_CONFIG_LOG_VERBOSITY_SILENT,
  NDDS_CONFIG_LOG_VERBOSITY_ERROR,
  NDDS_CONFIG_LOG_VERBOSITY_WARNING,
  NDDS_CONFIG_LOG_VERBOSITY_STATUS_LOCAL,
  NDDS_CONFIG_LOG_VERBOSITY_STATUS_REMOTE,
  NDDS_CONFIG_LOG_VERBOSITY_STATUS_ALL
}
 The verbosities at which RTI Connext diagnostic information is logged. More...
 
enum  NDDS_Config_LogLevel {
  NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR,
  NDDS_CONFIG_LOG_LEVEL_ERROR,
  NDDS_CONFIG_LOG_LEVEL_WARNING,
  NDDS_CONFIG_LOG_LEVEL_STATUS_LOCAL,
  NDDS_CONFIG_LOG_LEVEL_STATUS_REMOTE,
  NDDS_CONFIG_LOG_LEVEL_DEBUG
}
 Level category assigned to RTI Connext log messages returned to an output device. More...
 
enum  NDDS_Config_LogCategory {
  NDDS_CONFIG_LOG_CATEGORY_PLATFORM,
  NDDS_CONFIG_LOG_CATEGORY_COMMUNICATION,
  NDDS_CONFIG_LOG_CATEGORY_DATABASE,
  NDDS_CONFIG_LOG_CATEGORY_ENTITIES,
  NDDS_CONFIG_LOG_CATEGORY_API,
  NDDS_CONFIG_LOG_CATEGORY_ALL
}
 Categories of logged messages. More...
 
enum  NDDS_Config_LogPrintFormat { ,
  NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT,
  NDDS_CONFIG_LOG_PRINT_FORMAT_TIMESTAMPED,
  NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE,
  NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE_TIMESTAMPED,
  NDDS_CONFIG_LOG_PRINT_FORMAT_DEBUG,
  NDDS_CONFIG_LOG_PRINT_FORMAT_MINIMAL,
  NDDS_CONFIG_LOG_PRINT_FORMAT_MAXIMAL
}
 The format used to output RTI Connext diagnostic information. More...
 

Detailed Description

Configure how much debugging information is reported during runtime and where it is logged.

Enumeration Type Documentation

◆ NDDS_Config_LogVerbosity

The verbosities at which RTI Connext diagnostic information is logged.

Enumerator
NDDS_CONFIG_LOG_VERBOSITY_SILENT 

No further output will be logged.

NDDS_CONFIG_LOG_VERBOSITY_ERROR 

Only error and fatal error messages will be logged.

An error indicates something wrong in the functioning of RTI Connext. The most common cause of errors is incorrect configuration.

NDDS_CONFIG_LOG_VERBOSITY_WARNING 

Both error and warning messages will be logged.

A warning indicates that RTI Connext is taking an action that may or may not be what you intended. Some configuration information is also logged at this verbosity to aid in debugging.

NDDS_CONFIG_LOG_VERBOSITY_STATUS_LOCAL 

Errors, warnings, and verbose information about the lifecycles of local RTI Connext objects will be logged.

NDDS_CONFIG_LOG_VERBOSITY_STATUS_REMOTE 

Errors, warnings, and verbose information about the lifecycles of remote RTI Connext objects will be logged.

NDDS_CONFIG_LOG_VERBOSITY_STATUS_ALL 

Errors, warnings, verbose information about the lifecycles of local and remote RTI Connext objects, and periodic information about RTI Connext threads will be logged.

◆ NDDS_Config_LogLevel

Level category assigned to RTI Connext log messages returned to an output device.

Enumerator
NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR 

The message describes a fatal error.

A fatal error indicates an unrecoverable situation in the functioning of RTI Connext. Error messages with this log level usually indicate a violation of an internal invariant or a segfault, and may include the function call stack where the fatal error happened.

NDDS_CONFIG_LOG_LEVEL_ERROR 

The message describes an error.

An error indicates a non-fatal problem in the functioning of RTI Connext. Errors are usually recoverable and will not stop application execution, although they may prevent some features from working properly. The most common cause of non-fatal errors is incorrect configuration and incorrect arguments.

NDDS_CONFIG_LOG_LEVEL_WARNING 

The message describes a warning.

A warning indicates that RTI Connext is taking an action that may or may not be what you intended. Some configuration information is also logged at this verbosity to aid in debugging.

NDDS_CONFIG_LOG_LEVEL_STATUS_LOCAL 

The message contains information about the lifecycles of local RTI Connext objects will be logged.

NDDS_CONFIG_LOG_LEVEL_STATUS_REMOTE 

The message contains information about the lifecycles of remote RTI Connext objects will be logged.

NDDS_CONFIG_LOG_LEVEL_DEBUG 

The message contains debug information that might be relevant to your application.

◆ NDDS_Config_LogCategory

Categories of logged messages.

The NDDSConfigLogger::get_verbosity_by_category and NDDSConfigLogger::set_verbosity_by_category can be used to specify different verbosities for different categories of messages.

Enumerator
NDDS_CONFIG_LOG_CATEGORY_PLATFORM 

Log messages pertaining to the underlying platform (hardware and OS) on which RTI Connext is running are in this category.

NDDS_CONFIG_LOG_CATEGORY_COMMUNICATION 

Log messages pertaining to data serialization and deserialization and network traffic are in this category.

NDDS_CONFIG_LOG_CATEGORY_DATABASE 

Log messages pertaining to the internal database in which RTI Connext objects are stored are in this category.

NDDS_CONFIG_LOG_CATEGORY_ENTITIES 

Log messages pertaining to local and remote entities and to the discovery process are in this category.

NDDS_CONFIG_LOG_CATEGORY_API 

Log messages pertaining to the API layer of RTI Connext (such as method argument validation) are in this category.

NDDS_CONFIG_LOG_CATEGORY_ALL 

Log messages pertaining to all category of RTI Connext.

◆ NDDS_Config_LogPrintFormat

The format used to output RTI Connext diagnostic information.

Enumerator
NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT 

(default) Print message, method name, and Activity Context (what was happening when the event occurred).

NDDS_CONFIG_LOG_PRINT_FORMAT_TIMESTAMPED 

Print message, method name, Activity Context, and timestamp.

NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE 

Print message with all available context information (includes thread identifier, Activity Context).

NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE_TIMESTAMPED 

Print message with all available context information, and timestamp.

NDDS_CONFIG_LOG_PRINT_FORMAT_DEBUG 

Print a set of fields (including the Activity Context and backtrace information) that may be useful for internal debugging.

NDDS_CONFIG_LOG_PRINT_FORMAT_MINIMAL 

Print only message number and method name.

NDDS_CONFIG_LOG_PRINT_FORMAT_MAXIMAL 

Print all available fields (including backtrace information).