added thread initialization/deinitialization hooks
[strongswan.git] / src / manager / lib / enumerator.h
1 /**
2 * @file enumerator.h
3 *
4 * @brief Interface of enumerator_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2007 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 ENUMERATOR_H_
24 #define ENUMERATOR_H_
25
26 #include <library.h>
27
28 typedef struct enumerator_t enumerator_t;
29
30 /**
31 * @brief Enumerate is simpler, but more flexible than iterator.
32 */
33 struct enumerator_t {
34
35 /**
36 * @brief Enumerate collection.
37 *
38 * The enumerate function takes a variable argument list containing
39 * pointers where the enumerated values get written.
40 *
41 * @param ... variable list of enumerated items, implementation dependant
42 * @return TRUE if pointers returned
43 */
44 bool (*enumerate)(enumerator_t *this, ...);
45
46 /**
47 * @brief Destroy a enumerator instance.
48 */
49 void (*destroy)(enumerator_t *this);
50 };
51
52 /**
53 * @brief Create an enumerator which enumerates over nothing
54 */
55 enumerator_t* enumerator_create_empty();
56
57 #endif /* ENUMERATOR_H_ */