Log API

OSAPI Log API. More...

Classes
struct	OSAPI_LogProperty
	Configuration of logging functionality. More...

Macros
#define	OSAPI_LOG_DETAIL_MODULENAME   (0x80000000UL)
	Bitmap for enabling saving the module name in the log buffer.
#define	OSAPI_LOG_DETAIL_SOURCEFILE   (0x40000000UL)
	Bitmap for enabling saving the file name in the log buffer.
#define	OSAPI_LOG_DETAIL_LINENUMBER   (0x20000000UL)
	Bitmap for enabling saving the line number in the log buffer.
#define	OSAPI_LOG_DETAIL_FUNCTIONAME   (0x10000000UL)
	Bitmap for enabling saving the function name in the log buffer.
#define	OSAPI_LOG_DETAIL_DATA_ONLY   (0x04000000UL)
	Bitmap for enabling additional log details.
#define	OSAPI_LOG_DETAIL_ALL
	Bitmap enabling all log detail fields.
#define	OSAPI_LOG_DETAIL_NO_DATA
	Bitmap enabling all log detail fields except data.
#define	OSAPI_LogProperty_INITIALIZER
	Initializer for the OSAPI_LogProperty.

Typedefs
typedef void(*	OSAPI_Log_write_buffer_T) (const char *buffer, RTI_SIZE_T length)
	Optional user-defined function to output a log/trace buffer.
typedef void(*	OSAPI_LogHandler_T) (void *param, OSAPI_LogEntry_T *entry)
	Optional user-defined function for processing new log messages.

Enumerations
enum	OSAPI_LogVerbosity_T { OSAPI_LOG_VERBOSITY_SILENT = 0 , OSAPI_LOG_VERBOSITY_ERROR = 1 , OSAPI_LOG_VERBOSITY_WARNING = 2 , OSAPI_LOG_VERBOSITY_DEBUG = 3 }
	Logging verbosity. More...

Functions
RTI_INT32	OSAPI_Log_get_last_error_code (void)
	Returns the error code for a function that failed.

Detailed Description

OSAPI Log API.

Macro Definition Documentation

OSAPI_LOG_DETAIL_MODULENAME

#define OSAPI_LOG_DETAIL_MODULENAME   (0x80000000UL)

Bitmap for enabling saving the module name in the log buffer.

See Also OSAPI_LogProperty::log_detail

OSAPI_LOG_DETAIL_SOURCEFILE

#define OSAPI_LOG_DETAIL_SOURCEFILE   (0x40000000UL)

Bitmap for enabling saving the file name in the log buffer.

See Also OSAPI_LogProperty::log_detail

OSAPI_LOG_DETAIL_LINENUMBER

#define OSAPI_LOG_DETAIL_LINENUMBER   (0x20000000UL)

Bitmap for enabling saving the line number in the log buffer.

See Also OSAPI_LogProperty::log_detail

OSAPI_LOG_DETAIL_FUNCTIONAME

#define OSAPI_LOG_DETAIL_FUNCTIONAME   (0x10000000UL)

Bitmap for enabling saving the function name in the log buffer.

See Also OSAPI_LogProperty::log_detail

OSAPI_LOG_DETAIL_DATA_ONLY

#define OSAPI_LOG_DETAIL_DATA_ONLY   (0x04000000UL)

Bitmap for enabling additional log details.

See Also OSAPI_LogProperty::log_detail

OSAPI_LOG_DETAIL_ALL

#define OSAPI_LOG_DETAIL_ALL

Value:

        (OSAPI_LOG_DETAIL_MODULENAME | \
         OSAPI_LOG_DETAIL_SOURCEFILE | \
         OSAPI_LOG_DETAIL_LINENUMBER | \
         OSAPI_LOG_DETAIL_FUNCTIONAME | \
         OSAPI_LOG_DETAIL_FORMAT | \
         OSAPI_LOG_DETAIL_DATA_ONLY)

Bitmap enabling all log detail fields.

See Also OSAPI_LogProperty::log_detail

OSAPI_LOG_DETAIL_NO_DATA

#define OSAPI_LOG_DETAIL_NO_DATA

Value:

        (OSAPI_LOG_DETAIL_MODULENAME | \
         OSAPI_LOG_DETAIL_SOURCEFILE | \
         OSAPI_LOG_DETAIL_LINENUMBER | \
         OSAPI_LOG_DETAIL_FUNCTIONAME )

Bitmap enabling all log detail fields except data.

See Also OSAPI_LogProperty::log_detail

OSAPI_LogProperty_INITIALIZER

#define OSAPI_LogProperty_INITIALIZER

Value:

{\
    OSAPI_LOG_BUFFER_SIZE,\
    OSAPI_LOG_DETAIL_ALL,\
    NULL\
}

Initializer for the OSAPI_LogProperty.

Typedef Documentation

OSAPI_Log_write_buffer_T

typedef void(* OSAPI_Log_write_buffer_T) (const char *buffer, RTI_SIZE_T length)

Optional user-defined function to output a log/trace buffer.

The handler is set by ::OSAPI_Log::set_property.

Parameters

buffer	<<in>> Pointer to buffer with log to write
length	<<in>> Length of the buffer to write

OSAPI_LogHandler_T

typedef void(* OSAPI_LogHandler_T) (void *param, OSAPI_LogEntry_T *entry)

Optional user-defined function for processing new log messages.

Definition of a function that can be installed with the logger and that will be called for each new log event.

The handler is set by OSAPI_Log_set_log_handler().

The function is called while holding a global lock.

When called, provides parameters containing the raw log entry and additional optional information.

Parameters

[in]	param	User-defined parameter
[in]	entry	Log entry

Enumeration Type Documentation

OSAPI_LogVerbosity_T

enum OSAPI_LogVerbosity_T

Logging verbosity.

Enumerator
OSAPI_LOG_VERBOSITY_SILENT	Logs are not written.
OSAPI_LOG_VERBOSITY_ERROR	Only error logs are written.
OSAPI_LOG_VERBOSITY_WARNING	Error and warning logs are written.
OSAPI_LOG_VERBOSITY_DEBUG	All logs are written.

Function Documentation

OSAPI_Log_get_last_error_code()

RTI_INT32 OSAPI_Log_get_last_error_code

(

void

)

Returns the error code for a function that failed.

Many functions returns RTI_FALSE or NULL on failure. In order to provide additional information about reason for the failure fucntions may set an additional error code. This function returns the last error-code recorded for the calling thread.

Returns

Last error-code recorded for this thread

References RTI_INT32, RTI_INT64, and RTI_UINT32.