diff -r 92e482410453 -r d345541018fa docs/api-2.1/structUcxLogger.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/api-2.1/structUcxLogger.html Sat Feb 06 19:11:44 2021 +0100 @@ -0,0 +1,213 @@ + + + + + + + +ucx: UcxLogger Struct Reference + + + + + + + + + +
+
+ + + + + + + +
+
ucx +
+
UAP Common Extensions
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Data Fields
+
+
UcxLogger Struct Reference
+
+
+ +

The UCX Logger object. + More...

+ +

#include <logging.h>

+ + + + + + + + + + + + + + + + + + + + +

+Data Fields

void * stream
 The stream this logger writes its messages to. More...
 
write_func writer
 The write function that shall be used. More...
 
char * dateformat
 The date format for timestamp outputs including the delimiter (default: "%F %T %z "). More...
 
unsigned int level
 The level, this logger operates on. More...
 
unsigned int mask
 A configuration mask for automatic output. More...
 
UcxMap * levels
 A map of valid log levels for this logger. More...
 
+

Detailed Description

+

The UCX Logger object.

+

Field Documentation

+ +

◆ dateformat

+ +
+
+ + + + +
char* UcxLogger::dateformat
+
+ +

The date format for timestamp outputs including the delimiter (default: "%F %T %z ").

+
See also
UCX_LOGGER_TIMESTAMP
+ +
+
+ +

◆ level

+ +
+
+ + + + +
unsigned int UcxLogger::level
+
+ +

The level, this logger operates on.

+

If a log command is issued, the message will only be logged, if the log level of the message is less or equal than the log level of the logger.

+ +
+
+ +

◆ levels

+ +
+
+ + + + +
UcxMap* UcxLogger::levels
+
+ +

A map of valid log levels for this logger.

+

The keys represent all valid log levels and the values provide string representations, that are used, if the UCX_LOGGER_LEVEL flag is set.

+

The exact data types are unsigned int for the key and const char* for the value.

+
See also
UCX_LOGGER_LEVEL
+ +
+
+ +

◆ mask

+ +
+
+ + + + +
unsigned int UcxLogger::mask
+
+ +

A configuration mask for automatic output.

+

For each flag that is set, the logger automatically outputs some extra information like the timestamp or the source file and line number. See the documentation for the flags for details.

+ +
+
+ +

◆ stream

+ +
+
+ + + + +
void* UcxLogger::stream
+
+ +

The stream this logger writes its messages to.

+ +
+
+ +

◆ writer

+ +
+
+ + + + +
write_func UcxLogger::writer
+
+ +

The write function that shall be used.

+

For standard file or stdout loggers this might be standard fwrite (default).

+ +
+
+
The documentation for this struct was generated from the following file: +
+ +
+Generated on Thu Dec 19 2019 19:58:24 for ucx by   +doxygen + 1.8.13 +
+ +