RTI Cloud Discovery Service  Version 6.1.1
Logging

Provides control over the logging facilities for RTI Cloud Discovery Service. More...

Macros

#define CDS_SUBMODULE_MASK_COMMON   (0x0002)
 
#define CDS_SUBMODULE_MASK_CONFIG   (0x0004)
 
#define CDS_SUBMODULE_MASK_ADAPTERS   (0x0008)
 
#define CDS_SUBMODULE_MASK_PROCESSORS   (0x0010)
 
#define CDS_SUBMODULE_MASK_MONITORING   (0x0012)
 
#define CDS_SUBMODULE_MASK_SERVICE   (0x0020)
 
#define CDS_SUBMODULE_MASK_SERVICEAPP   (0x0040)
 
#define CDS_SUBMODULE_MASK_SERVICELIB   (0x0060)
 
#define CDS_SUBMODULE_MASK_ALL   (0xFFFF)
 

Functions

void CDSLog_setVerbosity (RTILogBitmap submoduleMask, int verbosity)
 
void CDSLog_setBitmaps (RTILogBitmap submoduleMask, RTILogBitmap instrumentationMask)
 
void CDSLog_getBitmaps (RTILogBitmap *submoduleMask, RTILogBitmap *instrumentationMask)
 
void RTI_CDS_Logger_log (NDDS_Config_LogLevel log_level, const char *format,...)
 Logs a message with the specified level within the running instance of RTI Cloud Discovery Service. The message will be printed under the log of the currently executing RTI Cloud Discovery Service, if the instance was started with log_level or higher verbosity. More...
 

Variables

const int RTI_CDS_LOG_VERBOSITY_DEBUG
 Log verbosity level: exceptions + warnings + info + periodic + content. More...
 
const int RTI_CDS_LOG_VERBOSITY_ALL
 Log verbosity level: exceptions + warnings + info + periodic. More...
 
const int RTI_CDS_LOG_VERBOSITY_INFO
 Log verbosity level: exceptions + warnings + info. More...
 
const int RTI_CDS_LOG_VERBOSITY_WARNINGS
 Log verbosity level: exceptions + warnings. More...
 

Detailed Description

Provides control over the logging facilities for RTI Cloud Discovery Service.

Macro Definition Documentation

◆ CDS_SUBMODULE_MASK_COMMON

#define CDS_SUBMODULE_MASK_COMMON   (0x0002)

Mask for turning on logging for only the common submodule

◆ CDS_SUBMODULE_MASK_CONFIG

#define CDS_SUBMODULE_MASK_CONFIG   (0x0004)

Mask for turning on logging for only the config submodule

◆ CDS_SUBMODULE_MASK_ADAPTERS

#define CDS_SUBMODULE_MASK_ADAPTERS   (0x0008)

Mask for turning on logging for only the adapter submodule

◆ CDS_SUBMODULE_MASK_PROCESSORS

#define CDS_SUBMODULE_MASK_PROCESSORS   (0x0010)

Mask for turning on logging for only the processor submodule

◆ CDS_SUBMODULE_MASK_MONITORING

#define CDS_SUBMODULE_MASK_MONITORING   (0x0012)

Mask for turning on logging for only the monitoring submodule

◆ CDS_SUBMODULE_MASK_SERVICE

#define CDS_SUBMODULE_MASK_SERVICE   (0x0020)

Mask for turning on logging for only the service submodule

◆ CDS_SUBMODULE_MASK_SERVICEAPP

#define CDS_SUBMODULE_MASK_SERVICEAPP   (0x0040)

Mask for turning on logging for only the service app submodule

◆ CDS_SUBMODULE_MASK_SERVICELIB

#define CDS_SUBMODULE_MASK_SERVICELIB   (0x0060)

Mask for turning on logging for only the service lib submodule

◆ CDS_SUBMODULE_MASK_ALL

#define CDS_SUBMODULE_MASK_ALL   (0xFFFF)

Mask for turning on logging for all submodules

Function Documentation

◆ CDSLog_setVerbosity()

void CDSLog_setVerbosity ( RTILogBitmap  submoduleMask,
int  verbosity 
)

Sets the log verbosity.

◆ CDSLog_setBitmaps()

void CDSLog_setBitmaps ( RTILogBitmap  submoduleMask,
RTILogBitmap  instrumentationMask 
)

Sets a bitmap indicating which modules to log and the instrumentation to use.

◆ CDSLog_getBitmaps()

void CDSLog_getBitmaps ( RTILogBitmap *  submoduleMask,
RTILogBitmap *  instrumentationMask 
)

Gets bitmap for current modules being logged and the instrumentation being used.

◆ RTI_CDS_Logger_log()

void RTI_CDS_Logger_log ( NDDS_Config_LogLevel  log_level,
const char *  format,
  ... 
)

Logs a message with the specified level within the running instance of RTI Cloud Discovery Service. The message will be printed under the log of the currently executing RTI Cloud Discovery Service, if the instance was started with log_level or higher verbosity.

The message is specified with a format and a format parameter, in a similar fashion to the standard C printf() operation.

The generated log will be part of logging stream of the running RTI Cloud Discovery Service, if the log_level is part of the configured verbosity. The result log message may include additional information according to the Connext logging configuration, such as Advlog Context, thread ID, line number, etc. Additionally, the result log message will contain a newline character at the end, so the format does not need to contain it.

Parameters
[in]log_levelLog level associated to the message
[in]formatmessage format specification
[in]...variablelength argument (stdarg)

Variable Documentation

◆ RTI_CDS_LOG_VERBOSITY_DEBUG

const int RTI_CDS_LOG_VERBOSITY_DEBUG

Log verbosity level: exceptions + warnings + info + periodic + content.

◆ RTI_CDS_LOG_VERBOSITY_ALL

const int RTI_CDS_LOG_VERBOSITY_ALL

Log verbosity level: exceptions + warnings + info + periodic.

◆ RTI_CDS_LOG_VERBOSITY_INFO

const int RTI_CDS_LOG_VERBOSITY_INFO

Log verbosity level: exceptions + warnings + info.

◆ RTI_CDS_LOG_VERBOSITY_WARNINGS

const int RTI_CDS_LOG_VERBOSITY_WARNINGS

Log verbosity level: exceptions + warnings.