updated Doxyfile
[strongswan.git] / src / libstrongswan / utils / leak_detective.h
1 /*
2 * Copyright (C) 2008 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
16 /**
17 * @defgroup leak_detective leak_detective
18 * @{ @ingroup utils
19 */
20
21 #ifndef LEAK_DETECTIVE_H_
22 #define LEAK_DETECTIVE_H_
23
24 typedef struct leak_detective_t leak_detective_t;
25
26 /**
27 * Leak detective finds leaks and bad frees using malloc hooks.
28 *
29 * Currently leaks are reported to stderr on destruction.
30 *
31 * @todo Build an API for leak detective, allowing leak enumeration, statistics
32 * and dynamic whitelisting.
33 */
34 struct leak_detective_t {
35
36 /**
37 * Destroy a leak_detective instance.
38 */
39 void (*destroy)(leak_detective_t *this);
40 };
41
42 /**
43 * Create a leak_detective instance.
44 */
45 leak_detective_t *leak_detective_create();
46
47 #endif /** LEAK_DETECTIVE_H_ @}*/
48