logger.h File Reference
#include <gwenhywfar/gwenhywfarapi.h>
Go to the source code of this file.
Define Documentation
| #define GWEN_LOGDOMAIN "gwenhywfar" |
Typedef Documentation
| typedef void GWENHYWFAR_CB(* GWEN_LOGGERFUNCTIONLOG)(const char *s) |
Enumeration Type Documentation
| enum GWEN_LOGGER_FACILITY |
| enum GWEN_LOGGER_LEVEL |
| enum GWEN_LOGGER_LOGTYPE |
Function Documentation
| GWENHYWFAR_API void GWEN_Logger_Close | ( | const char * | logDomain | ) |
Shuts down logging. Automatically disables logging.
| GWENHYWFAR_API void GWEN_Logger_Enable | ( | const char * | logDomain, | |
| int | f | |||
| ) |
Enables or disables logging.
- Parameters:
-
f if 0 then logging is disabled, otherwise it is enabled
| GWENHYWFAR_API int GWEN_Logger_Exists | ( | const char * | logDomain | ) |
Checks whether a given log domain already exists.
- Returns:
- 1 if it exists, 0 otherwise
| GWENHYWFAR_API int GWEN_Logger_GetLevel | ( | const char * | logDomain | ) |
Returns the current log level.
| GWENHYWFAR_API int GWEN_Logger_IsEnabled | ( | const char * | logDomain | ) |
Checks whether logging is enabled.
- Returns:
- 0 if disabled, 1 otherwise
| GWENHYWFAR_API int GWEN_Logger_IsOpen | ( | const char * | logDomain | ) |
Checks whether the logger for the given logDomain is open or not.
| GWENHYWFAR_API const char* GWEN_Logger_Level2Name | ( | GWEN_LOGGER_LEVEL | level | ) |
Transforms a logger level to an ASCII string (for config files, command line options etc).
| GWENHYWFAR_API int GWEN_Logger_Log | ( | const char * | logDomain, | |
| GWEN_LOGGER_LEVEL | priority, | |||
| const char * | s | |||
| ) |
Log a message.
- Parameters:
-
priority priority of the message s string to log. This string is cut at all occurences of a newline character thus splitting it into multiple log lines if necessary
| GWENHYWFAR_API const char* GWEN_Logger_Logtype2Name | ( | GWEN_LOGGER_LOGTYPE | lt | ) |
Transforms a log type into an ASCII string.
| GWENHYWFAR_API GWEN_LOGGER_LEVEL GWEN_Logger_Name2Level | ( | const char * | name | ) |
Transforms an ASCII string to a level value.
| GWENHYWFAR_API GWEN_LOGGER_LOGTYPE GWEN_Logger_Name2Logtype | ( | const char * | name | ) |
Transforms an ASCII string into the corresponding log type.
| GWENHYWFAR_API int GWEN_Logger_Open | ( | const char * | logDomain, | |
| const char * | ident, | |||
| const char * | file, | |||
| GWEN_LOGGER_LOGTYPE | logtype, | |||
| GWEN_LOGGER_FACILITY | facility | |||
| ) |
Sets up logging. It automatically enables logging.
- Parameters:
-
ident this string is prepended to each message logged to identify the logging program file name of the file to log to. If this is empty and syslog is available, then all messages are logged via syslog. If syslog is not available, all messages are logged to the console. logtype how to log (via syslog, to a file, to the console etc) facility what kind of program the log message comes from
| void GWEN_Logger_SetFilename | ( | const char * | logDomain, | |
| const char * | name | |||
| ) |
Set the name of the file to be used when logging to a file.
| GWENHYWFAR_API void GWEN_Logger_SetIdent | ( | const char * | logDomain, | |
| const char * | id | |||
| ) |
Set ident string. This string is prepended to every log message and should contain the name of the running program.
| GWENHYWFAR_API void GWEN_Logger_SetLevel | ( | const char * | logDomain, | |
| GWEN_LOGGER_LEVEL | l | |||
| ) |
Sets the logger level. All messages with a priority up to the given one will be logged, all others will not.
- Parameters:
-
l maximum level to be logged
| GWENHYWFAR_API GWEN_LOGGERFUNCTIONLOG GWEN_Logger_SetLogFunction | ( | const char * | logDomain, | |
| GWEN_LOGGERFUNCTIONLOG | fn | |||
| ) |
Set logging function. This function is used to log messages in mode LoggerTypeFunction.
