Commit | Line | Data |
---|---|---|
460b9539 | 1 | /* |
2 | * This file is part of DisOrder | |
5aff007d | 3 | * Copyright (C) 2005, 2007, 2008 Richard Kettlewell |
460b9539 | 4 | * |
e7eb3a27 | 5 | * This program is free software: you can redistribute it and/or modify |
460b9539 | 6 | * it under the terms of the GNU General Public License as published by |
e7eb3a27 | 7 | * the Free Software Foundation, either version 3 of the License, or |
460b9539 | 8 | * (at your option) any later version. |
e7eb3a27 RK |
9 | * |
10 | * This program is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | * GNU General Public License for more details. | |
14 | * | |
460b9539 | 15 | * You should have received a copy of the GNU General Public License |
e7eb3a27 | 16 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
460b9539 | 17 | */ |
132a5a4a RK |
18 | /** @file lib/eventlog.h |
19 | * @brief Event logging | |
20 | */ | |
460b9539 | 21 | #ifndef EVENTLOG_H |
22 | #define EVENTLOG_H | |
23 | ||
598b07b7 RK |
24 | /** @brief An output for the event log |
25 | * | |
26 | * The caller must allocate these (since log.c isn't allowed to perform memory | |
27 | * allocation). They form a linked list, using eventlog_add() and | |
28 | * eventlog_remove(). | |
29 | */ | |
460b9539 | 30 | struct eventlog_output { |
598b07b7 | 31 | /** @brief Next output */ |
460b9539 | 32 | struct eventlog_output *next; |
598b07b7 RK |
33 | |
34 | /** @brief Handler for this output */ | |
460b9539 | 35 | void (*fn)(const char *msg, void *user); |
598b07b7 RK |
36 | |
37 | /** @brief Passed to @ref fn */ | |
460b9539 | 38 | void *user; |
39 | }; | |
40 | ||
598b07b7 RK |
41 | /** @brief Add an event log output |
42 | * @param lo Pointer to output to add | |
43 | */ | |
38e8ac48 | 44 | void eventlog_add(struct eventlog_output *lo) attribute((nonnull(1))); |
460b9539 | 45 | |
598b07b7 RK |
46 | /** @brief Remove an event log output |
47 | * @param lo Pointer to output to remove | |
48 | */ | |
38e8ac48 | 49 | void eventlog_remove(struct eventlog_output *lo) attribute((nonnull(1))); |
460b9539 | 50 | |
598b07b7 RK |
51 | /** @brief Send a message to the event log |
52 | * @param keyword Distinguishing keyword for event | |
53 | * @param ... Extra data, terminated by (char *)0 | |
54 | */ | |
38e8ac48 | 55 | void eventlog(const char *keyword, ...) attribute((nonnull(1))); |
598b07b7 RK |
56 | |
57 | /** @brief Send a message to the event log | |
58 | * @param keyword Distinguishing keyword for event | |
59 | * @param raw Unformatted data | |
60 | * @param ... Extra data, terminated by (char *)0 | |
61 | */ | |
38e8ac48 RK |
62 | void eventlog_raw(const char *keyword, const char *raw, ...) |
63 | attribute((nonnull(1, 2))); | |
460b9539 | 64 | |
65 | #endif /* EVENTLOG_H */ | |
66 | ||
67 | /* | |
68 | Local Variables: | |
69 | c-basic-offset:2 | |
70 | comment-column:40 | |
71 | fill-column:79 | |
72 | End: | |
73 | */ |