docs/api-2.1/logging_8h_source.html

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *
  *   1. Redistributions of source code must retain the above copyright
  *      notice, this list of conditions and the following disclaimer.
  *
  *   2. Redistributions in binary form must reproduce the above copyright
  *      notice, this list of conditions and the following disclaimer in the
  *      documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
 #ifndef UCX_LOGGING_H
 #define UCX_LOGGING_H

 #include "ucx.h"
 #include "map.h"
 #include "string.h"
 #include <stdio.h>

 #ifdef __cplusplus
 extern "C" {
 #endif

 /* leave enough space for custom log levels */

 #define UCX_LOGGER_ERROR        0x00

 #define UCX_LOGGER_WARN         0x10

 #define UCX_LOGGER_INFO         0x20

 #define UCX_LOGGER_DEBUG        0x30

 #define UCX_LOGGER_TRACE        0x40

 #define UCX_LOGGER_LEVEL        0x01

 #define UCX_LOGGER_TIMESTAMP    0x02

 #define UCX_LOGGER_SOURCE       0x04

 typedef struct {
     void *stream;

     write_func writer;

     char *dateformat;

     unsigned int level;

     unsigned int mask;

     UcxMap* levels;
 } UcxLogger;

 UcxLogger *ucx_logger_new(void *stream, unsigned int level, unsigned int mask);

 void ucx_logger_free(UcxLogger* logger);

 void ucx_logger_logf(UcxLogger *logger, unsigned int level, const char* file,
         const unsigned int line, const char* format, ...);

 #define ucx_logger_register_level(logger, level, name) {\
         unsigned int l; \
             l = level; \
             ucx_map_int_put(logger->levels, l, (void*) "[" name "]"); \
         } while (0);

 #define ucx_logger_log(logger, level, ...) \
     ucx_logger_logf(logger, level, __FILE__, __LINE__, __VA_ARGS__)

 #define ucx_logger_error(logger, ...) \
     ucx_logger_log(logger, UCX_LOGGER_ERROR, __VA_ARGS__)

 #define ucx_logger_info(logger, ...) \
     ucx_logger_log(logger, UCX_LOGGER_INFO, __VA_ARGS__)

 #define ucx_logger_warn(logger, ...) \
     ucx_logger_log(logger, UCX_LOGGER_WARN, __VA_ARGS__)

 #define ucx_logger_debug(logger, ...) \
     ucx_logger_log(logger, UCX_LOGGER_DEBUG, __VA_ARGS__)

 #define ucx_logger_trace(logger, ...) \
     ucx_logger_log(logger, UCX_LOGGER_TRACE, __VA_ARGS__)

 #ifdef __cplusplus
 }
 #endif

 #endif /* UCX_LOGGING_H */
UcxLogger::writer
write_func writer
The write function that shall be used.
Definition: logging.h:97

universe@390: string.h
Bounded string implementation.

universe@390: ucx.h
Main UCX Header providing most common definitions.

universe@390: UcxLogger
The UCX Logger object.
Definition: logging.h:88

universe@390: UcxLogger::dateformat
char * dateformat
The date format for timestamp outputs including the delimiter (default: "%F %T %z ")...
Definition: logging.h:104

universe@390: UcxLogger::mask
unsigned int mask
A configuration mask for automatic output.
Definition: logging.h:119

universe@390: ucx_logger_new
UcxLogger * ucx_logger_new(void *stream, unsigned int level, unsigned int mask)
Creates a new logger.
Definition: logging.c:36

universe@390: UcxLogger::stream
void * stream
The stream this logger writes its messages to.
Definition: logging.h:90

universe@390: UcxMap
Structure for the UCX map.
Definition: map.h:81

universe@390: map.h
Hash map implementation.

universe@390: write_func
size_t(* write_func)(const void *, size_t, size_t, void *)
Function pointer to a write function.
Definition: ucx.h:119

universe@390: UcxLogger::levels
UcxMap * levels
A map of valid log levels for this logger.
Definition: logging.h:132

universe@390: UcxLogger::level
unsigned int level
The level, this logger operates on.
Definition: logging.h:111

universe@390: ucx_logger_logf
void ucx_logger_logf(UcxLogger *logger, unsigned int level, const char *file, const unsigned int line, const char *format,...)
Internal log function - use macros instead.
Definition: logging.c:70

universe@390: ucx_logger_free
void ucx_logger_free(UcxLogger *logger)
Destroys the logger.
Definition: logging.c:62

universe@390: