lib/dhcp-client.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #ifndef DHCP_CLIENT_H
  35 #define DHCP_CLIENT_H 1
  36
  37 #include <stdbool.h>
  38 #include <stdint.h>
  39
  40 struct dhclient;
  41 struct dhcp_msg;
  42 struct netdev;
  43 int dhclient_create(const char *netdev,
  44                     void (*modify_request)(struct dhcp_msg *, void *aux),
  45                     bool (*validate_offer)(const struct dhcp_msg *, void *aux),
  46                     void *aux, struct dhclient **);
  47 void dhclient_set_max_timeout(struct dhclient *, unsigned int max_timeout);
  48 void dhclient_destroy(struct dhclient *);
  49
  50 struct netdev *dhclient_get_netdev(struct dhclient *);
  51
  52 void dhclient_init(struct dhclient *, uint32_t requested_ip);
  53 void dhclient_release(struct dhclient *);
  54 void dhclient_force_renew(struct dhclient *, int deadline);
  55 bool dhclient_is_bound(const struct dhclient *);
  56 bool dhclient_changed(struct dhclient *);
  57
  58 const char *dhclient_get_state(const struct dhclient *);
  59 unsigned int dhclient_get_state_elapsed(const struct dhclient *);
  60 unsigned int dhclient_get_lease_remaining(const struct dhclient *);
  61
  62 uint32_t dhclient_get_ip(const struct dhclient *);
  63 uint32_t dhclient_get_netmask(const struct dhclient *);
  64 uint32_t dhclient_get_router(const struct dhclient *);
  65 const struct dhcp_msg *dhclient_get_config(const struct dhclient *);
  66
  67 int dhclient_configure_netdev(struct dhclient *);
  68 int dhclient_update_resolv_conf(struct dhclient *);
  69
  70 void dhclient_run(struct dhclient *);
  71 void dhclient_wait(struct dhclient *);
  72
  73 #endif /* dhcp-client.h */