| 1 | /* |
| 2 | * This file is part of DisOrder |
| 3 | * Copyright (C) 2005, 2007, 2008 Richard Kettlewell |
| 4 | * |
| 5 | * This program is free software: you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License as published by |
| 7 | * the Free Software Foundation, either version 3 of the License, or |
| 8 | * (at your option) any later version. |
| 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 | * |
| 15 | * You should have received a copy of the GNU General Public License |
| 16 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 17 | */ |
| 18 | /** @file lib/eventlog.h |
| 19 | * @brief Event logging |
| 20 | */ |
| 21 | #ifndef EVENTLOG_H |
| 22 | #define EVENTLOG_H |
| 23 | |
| 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 | */ |
| 30 | struct eventlog_output { |
| 31 | /** @brief Next output */ |
| 32 | struct eventlog_output *next; |
| 33 | |
| 34 | /** @brief Handler for this output */ |
| 35 | void (*fn)(const char *msg, void *user); |
| 36 | |
| 37 | /** @brief Passed to @ref fn */ |
| 38 | void *user; |
| 39 | }; |
| 40 | |
| 41 | /** @brief Add an event log output |
| 42 | * @param lo Pointer to output to add |
| 43 | */ |
| 44 | void eventlog_add(struct eventlog_output *lo) attribute((nonnull(1))); |
| 45 | |
| 46 | /** @brief Remove an event log output |
| 47 | * @param lo Pointer to output to remove |
| 48 | */ |
| 49 | void eventlog_remove(struct eventlog_output *lo) attribute((nonnull(1))); |
| 50 | |
| 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 | */ |
| 55 | void eventlog(const char *keyword, ...) attribute((nonnull(1))); |
| 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 | */ |
| 62 | void eventlog_raw(const char *keyword, const char *raw, ...) |
| 63 | attribute((nonnull(1, 2))); |
| 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 | */ |