updated Doxyfile
[strongswan.git] / src / charon / bus / listeners / file_logger.h
1 /*
2 * Copyright (C) 2006 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 *
15 * $Id$
16 */
17
18 /**
19 * @defgroup file_logger file_logger
20 * @{ @ingroup listeners
21 */
22
23 #ifndef FILE_LOGGER_H_
24 #define FILE_LOGGER_H_
25
26 typedef struct file_logger_t file_logger_t;
27
28 #include <bus/bus.h>
29
30 /**
31 * Logger to files which implements listener_t.
32 */
33 struct file_logger_t {
34
35 /**
36 * Implements the listener_t interface.
37 */
38 listener_t listener;
39
40 /**
41 * Set the loglevel for a debug group.
42 *
43 * @param group debug group to set
44 * @param level max level to log (0..4)
45 */
46 void (*set_level) (file_logger_t *this, debug_t group, level_t level);
47
48 /**
49 * Destroys a file_logger_t object.
50 */
51 void (*destroy) (file_logger_t *this);
52 };
53
54 /**
55 * Constructor to create a file_logger_t object.
56 *
57 * @param out FILE to write to
58 * @return file_logger_t object
59 */
60 file_logger_t *file_logger_create(FILE *out);
61
62 #endif /** FILE_LOGGER_H_ @}*/