Add documention for the elements
[connman] / include / property.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2008  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_PROPERTY_H
23 #define __CONNMAN_PROPERTY_H
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 /**
30  * SECTION:property
31  * @title: Property premitives
32  * @short_description: Functions for handling properties
33  */
34
35 enum connman_property_type {
36         CONNMAN_PROPERTY_TYPE_INVALID = 0,
37
38         CONNMAN_PROPERTY_TYPE_IPV4_ADDRESS,
39         CONNMAN_PROPERTY_TYPE_IPV4_NETMASK,
40         CONNMAN_PROPERTY_TYPE_IPV4_GATEWAY,
41         CONNMAN_PROPERTY_TYPE_IPV4_NAMESERVER,
42 };
43
44 enum connman_property_flags {
45         CONNMAN_PROPERTY_FLAG_STATIC = (1 << 0),
46 };
47
48 struct connman_property {
49         enum connman_property_flags flags;
50         char *name;
51         int type;
52         void *value;
53 };
54
55 #ifdef __cplusplus
56 }
57 #endif
58
59 #endif /* __CONNMAN_PROPERTY_H */