documentation fixes and updates
[strongswan.git] / src / charon / bus / listeners / file_logger.h
1 /**
2 * @file file_logger.h
3 *
4 * @brief Interface of file_logger_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2006 Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
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 * @brief Logger to files which implements bus_listener_t.
32 *
33 * @b Constructors:
34 * - file_logger_create()
35 *
36 * @ingroup listeners
37 */
38 struct file_logger_t {
39
40 /**
41 * Implements the bus_listener_t interface.
42 */
43 bus_listener_t listener;
44
45 /**
46 * @brief Set the loglevel for a signal type.
47 *
48 * @param this stream_logger_t object
49 * @param singal type of signal
50 * @param level max level to log (0..4)
51 */
52 void (*set_level) (file_logger_t *this, signal_t signal, level_t level);
53
54 /**
55 * @brief Destroys a file_logger_t object.
56 *
57 * @param this file_logger_t object
58 */
59 void (*destroy) (file_logger_t *this);
60 };
61
62 /**
63 * @brief Constructor to create a file_logger_t object.
64 *
65 * @param out FILE to write to
66 * @return file_logger_t object
67 *
68 * @ingroup listeners
69 */
70 file_logger_t *file_logger_create(FILE *out);
71
72
73 #endif /* FILE_LOGGER_H_ */