Configuration Utilities

Utility API's independent of the DDS standard. More...

Classes
struct	NDDS::Config_LibraryVersion_t
	The version of a single library shipped as part of an RTI Connext distribution. More...
class	NDDS::ConfigVersion
	<<interface>> The version of an RTI Connext distribution. More...
class	NDDS::LogMessage
	Log message. More...
class	NDDS::LoggerDevice
	<<interface>> Logging device interface. Use for user-defined logging devices. More...
class	NDDS::ConfigLogger
	<<interface>> The singleton type used to configure RTI Connext logging. More...

Enumerations
enum	NDDS::LogVerbosity : UINT32 {   NDDS::LogVerbosity::NDDS_CONFIG_LOG_VERBOSITY_SILENT,   NDDS::LogVerbosity::NDDS_CONFIG_LOG_VERBOSITY_ERROR,   NDDS::LogVerbosity::NDDS_CONFIG_LOG_VERBOSITY_WARNING,   NDDS::LogVerbosity::NDDS_CONFIG_LOG_VERBOSITY_STATUS_LOCAL,   NDDS::LogVerbosity::NDDS_CONFIG_LOG_VERBOSITY_STATUS_REMOTE,   NDDS::LogVerbosity::NDDS_CONFIG_LOG_VERBOSITY_STATUS_ALL }
	The verbosities at which RTI Connext diagnostic information is logged. More...
enum	NDDS::LogLevel : UINT32 {   NDDS::LogLevel::NDDS_CONFIG_LOG_LEVEL_ERROR,   NDDS::LogLevel::NDDS_CONFIG_LOG_LEVEL_WARNING,   NDDS::LogLevel::NDDS_CONFIG_LOG_LEVEL_STATUS_LOCAL,   NDDS::LogLevel::NDDS_CONFIG_LOG_LEVEL_STATUS_REMOTE,   NDDS::LogLevel::NDDS_CONFIG_LOG_LEVEL_DEBUG }
	Level category assigned to RTI Connext log messages returned to an output device. More...
enum	NDDS::LogCategory : UINT32 {   NDDS::LogCategory::NDDS_CONFIG_LOG_CATEGORY_PLATFORM,   NDDS::LogCategory::NDDS_CONFIG_LOG_CATEGORY_COMMUNICATION,   NDDS::LogCategory::NDDS_CONFIG_LOG_CATEGORY_DATABASE,   NDDS::LogCategory::NDDS_CONFIG_LOG_CATEGORY_ENTITIES,   NDDS::LogCategory::NDDS_CONFIG_LOG_CATEGORY_API,   NDDS::LogCategory::NDDS_CONFIG_LOG_CATEGORY_ALL }
	Categories of logged messages. More...
enum	NDDS::LogPrintFormat : UINT32 { ,   NDDS::LogPrintFormat::NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT,   NDDS::LogPrintFormat::NDDS_CONFIG_LOG_PRINT_FORMAT_TIMESTAMPED,   NDDS::LogPrintFormat::NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE,   NDDS::LogPrintFormat::NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE_TIMESTAMPED,   NDDS::LogPrintFormat::NDDS_CONFIG_LOG_PRINT_FORMAT_DEBUG,   NDDS::LogPrintFormat::NDDS_CONFIG_LOG_PRINT_FORMAT_MINIMAL,   NDDS::LogPrintFormat::NDDS_CONFIG_LOG_PRINT_FORMAT_MAXIMAL }
	The format used to output RTI Connext diagnostic information. More...

Functions
public delegate System::Int32	NDDS::LogCallbackDelegate (System::String^ msg)

Detailed Description

Utility API's independent of the DDS standard.

Enumeration Type Documentation

LogVerbosity

enum NDDS::LogVerbosity : UINT32

strong

The verbosities at which RTI Connext diagnostic information is logged.

