RTI Connext C# API Version 7.3.0
Rti.Config Namespace Reference

Contains configuration utilities, such as logging More...

Data Structures

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  LogLevel {
  FatalError = NDDS_Config_LogLevel.NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR ,
  Error = NDDS_Config_LogLevel.NDDS_CONFIG_LOG_LEVEL_ERROR ,
  Warning = NDDS_Config_LogLevel.NDDS_CONFIG_LOG_LEVEL_WARNING ,
  StatusLocal = NDDS_Config_LogLevel.NDDS_CONFIG_LOG_LEVEL_STATUS_LOCAL ,
  StatusRemote = NDDS_Config_LogLevel.NDDS_CONFIG_LOG_LEVEL_STATUS_REMOTE ,
  Debug = NDDS_Config_LogLevel.NDDS_CONFIG_LOG_LEVEL_DEBUG
}
 The level at which diagnostic information is logged. More...
 
enum  SyslogLevel {
  Emergency = RTISyslogLevel.RTI_SYSLOG_LEVEL_EMERGENCY ,
  Alert = RTISyslogLevel.RTI_SYSLOG_LEVEL_ALERT ,
  Critical = RTISyslogLevel.RTI_SYSLOG_LEVEL_CRITICAL ,
  Error = RTISyslogLevel.RTI_SYSLOG_LEVEL_ERROR ,
  Warning = RTISyslogLevel.RTI_SYSLOG_LEVEL_WARNING ,
  Notice = RTISyslogLevel.RTI_SYSLOG_LEVEL_NOTICE ,
  Informational = RTISyslogLevel.RTI_SYSLOG_LEVEL_INFORMATIONAL ,
  Debug = RTISyslogLevel.RTI_SYSLOG_LEVEL_DEBUG
}
 Syslog level category assigned to RTI Connext log messages. More...
 
enum  Verbosity {
  Silent = LogBits.SILENCE ,
  Error = LogBits.EXCEPTION | LogBits.FATALERROR ,
  Warning = Error | LogBits.WARN ,
  StatusLocal = Warning | LogBits.LOCAL ,
  StatusRemote = StatusLocal | LogBits.REMOTE ,
  StatusAll = StatusRemote | LogBits.PERIODIC
}
 The verbosity levels at which diagnostic information is logged More...
 
enum  SyslogVerbosity {
  Silent = SyslogBits.SILENCE ,
  Emergency = SyslogBits.EMERGENCY ,
  Alert = Emergency | SyslogBits.ALERT ,
  Critical = Alert | SyslogBits.CRITICAL ,
  Error = Critical | SyslogBits.ERROR ,
  Warning = Error | SyslogBits.WARNING ,
  Notice = Warning | SyslogBits.NOTICE ,
  Informational = Notice | SyslogBits.INFORMATIONAL ,
  Debug = Informational | SyslogBits.DEBUG
}
 The Syslog verbosity levels at which RTI Connext diagnostic information is logged. More...
 
enum  LogCategory {
  Platform = NDDS_Config_LogCategory.NDDS_CONFIG_LOG_CATEGORY_PLATFORM ,
  Communication = NDDS_Config_LogCategory.NDDS_CONFIG_LOG_CATEGORY_COMMUNICATION ,
  Database = NDDS_Config_LogCategory.NDDS_CONFIG_LOG_CATEGORY_DATABASE ,
  Entities = NDDS_Config_LogCategory.NDDS_CONFIG_LOG_CATEGORY_ENTITIES ,
  Api = NDDS_Config_LogCategory.NDDS_CONFIG_LOG_CATEGORY_API ,
  Discovery = NDDS_Config_LogCategory.NDDS_CONFIG_LOG_CATEGORY_DISCOVERY ,
  Security = NDDS_Config_LogCategory.NDDS_CONFIG_LOG_CATEGORY_SECURITY ,
  User = NDDS_Config_LogCategory.NDDS_CONFIG_LOG_CATEGORY_USER ,
  All = NDDS_Config_LogCategory.NDDS_CONFIG_LOG_CATEGORY_ALL
}
 Categories of log messages More...
 
enum  LogPrintFormat {
  Default = 0x3412 ,
  Timestamped = 0x3512 ,
  Verbose = 0x3e16 ,
  VerboseTimestamped = 0x3f16 ,
  Debug = 0x366f ,
  Minimal = 0x011 ,
  Maximal = 0x3f7f
}
 Configures the format to print diagnostic information. More...
 
enum  LogFacility {
  User = NDDS_Config_LogFacility.NDDS_CONFIG_LOG_FACILITY_USER ,
  SecurityEvent = NDDS_Config_LogFacility.NDDS_CONFIG_LOG_FACILITY_SECURITY_EVENT ,
  Service = NDDS_Config_LogFacility.NDDS_CONFIG_LOG_FACILITY_SERVICE ,
  Middleware = NDDS_Config_LogFacility.NDDS_CONFIG_LOG_FACILITY_MIDDLEWARE
}
 A number that identifies the source of a log message. More...
 

