gdhcp/gdhcp.h

   1 /*
   2  *
   3  *  DHCP library with GLib integration
   4  *
   5  *  Copyright (C) 2009-2010  Intel Corporation. All rights reserved.
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License version 2 as
   9  *  published by the Free Software Foundation.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  */
  21
  22 #ifndef __G_DHCP_H
  23 #define __G_DHCP_H
  24
  25 #include <glib.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /* DHCP Client part*/
  32 struct _GDHCPClient;
  33
  34 typedef struct _GDHCPClient GDHCPClient;
  35
  36 typedef enum {
  37         G_DHCP_CLIENT_ERROR_NONE,
  38         G_DHCP_CLIENT_ERROR_INTERFACE_UNAVAILABLE,
  39         G_DHCP_CLIENT_ERROR_INTERFACE_IN_USE,
  40         G_DHCP_CLIENT_ERROR_INTERFACE_DOWN,
  41         G_DHCP_CLIENT_ERROR_NOMEM,
  42         G_DHCP_CLIENT_ERROR_INVALID_INDEX,
  43         G_DHCP_CLIENT_ERROR_INVALID_OPTION
  44 } GDHCPClientError;
  45
  46 typedef enum {
  47         G_DHCP_CLIENT_EVENT_LEASE_AVAILABLE,
  48         G_DHCP_CLIENT_EVENT_IPV4LL_AVAILABLE,
  49         G_DHCP_CLIENT_EVENT_NO_LEASE,
  50         G_DHCP_CLIENT_EVENT_LEASE_LOST,
  51         G_DHCP_CLIENT_EVENT_IPV4LL_LOST,
  52         G_DHCP_CLIENT_EVENT_ADDRESS_CONFLICT,
  53 } GDHCPClientEvent;
  54
  55 typedef enum {
  56         G_DHCP_IPV4,
  57         G_DHCP_IPV6,
  58         G_DHCP_IPV4LL,
  59 } GDHCPType;
  60
  61 #define G_DHCP_SUBNET           0x01
  62 #define G_DHCP_ROUTER           0x03
  63 #define G_DHCP_TIME_SERVER      0x04
  64 #define G_DHCP_DNS_SERVER       0x06
  65 #define G_DHCP_DOMAIN_NAME      0x0f
  66 #define G_DHCP_HOST_NAME        0x0c
  67 #define G_DHCP_NTP_SERVER       0x2a
  68
  69 typedef void (*GDHCPClientEventFunc) (GDHCPClient *client, gpointer user_data);
  70
  71 typedef void (*GDHCPDebugFunc)(const char *str, gpointer user_data);
  72
  73 GDHCPClient *g_dhcp_client_new(GDHCPType type, int index,
  74                                                 GDHCPClientError *error);
  75
  76 int g_dhcp_client_start(GDHCPClient *client);
  77 void g_dhcp_client_stop(GDHCPClient *client);
  78
  79 GDHCPClient *g_dhcp_client_ref(GDHCPClient *client);
  80 void g_dhcp_client_unref(GDHCPClient *client);
  81
  82 void g_dhcp_client_register_event(GDHCPClient *client,
  83                                         GDHCPClientEvent event,
  84                                         GDHCPClientEventFunc func,
  85                                         gpointer user_data);
  86
  87 GDHCPClientError g_dhcp_client_set_request(GDHCPClient *client,
  88                                                 unsigned char option_code);
  89 GDHCPClientError g_dhcp_client_set_send(GDHCPClient *client,
  90                                                 unsigned char option_code,
  91                                                 const char *option_value);
  92
  93 char *g_dhcp_client_get_address(GDHCPClient *client);
  94 GList *g_dhcp_client_get_option(GDHCPClient *client,
  95                                                 unsigned char option_code);
  96 int g_dhcp_client_get_index(GDHCPClient *client);
  97
  98 void g_dhcp_client_set_debug(GDHCPClient *client,
  99                                 GDHCPDebugFunc func, gpointer user_data);
 100
 101 /* DHCP Server */
 102 typedef enum {
 103         G_DHCP_SERVER_ERROR_NONE,
 104         G_DHCP_SERVER_ERROR_INTERFACE_UNAVAILABLE,
 105         G_DHCP_SERVER_ERROR_INTERFACE_IN_USE,
 106         G_DHCP_SERVER_ERROR_INTERFACE_DOWN,
 107         G_DHCP_SERVER_ERROR_NOMEM,
 108         G_DHCP_SERVER_ERROR_INVALID_INDEX,
 109         G_DHCP_SERVER_ERROR_INVALID_OPTION,
 110         G_DHCP_SERVER_ERROR_IP_ADDRESS_INVALID
 111 } GDHCPServerError;
 112
 113 typedef void (*GDHCPSaveLeaseFunc) (unsigned char *mac,
 114                         unsigned int nip, unsigned int expire);
 115 struct _GDHCPServer;
 116
 117 typedef struct _GDHCPServer GDHCPServer;
 118
 119 GDHCPServer *g_dhcp_server_new(GDHCPType type,
 120                 int ifindex, GDHCPServerError *error);
 121 int g_dhcp_server_start(GDHCPServer *server);
 122 void g_dhcp_server_stop(GDHCPServer *server);
 123
 124 GDHCPServer *g_dhcp_server_ref(GDHCPServer *server);
 125 void g_dhcp_server_unref(GDHCPServer *server);
 126
 127 int g_dhcp_server_set_option(GDHCPServer *server,
 128                 unsigned char option_code, const char *option_value);
 129 int g_dhcp_server_set_ip_range(GDHCPServer *server,
 130                 const char *start_ip, const char *end_ip);
 131 void g_dhcp_server_load_lease(GDHCPServer *dhcp_server, unsigned int expire,
 132                                 unsigned char *mac, unsigned int lease_ip);
 133 void g_dhcp_server_set_debug(GDHCPServer *server,
 134                                 GDHCPDebugFunc func, gpointer user_data);
 135 void g_dhcp_server_set_lease_time(GDHCPServer *dhcp_server,
 136                                                 unsigned int lease_time);
 137 void g_dhcp_server_set_save_lease(GDHCPServer *dhcp_server,
 138                                 GDHCPSaveLeaseFunc func, gpointer user_data);
 139 #ifdef __cplusplus
 140 }
 141 #endif
 142
 143 #endif /* __G_DHCP_H */