/usr/include/gwenhywfar4/gwenhywfar/logger.h is in libgwenhywfar-core-dev 4.15.3-5+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 | /***************************************************************************
$RCSfile$
-------------------
cvs : $Id$
begin : Sun Dec 05 2003
copyright : (C) 2003 by Martin Preuss
email : martin@libchipcard.de
***************************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the Free Software *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
* MA 02111-1307 USA *
* *
***************************************************************************/
#ifndef GWEN_LOGGER_H
#define GWEN_LOGGER_H
#ifdef __cplusplus
extern "C" {
#endif
#define GWEN_LOGDOMAIN "gwenhywfar"
#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/buffer.h>
typedef void GWENHYWFAR_CB (*GWEN_LOGGERFUNCTIONLOG)(const char *s);
typedef enum {
GWEN_LoggerType_Console,
GWEN_LoggerType_File,
GWEN_LoggerType_Syslog,
GWEN_LoggerType_Function,
GWEN_LoggerType_Unknown=9999
} GWEN_LOGGER_LOGTYPE;
typedef enum {
GWEN_LoggerFacility_Auth=0,
GWEN_LoggerFacility_Daemon,
GWEN_LoggerFacility_Mail,
GWEN_LoggerFacility_News,
GWEN_LoggerFacility_User,
GWEN_LoggerFacility_Unknown=9999
} GWEN_LOGGER_FACILITY;
typedef enum {
GWEN_LoggerLevel_Emergency=0,
GWEN_LoggerLevel_Alert,
GWEN_LoggerLevel_Critical,
GWEN_LoggerLevel_Error,
GWEN_LoggerLevel_Warning,
GWEN_LoggerLevel_Notice,
GWEN_LoggerLevel_Info,
GWEN_LoggerLevel_Debug,
GWEN_LoggerLevel_Verbous,
GWEN_LoggerLevel_Unknown=9999
} GWEN_LOGGER_LEVEL;
/**
* Checks whether a given log domain already exists.
* @return 1 if it exists, 0 otherwise
*/
GWENHYWFAR_API int GWEN_Logger_Exists(const char *logDomain);
/**
* Sets up logging. It automatically enables logging.
* @author Martin Preuss<martin@libchipcard.de>
* @param ident this string is prepended to each message logged to identify
* the logging program
* @param 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.
* @param logtype how to log (via syslog, to a file, to the console etc)
* @param facility what kind of program the log message comes from
*/
GWENHYWFAR_API int GWEN_Logger_Open(const char *logDomain,
const char *ident,
const char *file,
GWEN_LOGGER_LOGTYPE logtype,
GWEN_LOGGER_FACILITY facility);
/**
* Shuts down logging. Automatically disables logging.
* @author Martin Preuss<martin@libchipcard.de>
*/
GWENHYWFAR_API void GWEN_Logger_Close(const char *logDomain);
/**
* Checks whether the logger for the given logDomain is open or not.
*/
GWENHYWFAR_API int GWEN_Logger_IsOpen(const char *logDomain);
/**
* Log a message.
* @author Martin Preuss<martin@libchipcard.de>
* @param priority priority of the message
* @param 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 int GWEN_Logger_Log(const char *logDomain,
GWEN_LOGGER_LEVEL priority, const char *s);
/**
* Enables or disables logging.
* @author Martin Preuss<martin@libchipcard.de>
* @param f if 0 then logging is disabled, otherwise it is enabled
*/
GWENHYWFAR_API void GWEN_Logger_Enable(const char *logDomain,
int f);
/**
* Checks whether logging is enabled.
* @author Martin Preuss<martin@libchipcard.de>
* @return 0 if disabled, 1 otherwise
*/
GWENHYWFAR_API int GWEN_Logger_IsEnabled(const char *logDomain);
/**
* Sets the logger level. All messages with a priority up to the given one
* will be logged, all others will not.
* @author Martin Preuss<martin@libchipcard.de>
* @param l maximum level to be logged
*/
GWENHYWFAR_API void GWEN_Logger_SetLevel(const char *logDomain,
GWEN_LOGGER_LEVEL l);
/**
* Returns the current log level.
* @author Martin Preuss<martin@libchipcard.de>
*/
GWENHYWFAR_API int GWEN_Logger_GetLevel(const char *logDomain);
/**
* Set ident string. This string is prepended to every log message and
* should contain the name of the running program.
* @author Martin Preuss<martin@libchipcard.de>
*/
GWENHYWFAR_API void GWEN_Logger_SetIdent(const char *logDomain,
const char *id);
/**
* Set the name of the file to be used when logging to a file.
*/
void GWEN_Logger_SetFilename(const char *logDomain, const char *name);
/**
* Set logging function. This function is used to log messages in mode
* LoggerTypeFunction.
* @author Martin Preuss<martin@libchipcard.de>
*/
GWENHYWFAR_API
GWEN_LOGGERFUNCTIONLOG GWEN_Logger_SetLogFunction(const char *logDomain,
GWEN_LOGGERFUNCTIONLOG fn);
/**
* Transforms an ASCII string to a level value.
*/
GWENHYWFAR_API
GWEN_LOGGER_LEVEL GWEN_Logger_Name2Level(const char *name);
/**
* Transforms a logger level to an ASCII string (for config files,
* command line options etc).
*/
GWENHYWFAR_API
const char *GWEN_Logger_Level2Name(GWEN_LOGGER_LEVEL level);
/**
* Transforms an ASCII string into the corresponding log type.
*/
GWENHYWFAR_API
GWEN_LOGGER_LOGTYPE GWEN_Logger_Name2Logtype(const char *name);
/**
* Transforms a log type into an ASCII string.
*/
GWENHYWFAR_API
const char *GWEN_Logger_Logtype2Name(GWEN_LOGGER_LOGTYPE lt);
/**
* This function can be used to generate log messages from within log hooks.
*/
GWENHYWFAR_API
int GWEN_Logger_CreateLogMessage(const char *logDomain,
GWEN_LOGGER_LEVEL priority, const char *s,
GWEN_BUFFER *mbuf);
#ifdef __cplusplus
}
#endif
#endif /* #ifndef CH_LOGGER_H */
|