src/libcharon/plugins/dhcp/dhcp_provider.h

   1 /*
   2  * Copyright (C) 2010 Martin Willi
   3  * Copyright (C) 2010 revosec AG
   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 dhcp_provider dhcp_provider
  18  * @{ @ingroup dhcp
  19  */
  20
  21 #ifndef DHCP_PROVIDER_H_
  22 #define DHCP_PROVIDER_H_
  23
  24 typedef struct dhcp_provider_t dhcp_provider_t;
  25
  26 #include "dhcp_socket.h"
  27
  28 #include <attributes/attribute_provider.h>
  29
  30 /**
  31  * DHCP based attribute provider.
  32  */
  33 struct dhcp_provider_t {
  34
  35         /**
  36          * Implements attribute_provider_t interface.
  37          */
  38         attribute_provider_t provider;
  39
  40         /**
  41          * Destroy a dhcp_provider_t.
  42          */
  43         void (*destroy)(dhcp_provider_t *this);
  44 };
  45
  46 /**
  47  * Create a dhcp_provider instance.
  48  *
  49  * @param socket                socket to use for DHCP communication
  50  * @return                              provider instance
  51  */
  52 dhcp_provider_t *dhcp_provider_create(dhcp_socket_t *socket);
  53
  54 #endif /** DHCP_PROVIDER_H_ @}*/