Add cleaner handling of IP address details
[platform/upstream/connman.git] / include / ipconfig.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2009  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         unsigned char prefixlen;
37         char *local;
38         char *peer;
39         char *broadcast;
40 };
41
42 struct connman_ipaddress *connman_ipaddress_alloc(void);
43 void connman_ipaddress_free(struct connman_ipaddress *ipaddress);
44 void connman_ipaddress_copy(struct connman_ipaddress *ipaddress,
45                                         struct connman_ipaddress *source);
46
47 enum connman_ipconfig_type {
48         CONNMAN_IPCONFIG_TYPE_UNKNOWN = 0,
49         CONNMAN_IPCONFIG_TYPE_IPV4    = 1,
50         CONNMAN_IPCONFIG_TYPE_IPV6    = 2,
51 };
52
53 enum connman_ipconfig_method {
54         CONNMAN_IPCONFIG_METHOD_UNKNOWN = 0,
55         CONNMAN_IPCONFIG_METHOD_IGNORE  = 1,
56         CONNMAN_IPCONFIG_METHOD_STATIC  = 2,
57         CONNMAN_IPCONFIG_METHOD_DHCP    = 3,
58 };
59
60 struct connman_ipconfig;
61
62 struct connman_ipconfig_ops {
63         void (*up) (struct connman_ipconfig *ipconfig);
64         void (*down) (struct connman_ipconfig *ipconfig);
65         void (*lower_up) (struct connman_ipconfig *ipconfig);
66         void (*lower_down) (struct connman_ipconfig *ipconfig);
67 };
68
69 struct connman_ipconfig *connman_ipconfig_create(int index);
70 struct connman_ipconfig *connman_ipconfig_ref(struct connman_ipconfig *ipconfig);
71 void connman_ipconfig_unref(struct connman_ipconfig *ipconfig);
72
73 void *connman_ipconfig_get_data(struct connman_ipconfig *ipconfig);
74 void connman_ipconfig_set_data(struct connman_ipconfig *ipconfig, void *data);
75
76 int connman_ipconfig_get_index(struct connman_ipconfig *ipconfig);
77 const char *connman_ipconfig_get_ifname(struct connman_ipconfig *ipconfig);
78
79 void connman_ipconfig_set_ops(struct connman_ipconfig *ipconfig,
80                                 const struct connman_ipconfig_ops *ops);
81
82 int connman_ipconfig_set_method(struct connman_ipconfig *ipconfig,
83                                         enum connman_ipconfig_method method);
84
85 void connman_ipconfig_bind(struct connman_ipconfig *ipconfig,
86                                         struct connman_ipaddress *ipaddress);
87
88 #define CONNMAN_IPCONFIG_PRIORITY_LOW      -100
89 #define CONNMAN_IPCONFIG_PRIORITY_DEFAULT     0
90 #define CONNMAN_IPCONFIG_PRIORITY_HIGH      100
91
92 struct connman_ipconfig_driver {
93         const char *name;
94         enum connman_ipconfig_type type;
95         int priority;
96         int (*request) (struct connman_ipconfig *ipconfig);
97         int (*release) (struct connman_ipconfig *ipconfig);
98         int (*renew) (struct connman_ipconfig *ipconfig);
99 };
100
101 int connman_ipconfig_driver_register(struct connman_ipconfig_driver *driver);
102 void connman_ipconfig_driver_unregister(struct connman_ipconfig_driver *driver);
103
104 #ifdef __cplusplus
105 }
106 #endif
107
108 #endif /* __CONNMAN_IPCONFIG_H */