Logging

Contains log/log.hpp and log/ext_log.hpp documentation. More...

Macros
#define	LOG_VERBOSITY_SILENT_NUM   0
	<<Connext Micro>> <<Connext Pro>> LOG_VERBOSITY will be set to LOG_VERBOSITY_SILENT_NUM when RTI_LOG_VERBOSITY is Silent
#define	LOG_VERBOSITY_ERROR_NUM   1
	<<Connext Micro>> <<Connext Pro>> LOG_VERBOSITY will be set to LOG_VERBOSITY_ERROR_NUM when RTI_LOG_VERBOSITY is Error
#define	LOG_VERBOSITY_WARNING_NUM   2
	<<Connext Micro>> <<Connext Pro>> LOG_VERBOSITY will be set to LOG_VERBOSITY_WARNING_NUM when RTI_LOG_VERBOSITY is Warning
#define	LOG_VERBOSITY_INFO_NUM   3
	<<Connext Micro>> <<Connext Pro>> LOG_VERBOSITY will be set to LOG_VERBOSITY_INFO_NUM when RTI_LOG_VERBOSITY is Info
#define	LOG_VERBOSITY_DEBUG_NUM   4
	<<Connext Micro>> <<Connext Pro>> LOG_VERBOSITY will be set to LOG_VERBOSITY_DEBUG_NUM when RTI_LOG_VERBOSITY is Debug
#define	LOG_VERBOSITY_ERROR_STR   "error"
	<<Connext Micro>> <<Connext Pro>> Macro definition for "error"
#define	LOG_VERBOSITY_WARNING_STR   "warning"
	<<Connext Micro>> <<Connext Pro>> Macro definition for "warning"
#define	LOG_VERBOSITY_INFO_STR   "info"
	<<Connext Micro>> <<Connext Pro>> Macro definition for "info"
#define	LOG_VERBOSITY_DEBUG_STR   "debug"
	<<Connext Micro>> <<Connext Pro>> Macro definition for "debug"
#define	Logger_error(methodName_, message_,...)
	<<Connext Micro>> <<Connext Pro>> Logs exception message
#define	Logger_warning(methodName_, message_,...)
	<<Connext Micro>> <<Connext Pro>> Logs warning message
#define	Logger_info(methodName_, message_,...)
	<<Connext Micro>> <<Connext Pro>> Logs info message
#define	Logger_debug(methodName_, message_,...)
	<<Connext Micro>> <<Connext Pro>> Logs debug message
#define	LOG_FILE_DISABLED   0
	<<Connext Micro>> <<Connext Pro>> Indicating disable logging to file.
#define	LOG_FILE_STDOUT   1
	<<Connext Micro>> <<Connext Pro>> Indicating logging to standard output.
#define	LOG_FILE_NAMED   2
	<<Connext Micro>> <<Connext Pro>> Indicating logging to a file with the name of LOG_FILE_NAME.
#define	LOG_FILE_START_TIME   3
	<<Connext Micro>> <<Connext Pro>> Indicating logging to a timestamp-named file.

Functions
void	Logger_print (const char *verbosity, const char *methodName, const char *message,...)
	<<Connext Micro>> <<Connext Pro>> Prints a log message with VERBOSITY to stdout or a file
void	Logger_close ()
	<<Connext Micro>> <<Connext Pro>> Flush and close logger file descriptor

Detailed Description

Contains log/log.hpp and log/ext_log.hpp documentation.

<<Connext Micro>> <<Connext Pro>> Contains the log/log.h and log/ext_log.h documentation

Connext TSS provides a logging mechanism that can be used by applications using Connext TSS headers and linking against the Connext TSS libraries.

The logging output behavior is configured at the time of the Connext TSS build. It is configured by the RTI_TSS_LOG_FILE_TYPE CMake variable, and it is disabled by default (“none”). Support is available for writing to STDOUT, a user-defined file, or a timestamp-named file. All log writing is done using the POSIX write() API. The logger is not thread safe.

The logger is not available and compiled out when built for FACE OS profiles Safety Base or stricter.

Macro Definition Documentation

#define LOG_VERBOSITY_SILENT_NUM   0

<<Connext Micro>> <<Connext Pro>> LOG_VERBOSITY will be set to LOG_VERBOSITY_SILENT_NUM when RTI_LOG_VERBOSITY is Silent

#define LOG_VERBOSITY_ERROR_NUM   1

<<Connext Micro>> <<Connext Pro>> LOG_VERBOSITY will be set to LOG_VERBOSITY_ERROR_NUM when RTI_LOG_VERBOSITY is Error

