RTI Connext C# API  6.1.0
Rti.Config Namespace Reference

Contains configuration utilities, such as logging More...

Classes

class  Logger
 The singleton used to configure RTI Connext logging More...
 
struct  LogMessage
 A log message provided by the Logger.MessageLogged event. More...
 
class  ProductVersion
 Contains the version of the RTI Connext DDS and its different libraries. More...
 

Enumerations

enum class  LogLevel {
  FatalError ,
  Error ,
  Warning ,
  StatusLocal ,
  StatusRemote ,
  Debug
}
 The level at which diagnostic information is logged. More...
 
enum class  Verbosity {
  Silent ,
  Error ,
  Warning ,
  StatusLocal ,
  StatusRemote ,
  StatusAll
}
 The verbosity levels at which diagnostic information is logged More...
 
enum class  LogCategory {
  Platform ,
  Communication ,
  Database ,
  Entities ,
  Api ,
  All
}
 Categories of log messages More...
 
enum class  LogPrintFormat {
  Default ,
  Timestamped ,
  Verbose ,
  VerboseTimestamped ,
  Debug ,
  Minimal ,
  Maximal
}
 Configures the format to print diagnostic information More...
 

Functions

delegate void MessageLoggedEventHandler (LogMessage message)
 Event handler for Logger.MessageLogged. More...
 

Detailed Description

Contains configuration utilities, such as logging

Enumeration Type Documentation

◆ LogCategory

enum LogCategory
strong

Categories of log messages

The full documentation is available in the C API: DDS_LogCategory

Enumerator
Platform 

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

The full documentation is available in the C API: DDS_NDDS_CONFIG_LOG_CATEGORY_PLATFORM

Communication 

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

The full documentation is available in the C API: DDS_NDDS_CONFIG_LOG_CATEGORY_COMMUNICATION

Database 

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

The full documentation is available in the C API: DDS_NDDS_CONFIG_LOG_CATEGORY_DATABASE

Entities 

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

The full documentation is available in the C API: DDS_NDDS_CONFIG_LOG_CATEGORY_ENTITIES

Api 

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

The full documentation is available in the C API: DDS_NDDS_CONFIG_LOG_CATEGORY_API

All 

Log messages pertaining to all category of RTI Connext

The full documentation is available in the C API: DDS_NDDS_CONFIG_LOG_CATEGORY_ALL

◆ LogLevel

enum LogLevel
strong

The level at which diagnostic information is logged.

The full documentation is available in the C API: NDDS_Config_LogLevel

Enumerator
FatalError 

The message describes a fatal error.

The full documentation is available in the C API: NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR

Error 

The message describes an error.

The full documentation is available in the C API: NDDS_CONFIG_LOG_LEVEL_ERROR

Warning 

The message describes a warning.

The full documentation is available in the C API: DDS_NDDS_CONFIG_LOG_LEVEL_WARNING

StatusLocal 

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

The full documentation is available in the C API: DDS_NDDS_CONFIG_LOG_LEVEL_STATUS_LOCAL

StatusRemote 

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

The full documentation is available in the C API: DDS_NDDS_CONFIG_LOG_LEVEL_STATUS_REMOTE

Debug 

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

The full documentation is available in the C API: DDS_NDDS_CONFIG_LOG_LEVEL_DEBUG

◆ LogPrintFormat

enum LogPrintFormat
strong

Configures the format to print diagnostic information

Enumerator
Default 

Print message, method name, and activity context (what was happening when the event occurred).

The full documentation is available in the C API: NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT

Timestamped 

Print message, method name, activity context, and timestamp.

The full documentation is available in the C API: NDDS_CONFIG_LOG_PRINT_FORMAT_TIMESTAMPED

Verbose 

Print message with all available context information

The full documentation is available in the C API: NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE

VerboseTimestamped 

Print message with all available context information, and timestamp.

The full documentation is available in the C API: NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE_TIMESTAMPED

Debug 

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

The full documentation is available in the C API: NDDS_CONFIG_LOG_PRINT_FORMAT_DEBUG

Minimal 

Print only message number and method name.

The full documentation is available in the C API: NDDS_CONFIG_LOG_PRINT_FORMAT_MINIMAL

Maximal 

Print all available fields (including backtrace information).

The full documentation is available in the C API: NDDS_CONFIG_LOG_PRINT_FORMAT_MAXIMAL

◆ Verbosity

enum Verbosity
strong

The verbosity levels at which diagnostic information is logged

The full documentation is available in the C API: NDDS_Config_LogVerbosity

Enumerator
Silent 

No output will be logged.

The full documentation is available in the C API: NDDS_CONFIG_LOG_VERBOSITY_SILENT

Error 

Only error and fatal error messages will be logged.

The full documentation is available in the C API: NDDS_CONFIG_LOG_VERBOSITY_ERROR

Warning 

Both error and warning messages will be logged.

The full documentation is available in the C API: NDDS_CONFIG_LOG_VERBOSITY_WARNING

Both error and warning messages will be logged.

The full documentation is available in the C API: NDDS_CONFIG_LOG_VERBOSITY_WARNING

StatusLocal 

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

The full documentation is available in the C API: NDDS_CONFIG_LOG_VERBOSITY_STATUS_LOCAL

StatusRemote 

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

The full documentation is available in the C API: NDDS_CONFIG_LOG_VERBOSITY_STATUS_REMOTE

StatusAll 

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

The full documentation is available in the C API: NDDS_CONFIG_LOG_VERBOSITY_STATUS_ALL

Function Documentation

◆ MessageLoggedEventHandler()

delegate void Rti.Config.MessageLoggedEventHandler ( LogMessage  message)

Event handler for Logger.MessageLogged.