Functions

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

Detailed Description

Contains configuration utilities, such as logging

Enumeration Type Documentation

◆ LogLevel

The level at which diagnostic information is logged.

The full documentation is available in the C API: NDDSLogLevel

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: 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: 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: 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: NDDS_CONFIG_LOG_LEVEL_DEBUG

◆ SyslogLevel

Syslog level category assigned to RTI Connext log messages.

The full documentation is available in the C API: NDDSSyslogLevel

Enumerator
Emergency 

System is unusable.

The full documentation is available in the C API: NDDS_CONFIG_LOG_LEVEL_EMERGENCY

Alert 

Should be corrected immediately.

The full documentation is available in the C API: NDDS_CONFIG_LOG_LEVEL_ALERT

Critical 

Critical conditions.

The full documentation is available in the C API: NDDS_CONFIG_LOG_LEVEL_CRITICAL

Error 

Error conditions.

The full documentation is available in the C API: NDDS_CONFIG_LOG_LEVEL_ERROR

Warning 

May indicate that an error will occur if action is not taken.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_LEVEL_WARNING

Notice 

Events that are unusual, but not error conditions.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_LEVEL_NOTICE

Informational 

Normal operational messages that require no action.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_LEVEL_INFORMATIONAL

Debug 

Information useful to developers for debugging the application.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_LEVEL_DEBUG

◆ Verbosity

The verbosity levels at which diagnostic information is logged

The full documentation is available in the C API: NDDSLogVerbosity

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

◆ SyslogVerbosity

The Syslog verbosity levels at which RTI Connext diagnostic information is logged.

The full documentation is available in the C API: NDDSSyslogVerbosity

Enumerator
Silent 

No output will be logged.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_VERBOSITY_SILENT

Emergency 

Only fatal log messages will be logged.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_VERBOSITY_EMERGENCY

Alert 

Only fatal log messages will be logged.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_VERBOSITY_ALERT

Critical 

Only fatal log messages will be logged.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_VERBOSITY_CRITICAL

Error 

Only error and fatal error messages will be logged.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_VERBOSITY_ERROR

Warning 

Fatal, error and warning messages will be logged.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_VERBOSITY_WARNING

Notice 

Fatal, error and warning messages will be logged.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_VERBOSITY_NOTICE

Informational 

Local, remote, fatal, error and warning messages will be logged.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_VERBOSITY_INFORMATIONAL

Debug 

All messages will be logged.

The full documentation is available in the C API: NDDS_CONFIG_SYSLOG_VERBOSITY_DEBUG

◆ LogCategory

Categories of log messages

The full documentation is available in the C API: NDDSLogCategory

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: NDDSLogCategory_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: NDDSLogCategory_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: NDDSLogCategory_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: NDDSLogCategory_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: NDDSLogCategory_NDDS_CONFIG_LOG_CATEGORY_API

Discovery 

Log messages pertaining to Discovery are in this category.

The full documentation is available in the C API: NDDSLogCategory_NDDS_CONFIG_LOG_CATEGORY_DISCOVERY

Security 

Log messages pertaining to Security are in this category.

The full documentation is available in the C API: NDDSLogCategory_NDDS_CONFIG_LOG_CATEGORY_SECURITY

User 

Log messages pertaining to Security are in this category.

The full documentation is available in the C API: NDDSLogCategory_NDDS_CONFIG_LOG_CATEGORY_USER

All 

Log messages pertaining to all category of RTI Connext

The full documentation is available in the C API: NDDSLogCategory_NDDS_CONFIG_LOG_CATEGORY_ALL

◆ LogPrintFormat

Configures the format to print diagnostic information.

Enumerator
Default 

Print message, method name, category, log level 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, category, log level, 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

◆ LogFacility

A number that identifies the source of a log message.

The full documentation is available in the C API: DDS_LogFacility

Enumerator
User 

A log message produced by the user's application.

The full documentation is available in the C API: DDS_LogFacility_NDDS_CONFIG_LOG_FACILITY_USER

SecurityEvent 

A security event logged with the RTI Security Plugins Logging Plugin.

The full documentation is available in the C API: DDS_LogFacility_NDDS_CONFIG_LOG_FACILITY_SECURITY_EVENT

Service 

A log message produced by an Infrastructure Service.

The full documentation is available in the C API: DDS_LogFacility_NDDS_CONFIG_LOG_FACILITY_SERVICE

Middleware 

A log message produced by Connext.

The full documentation is available in the C API: DDS_LogFacility_NDDS_CONFIG_LOG_FACILITY_MIDDLEWARE

Function Documentation

◆ MessageLoggedEventHandler()

delegate void Rti.Config.MessageLoggedEventHandler ( LogMessage  message)

Event handler for Logger.MessageLogged.