Rename IP configuration methods to match specification
[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_clear(struct connman_ipaddress *ipaddress);
45 void connman_ipaddress_copy(struct connman_ipaddress *ipaddress,
46                                         struct connman_ipaddress *source);
47
48 enum connman_ipconfig_type {
49         CONNMAN_IPCONFIG_TYPE_UNKNOWN = 0,
50         CONNMAN_IPCONFIG_TYPE_IPV4    = 1,
51         CONNMAN_IPCONFIG_TYPE_IPV6    = 2,
52 };
53
54 enum connman_ipconfig_method {
55         CONNMAN_IPCONFIG_METHOD_UNKNOWN = 0,
56         CONNMAN_IPCONFIG_METHOD_OFF     = 1,
57         CONNMAN_IPCONFIG_METHOD_MANUAL  = 2,
58         CONNMAN_IPCONFIG_METHOD_DHCP    = 3,
59 };
60
61 struct connman_ipconfig;
62
63 struct connman_ipconfig_ops {
64         void (*up) (struct connman_ipconfig *ipconfig);
65         void (*down) (struct connman_ipconfig *ipconfig);
66         void (*lower_up) (struct connman_ipconfig *ipconfig);
67         void (*lower_down) (struct connman_ipconfig *ipconfig);
68         void (*ip_bound) (struct connman_ipconfig *ipconfig);
69         void (*ip_release) (struct connman_ipconfig *ipconfig);
70 };
71
72 struct connman_ipconfig *connman_ipconfig_create(int index);
73 struct connman_ipconfig *connman_ipconfig_clone(struct connman_ipconfig *ipconfig);
74 struct connman_ipconfig *connman_ipconfig_ref(struct connman_ipconfig *ipconfig);
75 void connman_ipconfig_unref(struct connman_ipconfig *ipconfig);
76
77 void *connman_ipconfig_get_data(struct connman_ipconfig *ipconfig);
78 void connman_ipconfig_set_data(struct connman_ipconfig *ipconfig, void *data);
79
80 int connman_ipconfig_get_index(struct connman_ipconfig *ipconfig);
81 const char *connman_ipconfig_get_ifname(struct connman_ipconfig *ipconfig);
82
83 void connman_ipconfig_set_ops(struct connman_ipconfig *ipconfig,
84                                 const struct connman_ipconfig_ops *ops);
85
86 int connman_ipconfig_set_method(struct connman_ipconfig *ipconfig,
87                                         enum connman_ipconfig_method method);
88
89 void connman_ipconfig_bind(struct connman_ipconfig *ipconfig,
90                                         struct connman_ipaddress *ipaddress);
91
92 #define CONNMAN_IPCONFIG_PRIORITY_LOW      -100
93 #define CONNMAN_IPCONFIG_PRIORITY_DEFAULT     0
94 #define CONNMAN_IPCONFIG_PRIORITY_HIGH      100
95
96 struct connman_ipconfig_driver {
97         const char *name;
98         enum connman_ipconfig_type type;
99         int priority;
100         int (*request) (struct connman_ipconfig *ipconfig);
101         int (*release) (struct connman_ipconfig *ipconfig);
102         int (*renew) (struct connman_ipconfig *ipconfig);
103 };
104
105 int connman_ipconfig_driver_register(struct connman_ipconfig_driver *driver);
106 void connman_ipconfig_driver_unregister(struct connman_ipconfig_driver *driver);
107
108 #ifdef __cplusplus
109 }
110 #endif
111
112 #endif /* __CONNMAN_IPCONFIG_H */