neuray API Programmer's Manual

mi::base::ILogger Class Reference

[Logging]

Description

The ILogger interface class supports logging of messages. Plugins based on mi::base::Plugin are provided with a logger, such that plugins can be written to use the same message log as the host application.

Different APIs allow to register your own implementation of a logger to override their internal implementation. Note that in such case the object implementing this interface shall not be created on the stack, since this might lead to premature destruction of such instances while still being in use by the API.

The following message categories are used in some APIs. There might be other, undocumented categories.

category

purpose

"DATABASE"

database

"DISK"

raw disk I/O, swapping

"GEOMETRY"

geometry processing, e.g., tessellation

"IMAGE"

texture processing, image and video plugins

"IO"

scene data import and export

"MAIN"

reserved for the application itself

"MISC"

other

"MEMORY"

memory management

"NETWORK"

networking

"PLUGIN"

plugins (unless other categories fit better)

"RENDER"

rendering

mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

virtual void message( Message_severity level, const char* module_category, const char* message) =0
Emits a message to the application's log. More...
void printf( Message_severity level, const char* module_category, const char* message, ...)
Emits a message to the application's log. More...

Member Functions

virtual void mi::​base::​ILogger::message( Message_severity level, const char* module_category, const char* message) [pure virtual]

Emits a message to the application's log. The application can decide to output the message to any channel or to drop it.

This function can be called at any time from any thread, including concurrent calls from several threads at the same time.

Note:

Log messages with severity mi::base::MESSAGE_SEVERITY_FATAL terminate the process after the log message has been delivered. This severity should only be used in exceptional cases.

Parameters

level
The log level which specifies the severity of the message.
module_category
The module and the category which specify the origin and the functional area of this message. The format of string parameter is "module:category". Both names are optional. The module name must not contain any colons. See above for valid category names.
message
The log message.
void mi::​base::​ILogger::printf( Message_severity level, const char* module_category, const char* message, ...) [inline]

Emits a message to the application's log. The application can decide to output the message to any channel or to drop it.

This function can be called at any time from any thread, including concurrent calls from several threads at the same time.

Note:

Log messages with severity mi::base::MESSAGE_SEVERITY_FATAL terminate the process after the log message has been delivered. This severity should only be used in exceptional cases.

Parameters

level
The log level which specifies the severity of the message.
module_category
The module and the category which specify the origin and the functional area of this message. The format of string parameter is "module:category". Both names are optional. The module name must not contain any colons. See above for valid category names.
message
The log message using printf()-like format specifiers, followed by matching arguments. The formatted message is limited to 1024 characters.