Data Structures | |
struct | NDDS_Config_LibraryVersion_t |
The version of a single library shipped as part of an RTI Data Distribution Service distribution. More... | |
struct | NDDS_Config_Version_t |
<<interface>> The version of an RTI Data Distribution Service distribution. More... | |
struct | NDDS_Config_Logger |
<<interface>> The singleton type used to configure RTI Data Distribution Service 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 Data Distribution Service diagnostic information is logged. 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 } |
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 Data Distribution Service diagnostic information. More... | |
Functions | |
struct DDS_ProductVersion_t * | NDDS_Config_Version_get_product_version (void) |
Get the RTI Data Distribution Service product version. | |
struct NDDS_Config_LibraryVersion_t * | NDDS_Config_Version_get_api_version (void) |
Get the version of the C API library. | |
struct NDDS_Config_LibraryVersion_t * | NDDS_Config_Version_get_core_version (void) |
Get the version of the core library. | |
const char * | NDDS_Config_Version_to_string (void) |
Get this version in string form. | |
NDDS_Config_Logger * | NDDS_Config_Logger_get_instance (void) |
Get the singleton instance of this type. | |
NDDS_Config_LogVerbosity | NDDS_Config_Logger_get_verbosity (const NDDS_Config_Logger *self) |
Get the verbosity at which RTI Data Distribution Service is currently logging diagnostic information. | |
NDDS_Config_LogVerbosity | NDDS_Config_Logger_get_verbosity_by_category (const NDDS_Config_Logger *self, NDDS_Config_LogCategory category) |
Get the verbosity at which RTI Data Distribution Service is currently logging diagnostic information in the given category. | |
void | NDDS_Config_Logger_set_verbosity (NDDS_Config_Logger *self, NDDS_Config_LogVerbosity verbosity) |
Set the verbosity at which RTI Data Distribution Service will log diagnostic information. | |
void | NDDS_Config_Logger_set_verbosity_by_category (NDDS_Config_Logger *self, NDDS_Config_LogCategory category, NDDS_Config_LogVerbosity verbosity) |
Set the verbosity at which RTI Data Distribution Service will log diagnostic information in the given category. | |
FILE * | NDDS_Config_Logger_get_output_file (NDDS_Config_Logger *self) |
Get the file to which the logged output is redirected. | |
DDS_Boolean | NDDS_Config_Logger_set_output_file (NDDS_Config_Logger *self, FILE *out) |
Set the file to which the logged output is redirected. | |
NDDS_Config_LogPrintFormat | NDDS_Config_Logger_get_print_format (const NDDS_Config_Logger *self) |
Get the current message format that RTI Data Distribution Service is using to log diagnostic information. | |
DDS_Boolean | NDDS_Config_Logger_set_print_format (NDDS_Config_Logger *self, NDDS_Config_LogPrintFormat print_format) |
Set the message format that RTI Data Distribution Service will use to log diagnostic information. |
The verbosities at which RTI Data Distribution Service diagnostic information is logged.
Categories of logged messages.
The NDDS_Config_Logger_get_verbosity_by_category and NDDS_Config_Logger_set_verbosity_by_category can be used to specify different verbosities for different categories of messages.
The format used to output RTI Data Distribution Service diagnostic information.
struct DDS_ProductVersion_t* NDDS_Config_Version_get_product_version | ( | void | ) | [read] |
Get the RTI Data Distribution Service product version.
struct NDDS_Config_LibraryVersion_t* NDDS_Config_Version_get_api_version | ( | void | ) | [read] |
Get the version of the C API library.
struct NDDS_Config_LibraryVersion_t* NDDS_Config_Version_get_core_version | ( | void | ) | [read] |
Get the version of the core library.
const char* NDDS_Config_Version_to_string | ( | void | ) |
Get this version in string form.
Combine all of the constituent library versions into a single string.
The memory in which the string is stored in internal to this NDDS_Config_Version_t. The caller should not modify it.
NDDS_Config_Logger* NDDS_Config_Logger_get_instance | ( | void | ) |
Get the singleton instance of this type.
NDDS_Config_LogVerbosity NDDS_Config_Logger_get_verbosity | ( | const NDDS_Config_Logger * | self | ) |
Get the verbosity at which RTI Data Distribution Service is currently logging diagnostic information.
The default verbosity if NDDS_Config_Logger_set_verbosity is never called is DDS_NDDS_CONFIG_LOG_VERBOSITY_ERROR.
If NDDS_Config_Logger_set_verbosity_by_category has been used to set different verbosities for different categories of messages, this function will return the maximum verbosity of all categories.
NDDS_Config_LogVerbosity NDDS_Config_Logger_get_verbosity_by_category | ( | const NDDS_Config_Logger * | self, | |
NDDS_Config_LogCategory | category | |||
) |
Get the verbosity at which RTI Data Distribution Service is currently logging diagnostic information in the given category.
The default verbosity if NDDS_Config_Logger_set_verbosity and NDDS_Config_Logger_set_verbosity_by_category are never called is DDS_NDDS_CONFIG_LOG_VERBOSITY_ERROR.
void NDDS_Config_Logger_set_verbosity | ( | NDDS_Config_Logger * | self, | |
NDDS_Config_LogVerbosity | verbosity | |||
) |
Set the verbosity at which RTI Data Distribution Service 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 NDDS_Config_Logger_set_verbosity_by_category | ( | NDDS_Config_Logger * | self, | |
NDDS_Config_LogCategory | category, | |||
NDDS_Config_LogVerbosity | verbosity | |||
) |
Set the verbosity at which RTI Data Distribution Service will log diagnostic information in the given category.
FILE* NDDS_Config_Logger_get_output_file | ( | NDDS_Config_Logger * | self | ) |
Get the file to which the logged output is redirected.
If no output file has been registered through NDDS_Config_Logger_set_output_file, this function will return NULL. In this case, logged output will on most platforms go to standard out as if through printf.
DDS_Boolean NDDS_Config_Logger_set_output_file | ( | NDDS_Config_Logger * | self, | |
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).
NDDS_Config_LogPrintFormat NDDS_Config_Logger_get_print_format | ( | const NDDS_Config_Logger * | self | ) |
Get the current message format that RTI Data Distribution Service is using to log diagnostic information.
If NDDS_Config_Logger_set_print_format is never called, the default format is DDS_NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT.
DDS_Boolean NDDS_Config_Logger_set_print_format | ( | NDDS_Config_Logger * | self, | |
NDDS_Config_LogPrintFormat | print_format | |||
) |
Set the message format that RTI Data Distribution Service will use to log diagnostic information.