GRU - Generic Reusable Utilities
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Typedefs | Enumerations | Functions
gru_logger.h File Reference
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <strings.h>
#include <stdarg.h>
#include <stdbool.h>
#include "common/gru_base.h"

Go to the source code of this file.

Typedefs

typedef enum log_level_t_ log_level_t
 
typedef void(* logger_t )(log_level_t level, const char *message,...)
 

Enumerations

enum  log_level_t_ {
  TRACE = 0, DEBUG = 1, INFO = 2, STAT = 3,
  WARNING = 4, ERROR = 5, FATAL = 6
}
 

Functions

gru_export log_level_t gru_logger_get_level (const char *str)
 Gets the log level from an input string. More...
 
gru_export bool gru_logger_can_log (log_level_t l1)
 Whether can log (ie. More...
 
gru_export void gru_logger_set (logger_t logger)
 Sets the logger. More...
 
gru_export logger_t gru_logger_get (void)
 Gets the logger. More...
 
gru_export void gru_logger_set_mininum (log_level_t minimum)
 Sets the minimum log level. More...
 
gru_export log_level_t gru_logger_get_mininum ()
 Gets the minimum log level. More...
 
gru_export void gru_logger_default_printer (log_level_t level, const char *msg,...)
 Default logger that logs to stdout. More...
 
gru_export void gru_logger_default_do_print (log_level_t level, const char *msg, va_list ap)
 Utility printing function that can be used by implementations of the logger printer. More...
 

Typedef Documentation

typedef enum log_level_t_ log_level_t
typedef void(* logger_t)(log_level_t level, const char *message,...)

Enumeration Type Documentation

Enumerator
TRACE 
DEBUG 
INFO 
STAT 
WARNING 
ERROR 
FATAL 

Function Documentation

gru_export bool gru_logger_can_log ( log_level_t  l1)

Whether can log (ie.

: whether log level 1 is greater or equal to l2, thus allowing to log)

Parameters
l1log level being checked
Returns
gru_export void gru_logger_default_do_print ( log_level_t  level,
const char *  msg,
va_list  ap 
)

Utility printing function that can be used by implementations of the logger printer.

Parameters
levelmessage level
msgthe message + additional parameters
apva_list object for variable argument list
gru_export void gru_logger_default_printer ( log_level_t  level,
const char *  msg,
  ... 
)

Default logger that logs to stdout.

Parameters
levelmessage level
msgthe message + additional parameters
gru_export logger_t gru_logger_get ( void  )

Gets the logger.

Returns
the logger
gru_export log_level_t gru_logger_get_level ( const char *  str)

Gets the log level from an input string.

Parameters
strthe input string (ie.: info, warn, etc)
Returns
the log level
gru_export log_level_t gru_logger_get_mininum ( )

Gets the minimum log level.

Returns
the minimum log level
gru_export void gru_logger_set ( logger_t  logger)

Sets the logger.

Parameters
loggerthe new logger
gru_export void gru_logger_set_mininum ( log_level_t  minimum)

Sets the minimum log level.

Parameters
minimumthe minimum log level