Pass all configured pool names to attribute provider enumerator
[strongswan.git] / src / libhydra / attributes / attribute_provider.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 attribute_provider attribute_provider
18 * @{ @ingroup attributes
19 */
20
21 #ifndef ATTRIBUTE_PROVIDER_H_
22 #define ATTRIBUTE_PROVIDER_H_
23
24 #include <utils/host.h>
25 #include <utils/identification.h>
26 #include <utils/linked_list.h>
27
28 typedef struct attribute_provider_t attribute_provider_t;
29
30 /**
31 * Interface to provide attributes to peers through attribute manager.
32 */
33 struct attribute_provider_t {
34
35 /**
36 * Acquire a virtual IP address to assign to a peer.
37 *
38 * @param pool name of the pool to acquire address from
39 * @param id peer ID
40 * @param requested IP in configuration request
41 * @return allocated address, NULL to serve none
42 */
43 host_t* (*acquire_address)(attribute_provider_t *this,
44 char *pool, identification_t *id,
45 host_t *requested);
46 /**
47 * Release a previously acquired address.
48 *
49 * @param pool name of the pool this address was acquired from
50 * @param address address to release
51 * @param id peer ID
52 * @return TRUE if the address has been released by the provider
53 */
54 bool (*release_address)(attribute_provider_t *this,
55 char *pool, host_t *address, identification_t *id);
56
57 /**
58 * Create an enumerator over attributes to hand out to a peer.
59 *
60 * @param pool list of pools names (char*) to query attributes from
61 * @param id peer ID
62 * @param vip list of virtual IPs (host_t*) to assign to peer
63 * @return enumerator (configuration_attribute_type_t, chunk_t)
64 */
65 enumerator_t* (*create_attribute_enumerator)(attribute_provider_t *this,
66 linked_list_t *pools, identification_t *id,
67 linked_list_t *vips);
68 };
69
70 #endif /** ATTRIBUTE_PROVIDER_H_ @}*/