ipconfig: Define 2 separate pointers for IPv4 and IPv6
[framework/connectivity/connman.git] / include / ipconfig.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-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 __CONNMAN_IPCONFIG_H
23 #define __CONNMAN_IPCONFIG_H
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 /**
30  * SECTION:ipconfig
31  * @title: IP configuration premitives
32  * @short_description: Functions for IP configuration handling
33  */
34
35 struct connman_ipaddress {
36         int family;
37         unsigned char prefixlen;
38         char *local;
39         char *peer;
40         char *broadcast;
41         char *gateway;
42 };
43
44 struct connman_ipaddress *connman_ipaddress_alloc(int family);
45 void connman_ipaddress_free(struct connman_ipaddress *ipaddress);
46 void connman_ipaddress_set(struct connman_ipaddress *ipaddress,
47                 const char *address, const char *netmask, const char *gateway);
48 void connman_ipaddress_clear(struct connman_ipaddress *ipaddress);
49 void connman_ipaddress_copy(struct connman_ipaddress *ipaddress,
50                                         struct connman_ipaddress *source);
51
52 enum connman_ipconfig_type {
53         CONNMAN_IPCONFIG_TYPE_UNKNOWN = 0,
54         CONNMAN_IPCONFIG_TYPE_IPV4    = 1,
55         CONNMAN_IPCONFIG_TYPE_IPV6    = 2,
56 };
57
58 enum connman_ipconfig_method {
59         CONNMAN_IPCONFIG_METHOD_UNKNOWN = 0,
60         CONNMAN_IPCONFIG_METHOD_OFF     = 1,
61         CONNMAN_IPCONFIG_METHOD_FIXED   = 2,
62         CONNMAN_IPCONFIG_METHOD_MANUAL  = 3,
63         CONNMAN_IPCONFIG_METHOD_DHCP    = 4,
64 };
65
66 struct connman_ipconfig;
67
68 struct connman_ipconfig_ops {
69         void (*up) (struct connman_ipconfig *ipconfig);
70         void (*down) (struct connman_ipconfig *ipconfig);
71         void (*lower_up) (struct connman_ipconfig *ipconfig);
72         void (*lower_down) (struct connman_ipconfig *ipconfig);
73         void (*ip_bound) (struct connman_ipconfig *ipconfig);
74         void (*ip_release) (struct connman_ipconfig *ipconfig);
75 };
76
77 struct connman_ipconfig *connman_ipconfig_create(int index,
78                                         enum connman_ipconfig_type type);
79 struct connman_ipconfig *connman_ipconfig_clone(struct connman_ipconfig *ipconfig);
80 struct connman_ipconfig *connman_ipconfig_ref(struct connman_ipconfig *ipconfig);
81 void connman_ipconfig_unref(struct connman_ipconfig *ipconfig);
82
83 void *connman_ipconfig_get_data(struct connman_ipconfig *ipconfig);
84 void connman_ipconfig_set_data(struct connman_ipconfig *ipconfig, void *data);
85
86 int connman_ipconfig_get_index(struct connman_ipconfig *ipconfig);
87 const char *connman_ipconfig_get_ifname(struct connman_ipconfig *ipconfig);
88
89 void connman_ipconfig_set_ops(struct connman_ipconfig *ipconfig,
90                                 const struct connman_ipconfig_ops *ops);
91 int connman_ipaddress_set_ipv6(struct connman_ipaddress *ipaddress,
92                                 const char *address, const char *gateway,
93                                                 unsigned char prefix_length);
94 struct connman_ipconfig *connman_ipconfig_get_ipv6config(
95                                 struct connman_ipconfig *ipconfig);
96 int connman_ipconfig_set_method(struct connman_ipconfig *ipconfig,
97                                         enum connman_ipconfig_method method);
98 void connman_ipconfig_bind(struct connman_ipconfig *ipconfig,
99                                         struct connman_ipaddress *ipaddress);
100
101 #define CONNMAN_IPCONFIG_PRIORITY_LOW      -100
102 #define CONNMAN_IPCONFIG_PRIORITY_DEFAULT     0
103 #define CONNMAN_IPCONFIG_PRIORITY_HIGH      100
104
105 struct connman_ipconfig_driver {
106         const char *name;
107         enum connman_ipconfig_type type;
108         int priority;
109         int (*request) (struct connman_ipconfig *ipconfig);
110         int (*release) (struct connman_ipconfig *ipconfig);
111         int (*renew) (struct connman_ipconfig *ipconfig);
112 };
113
114 int connman_ipconfig_driver_register(struct connman_ipconfig_driver *driver);
115 void connman_ipconfig_driver_unregister(struct connman_ipconfig_driver *driver);
116
117 #ifdef __cplusplus
118 }
119 #endif
120
121 #endif /* __CONNMAN_IPCONFIG_H */