Add skeletons for IP operation callbacks
[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 enum connman_ipconfig_type {
36         CONNMAN_IPCONFIG_TYPE_UNKNOWN = 0,
37         CONNMAN_IPCONFIG_TYPE_IPV4    = 1,
38         CONNMAN_IPCONFIG_TYPE_IPV6    = 2,
39 };
40
41 enum connman_ipconfig_method {
42         CONNMAN_IPCONFIG_METHOD_UNKNOWN = 0,
43         CONNMAN_IPCONFIG_METHOD_OFF     = 1,
44         CONNMAN_IPCONFIG_METHOD_STATIC  = 2,
45         CONNMAN_IPCONFIG_METHOD_DHCP    = 3,
46 };
47
48 struct connman_ipconfig;
49
50 struct connman_ipconfig_ops {
51         void (*up) (struct connman_ipconfig *ipconfig);
52         void (*down) (struct connman_ipconfig *ipconfig);
53         void (*lower_up) (struct connman_ipconfig *ipconfig);
54         void (*lower_down) (struct connman_ipconfig *ipconfig);
55 };
56
57 struct connman_ipconfig *connman_ipconfig_create(int index);
58 struct connman_ipconfig *connman_ipconfig_ref(struct connman_ipconfig *ipconfig);
59 void connman_ipconfig_unref(struct connman_ipconfig *ipconfig);
60
61 void *connman_ipconfig_get_data(struct connman_ipconfig *ipconfig);
62 void connman_ipconfig_set_data(struct connman_ipconfig *ipconfig, void *data);
63
64 void connman_ipconfig_set_ops(struct connman_ipconfig *ipconfig,
65                                         struct connman_ipconfig_ops *ops);
66
67 int connman_ipconfig_set_method(struct connman_ipconfig *ipconfig,
68                                         enum connman_ipconfig_method method);
69
70 #define CONNMAN_IPCONFIG_PRIORITY_LOW      -100
71 #define CONNMAN_IPCONFIG_PRIORITY_DEFAULT     0
72 #define CONNMAN_IPCONFIG_PRIORITY_HIGH      100
73
74 struct connman_ipconfig_driver {
75         const char *name;
76         enum connman_ipconfig_type type;
77         int priority;
78         int (*request) (const char *interface);
79         int (*release) (const char *interface);
80         int (*renew) (const char *interface);
81 };
82
83 int connman_ipconfig_driver_register(struct connman_ipconfig_driver *driver);
84 void connman_ipconfig_driver_unregister(struct connman_ipconfig_driver *driver);
85
86 #ifdef __cplusplus
87 }
88 #endif
89
90 #endif /* __CONNMAN_IPCONFIG_H */