docu/c/kdrive__express__logger_8h_source.html

 //

 // Copyright (c) 2002-2023 WEINZIERL ENGINEERING GmbH

 // All rights reserved.

 //

 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT

 // SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY,

 // WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

 //


 #ifndef __KDRIVE_EXPRESS_LOGGER_H__

 #define __KDRIVE_EXPRESS_LOGGER_H__


 #include "kdrive_express_config.h"


 #define KDRIVE_LOGGER_NONE                      (0)

 #define KDRIVE_LOGGER_FATAL                     (1)

 #define KDRIVE_LOGGER_CRITICAL          (2)

 #define KDRIVE_LOGGER_ERROR                     (3)

 #define KDRIVE_LOGGER_WARNING           (4)

 #define KDRIVE_LOGGER_NOTICE            (5)

 #define KDRIVE_LOGGER_INFORMATION       (6)

 #define KDRIVE_LOGGER_DEBUG                     (7)

 #define KDRIVE_LOGGER_TRACE                     (8)

 #ifdef __cplusplus

 extern "C" {

 #endif


 kdriveExpress_API void kdrive_logger_set_level(uint8_t level);


 kdriveExpress_API void kdrive_logger_console(void);


 kdriveExpress_API void kdrive_logger_file(void);


 kdriveExpress_API void kdrive_logger_file_ex(const char* filename);


 kdriveExpress_API void kdrive_logger_syslog(const char* address, const char* name);


 typedef void(*kdrive_logger_callback)(uint8_t level, const char* message);


 kdriveExpress_API void kdrive_logger_set_callback(kdrive_logger_callback c);


 kdriveExpress_API void kdrive_logger(uint8_t level, const char* message);


 kdriveExpress_API void kdrive_logger_ex(uint8_t level, const char* fmt, ...);


 kdriveExpress_API void kdrive_logger_dump(uint8_t level, const char* message, const void* buffer, uint32_t buffer_len);


 #ifdef __cplusplus

 }

 #endif


 #endif /* __KDRIVE_EXPRESS_LOGGER_H__ */

kdrive_logger
kdriveExpress_API void kdrive_logger(uint8_t level, const char *message)
Writes to the kdrive express logger.

kdrive_logger_dump
kdriveExpress_API void kdrive_logger_dump(uint8_t level, const char *message, const void *buffer, uint32_t buffer_len)
Logs the given message, followed by the data in buffer.

kdrive_logger_console
kdriveExpress_API void kdrive_logger_console(void)
Sets the logger to write to the console.

kdrive_logger_set_callback
kdriveExpress_API void kdrive_logger_set_callback(kdrive_logger_callback c)
Set the logger to call a user callback function.

kdrive_logger_file_ex
kdriveExpress_API void kdrive_logger_file_ex(const char *filename)
Set the logger to write to a specified file.

kdrive_logger_ex
kdriveExpress_API void kdrive_logger_ex(uint8_t level, const char *fmt,...)
Writes to the kdrive express logger.

kdrive_logger_syslog
kdriveExpress_API void kdrive_logger_syslog(const char *address, const char *name)
Set the logger to write to a remote host with the syslog protocol.

kdrive_logger_file
kdriveExpress_API void kdrive_logger_file(void)
Set the logger to write to a file The file is written to the current path as logfile_pid where pid is...

kdrive_logger_set_level
kdriveExpress_API void kdrive_logger_set_level(uint8_t level)
Sets the root logger level This is once of:

kdrive_express_config.h

kdriveExpress_API
#define kdriveExpress_API
Definition: kdrive_express_config.h:89

uint32_t
unsigned int uint32_t
32 bit unsigned char
Definition: kdrive_express_config.h:32

uint8_t
unsigned char uint8_t
8 bit unsigned char
Definition: kdrive_express_config.h:30

kdrive_logger_callback
void(* kdrive_logger_callback)(uint8_t level, const char *message)
Logger Callback function type (pointer to function definition)
Definition: kdrive_express_logger.h:95