#define LOG_VERBOSITY_WARNING_NUM   2

<<Connext Micro>> <<Connext Pro>> LOG_VERBOSITY will be set to LOG_VERBOSITY_WARNING_NUM when RTI_LOG_VERBOSITY is Warning

#define LOG_VERBOSITY_INFO_NUM   3

<<Connext Micro>> <<Connext Pro>> LOG_VERBOSITY will be set to LOG_VERBOSITY_INFO_NUM when RTI_LOG_VERBOSITY is Info

#define LOG_VERBOSITY_DEBUG_NUM   4

<<Connext Micro>> <<Connext Pro>> LOG_VERBOSITY will be set to LOG_VERBOSITY_DEBUG_NUM when RTI_LOG_VERBOSITY is Debug

#define LOG_VERBOSITY_ERROR_STR   "error"

<<Connext Micro>> <<Connext Pro>> Macro definition for "error"

#define LOG_VERBOSITY_WARNING_STR   "warning"

<<Connext Micro>> <<Connext Pro>> Macro definition for "warning"

#define LOG_VERBOSITY_INFO_STR   "info"

<<Connext Micro>> <<Connext Pro>> Macro definition for "info"

#define LOG_VERBOSITY_DEBUG_STR   "debug"

<<Connext Micro>> <<Connext Pro>> Macro definition for "debug"

#define Logger_error	(		methodName_,
			message_,
			...
	)

<<Connext Micro>> <<Connext Pro>> Logs exception message

Parameters

[in]	methodName	Method in which the log message generated from
[in]	message	Unformatted message to be logged as error messages
[in]	...	Optional formats for message

#define Logger_warning	(		methodName_,
			message_,
			...
	)

<<Connext Micro>> <<Connext Pro>> Logs warning message

Parameters

[in]	methodName	Method in which the log message generated from
[in]	message	Unformatted message to be logged as warning messages
[in]	...	Optional formats for message

#define Logger_info	(		methodName_,
			message_,
			...
	)

<<Connext Micro>> <<Connext Pro>> Logs info message

Parameters

[in]	methodName	Method in which the log message generated from
[in]	message	Unformatted message to be logged as info messages
[in]	...	Optional formats for message

#define Logger_debug	(		methodName_,
			message_,
			...
	)

<<Connext Micro>> <<Connext Pro>> Logs debug message

Parameters

[in]	methodName	Method in which the log message generated from
[in]	message	Unformatted message to be logged as debug messages
[in]	...	Optional formats for message

#define LOG_FILE_DISABLED   0

<<Connext Micro>> <<Connext Pro>> Indicating disable logging to file.

LOG_FILE_TYPE will be setted to LOG_FILE_DISABLED if RTI_TSS_LOG_FILE_TYPE is setted to "none"

#define LOG_FILE_STDOUT   1

<<Connext Micro>> <<Connext Pro>> Indicating logging to standard output.

LOG_FILE_TYPE will be setted to LOG_FILE_STDOUT if RTI_TSS_LOG_FILE_TYPE is setted to "stdout" or LOG_FILE_TYPE is undefined

#define LOG_FILE_NAMED   2

<<Connext Micro>> <<Connext Pro>> Indicating logging to a file with the name of LOG_FILE_NAME.

LOG_FILE_TYPE will be setted to LOG_FILE_NAMED if RTI_TSS_LOG_FILE_TYPE is setted to "file". The file name is in LOG_FILE_NAME and "rtifacetss.log" by default.

#define LOG_FILE_START_TIME   3

<<Connext Micro>> <<Connext Pro>> Indicating logging to a timestamp-named file.

LOG_FILE_TYPE will be setted to LOG_FILE_START_TIME if RTI_TSS_LOG_FILE_TYPE is setted to "timestamp".

Function Documentation

void Logger_print	(	const char *	verbosity,
		const char *	methodName,
		const char *	message,
			...
	)

<<Connext Micro>> <<Connext Pro>> Prints a log message with VERBOSITY to stdout or a file

Parameters

[in]	verbosity	Level of verbosity
[in]	methodName	The name of the method that is logging
[in]	message	A string to be logged
[in]	...	Variadic parameters

Prints a log MESSAGE with VERBOSITY level to stdout or a file according to LOG_FILE_TYPE. The log file name is determined by LOG_FILE_NAME Prints a log message with VERBOSITY to stdout or a file

void Logger_close

(

)

<<Connext Micro>> <<Connext Pro>> Flush and close logger file descriptor

Flush and close logger file descriptor