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