793ed30c7c0fd7e72e4813168eab83db9548631a
[asterisk/asterisk.git] / include / asterisk / logger.h
1 /*
2  * Cheops Next Generation
3  * 
4  * Mark Spencer <markster@marko.net>
5  *
6  * Copyright(C) Mark Spencer
7  * 
8  * Distributed under the terms of the GNU General Public License (GPL) Version
9  *
10  * Logging routines
11  *
12  */
13
14 #ifndef _LOGGER_H
15 #define _LOGGER_H
16
17 #include <stdarg.h>
18
19 #if defined(__cplusplus) || defined(c_plusplus)
20 extern "C" {
21 #endif
22
23 #define EVENTLOG "event_log"
24
25 #define DEBUG_M(a) { \
26         a; \
27 }
28
29 //! Used for sending a log message
30 /*!
31  * \param level don't need to worry about it
32  * \param file ditto
33  * \param line ditto
34  * \param function ditto
35  * \param fmt this is what is important.  The format is the same as your favorite breed of printf.  You know how that works, right? :-)
36  * This is the standard logger function.  Probably the only way you will invoke it would be something like this:
37  * ast_log(LOG_WHATEVER, "Problem with the %s Captain.  We should get some more.  Will %d be enough?", "flux capacitor", 10);
38  * where WHATEVER is one of ERROR, DEBUG, EVENT, NOTICE, or WARNING depending on which log you wish to output to.
39  */
40 extern void ast_log(int level, char *file, int line, char *function, char *fmt, ...)
41         __attribute__ ((format (printf, 5, 6)));
42
43 //! Send a verbose message (based on verbose level)
44 /*!
45  * This works like ast_log, but prints verbose messages to the console depending on verbosity level set.
46  * ast_verbose(VERBOSE_PREFIX_3 "Whatever %s is happening\n", "nothing");
47  * This will print the message to the console if the verbose level is set to a level >= 3
48  * Note the abscence of a comma after the VERBOSE_PREFIX_3.  This is important.
49  * VERBOSE_PREFIX_1 through VERBOSE_PREFIX_3 are defined.
50  */
51 extern void ast_verbose(char *fmt, ...)
52         __attribute__ ((format (printf, 1, 2)));
53
54 extern int ast_register_verbose(void (*verboser)(char *string, int opos, int replacelast, int complete));
55 extern int ast_unregister_verbose(void (*verboser)(char *string, int opos, int replacelast, int complete));
56 extern int ast_verbose_dmesg(void (*verboser)(char *string, int opos, int replacelast, int complete));
57 #define _A_ __FILE__, __LINE__, __PRETTY_FUNCTION__
58
59 #define LOG_DEBUG       0, _A_
60 #define LOG_EVENT   1, _A_
61 #define LOG_NOTICE  2, _A_
62 #define LOG_WARNING 3, _A_
63 #define LOG_ERROR       4, _A_
64
65 #if defined(__cplusplus) || defined(c_plusplus)
66 }
67 #endif
68
69
70 #endif