RTI Connext C++ API
Version 5.1.0
|
<<interface>> The singleton type used to configure RTI Connext logging. More...
Public Member Functions | |
NDDS_Config_LogVerbosity | get_verbosity () |
Get the verbosity at which RTI Connext is currently logging diagnostic information. | |
NDDS_Config_LogVerbosity | get_verbosity_by_category (NDDS_Config_LogCategory category) |
Get the verbosity at which RTI Connext is currently logging diagnostic information in the given category. | |
void | set_verbosity (NDDS_Config_LogVerbosity verbosity) |
Set the verbosity at which RTI Connext will log diagnostic information. | |
void | set_verbosity_by_category (NDDS_Config_LogCategory category, NDDS_Config_LogVerbosity verbosity) |
Set the verbosity at which RTI Connext will log diagnostic information in the given category. | |
FILE * | get_output_file () |
Get the file to which the logged output is redirected. | |
bool | set_output_file (FILE *out) |
Set the file to which the logged output is redirected. | |
NDDSConfigLoggerDevice * | get_output_device () |
Return the user device registered with the logger. | |
bool | set_output_device (NDDSConfigLoggerDevice *device) |
Register a NDDSConfigLoggerDevice. | |
NDDS_Config_LogPrintFormat | get_print_format () |
Get the current message format that RTI Connext is using to log diagnostic information. | |
bool | set_print_format (NDDS_Config_LogPrintFormat print_format) |
Set the message format that RTI Connext will use to log diagnostic information. | |
Static Public Member Functions | |
static NDDSConfigLogger * | get_instance () |
Get the singleton instance of this type. | |
static void | finalize_instance () |
Finalize the singleton instance of this type. | |
<<interface>> The singleton type used to configure RTI Connext logging.
|
static |
Get the singleton instance of this type.
|
static |
Finalize the singleton instance of this type.
NDDS_Config_LogVerbosity NDDSConfigLogger::get_verbosity | ( | ) |
Get the verbosity at which RTI Connext is currently logging diagnostic information.
The default verbosity if ::DDSLogger::set_verbosity is never called is ::DDS_NDDS_CONFIG_LOG_VERBOSITY_ERROR.
If ::DDSLogger::set_verbosity_by_category has been used to set different verbosities for different categories of messages, this method will return the maximum verbosity of all categories.
NDDS_Config_LogVerbosity NDDSConfigLogger::get_verbosity_by_category | ( | NDDS_Config_LogCategory | category | ) |
Get the verbosity at which RTI Connext is currently logging diagnostic information in the given category.
The default verbosity if ::DDSLogger::set_verbosity and ::DDSLogger::set_verbosity_by_category are never called is ::DDS_NDDS_CONFIG_LOG_VERBOSITY_ERROR.
void NDDSConfigLogger::set_verbosity | ( | NDDS_Config_LogVerbosity | verbosity | ) |
Set the verbosity at which RTI Connext will log diagnostic information.
Note: Logging at high verbosities will be detrimental to your application's performance. Your default setting should typically remain at ::DDS_NDDS_CONFIG_LOG_VERBOSITY_WARNING or below. (The default verbosity if you never set it is ::DDS_NDDS_CONFIG_LOG_VERBOSITY_ERROR.)
void NDDSConfigLogger::set_verbosity_by_category | ( | NDDS_Config_LogCategory | category, |
NDDS_Config_LogVerbosity | verbosity | ||
) |
Set the verbosity at which RTI Connext will log diagnostic information in the given category.
FILE* NDDSConfigLogger::get_output_file | ( | ) |
Get the file to which the logged output is redirected.
If no output file has been registered through ::DDSLogger::set_output_file, this method will return NULL. In this case, logged output will on most platforms go to standard out as if through printf.
bool NDDSConfigLogger::set_output_file | ( | FILE * | out | ) |
Set the file to which the logged output is redirected.
The file passed may be NULL, in which case further logged output will be redirected to the platform-specific default output location (standard out on most platforms).
NDDSConfigLoggerDevice* NDDSConfigLogger::get_output_device | ( | ) |
Return the user device registered with the logger.
bool NDDSConfigLogger::set_output_device | ( | NDDSConfigLoggerDevice * | device | ) |
Register a NDDSConfigLoggerDevice.
Register the specified logging device with the logger.
There can be at most only one device registered with the logger at any given time.
When a device is installed, the logger will stop sending the log messages to the standard output and to the file set with ::DDSLogger::set_output_file.
To remove an existing device, use this method with NULL as the device parameter. After a device is removed the logger will continue sending log messages to the standard output and to the output file.
To replace an existing device with a new device, use this method providing the new device as the device parameter.
When a device is unregistered (by setting it to NULL), NDDSConfigLoggerDevice calls the method NDDSConfigLoggerDevice::close.
device | <<in>> Logging device. |
NDDS_Config_LogPrintFormat NDDSConfigLogger::get_print_format | ( | ) |
Get the current message format that RTI Connext is using to log diagnostic information.
If ::DDSLogger::set_print_format is never called, the default format is ::DDS_NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT.
bool NDDSConfigLogger::set_print_format | ( | NDDS_Config_LogPrintFormat | print_format | ) |
Set the message format that RTI Connext will use to log diagnostic information.