Enumerator
NDDS_CONFIG_LOG_VERBOSITY_SILENT	No further output will be logged.
NDDS_CONFIG_LOG_VERBOSITY_ERROR	Only error messages will be logged. An error indicates something wrong in the functioning of RTI Connext. The most common cause of errors is incorrect configuration.
NDDS_CONFIG_LOG_VERBOSITY_WARNING	Both error and warning messages will be logged. A warning indicates that RTI Connext is taking an action that may or may not be what you intended. Some configuration information is also logged at this verbosity to aid in debugging.
NDDS_CONFIG_LOG_VERBOSITY_STATUS_LOCAL	Errors, warnings, and verbose information about the lifecycles of local RTI Connext objects will be logged.
NDDS_CONFIG_LOG_VERBOSITY_STATUS_REMOTE	Errors, warnings, and verbose information about the lifecycles of remote RTI Connext objects will be logged.
NDDS_CONFIG_LOG_VERBOSITY_STATUS_ALL	Errors, warnings, verbose information about the lifecycles of local and remote RTI Connext objects, and periodic information about RTI Connext threads will be logged.

LogLevel

enum NDDS::LogLevel : UINT32

strong

Level category assigned to RTI Connext log messages returned to an output device.

Enumerator
NDDS_CONFIG_LOG_LEVEL_ERROR	The message describes an error. An error indicates something wrong in the functioning of RTI Connext. The most common cause of errors is incorrect configuration.
NDDS_CONFIG_LOG_LEVEL_WARNING	The message describes a warning. A warning indicates that RTI Connext is taking an action that may or may not be what you intended. Some configuration information is also logged at this verbosity to aid in debugging.
NDDS_CONFIG_LOG_LEVEL_STATUS_LOCAL	The message contains info about the lifecycles of local RTI Connext objects will be logged.
NDDS_CONFIG_LOG_LEVEL_STATUS_REMOTE	The message contains info about the lifecycles of remote RTI Connext objects will be logged.
NDDS_CONFIG_LOG_LEVEL_DEBUG	The message contains debug info that might be relevant to your application.

LogCategory

enum NDDS::LogCategory : UINT32

strong

Categories of logged messages.

The NDDS::ConfigLogger::get_verbosity_by_category and NDDS::ConfigLogger::set_verbosity_by_category can be used to specify different verbosities for different categories of messages.

Enumerator
NDDS_CONFIG_LOG_CATEGORY_PLATFORM	Log messages pertaining to the underlying platform (hardware and OS) on which RTI Connext is running are in this category.
NDDS_CONFIG_LOG_CATEGORY_COMMUNICATION	Log messages pertaining to data serialization and deserialization and network traffic are in this category.
NDDS_CONFIG_LOG_CATEGORY_DATABASE	Log messages pertaining to the internal database in which RTI Connext objects are stored are in this category.
NDDS_CONFIG_LOG_CATEGORY_ENTITIES	Log messages pertaining to local and remote entities and to the discovery process are in this category.
NDDS_CONFIG_LOG_CATEGORY_API	Log messages pertaining to the API layer of RTI Connext (such as method argument validation) are in this category.
NDDS_CONFIG_LOG_CATEGORY_ALL	Log messages pertaining to all category of RTI Connext.

LogPrintFormat

enum NDDS::LogPrintFormat : UINT32

strong

The format used to output RTI Connext diagnostic information.

Enumerator
NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT	Print message, method name, and activity context (default).
NDDS_CONFIG_LOG_PRINT_FORMAT_TIMESTAMPED	Print message, method name, activity context, and timestamp.
NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE	Print message with all available context information (includes thread identifier, activity context).
NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE_TIMESTAMPED	Print message with all available context information, and timestamp.
NDDS_CONFIG_LOG_PRINT_FORMAT_DEBUG	Print a set of field that may be useful for internal debug.
NDDS_CONFIG_LOG_PRINT_FORMAT_MINIMAL	Print only message number and method name.
NDDS_CONFIG_LOG_PRINT_FORMAT_MAXIMAL	Print all available fields.

Function Documentation

LogCallbackDelegate()

public delegate System::Int32 NDDS::LogCallbackDelegate

(

System::String^

msg

)

Delegate for handling log messages

See also

NDDS::ConfigLogger::set_log_delegate

Referenced by NDDS::ConfigLogger::get_instance().