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 |
Public Member Functions
- virtual void message( Message_severity level, const char* module_category, const char* message)
- Emits a message to the application's log. More...
- virtual void message( Message_severity level, const char* module_category, const Message_details&, 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) [inline, 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:Severity mi::base::details::MESSAGE_SEVERITY_FATAL indicates that the caller is unable to recover from the error condition. Therefore, the process will be terminated after a fatal log message has been delivered. To avoid the process termination logger implementations might choose not to return from this method for fatal log messages. 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.
- virtual void mi::base::ILogger::message( Message_severity level, const char* module_category, const Message_details&, const char* message) [pure virtual]
-
Emits a message to the application's log. This overload receives additional details which applications may use to react to certain events.
- 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:Severity mi::base::details::MESSAGE_SEVERITY_FATAL indicates that the caller is unable to recover from the error condition. Therefore, the process will be terminated after a fatal log message has been delivered. To avoid the process termination logger implementations might choose not to return from this method for fatal log messages. 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 1023 characters.