Rename D-Bus helper for basic property types
[framework/connectivity/connman.git] / include / dbus.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_DBUS_H
23 #define __CONNMAN_DBUS_H
24
25 #include <dbus/dbus.h>
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 #define CONNMAN_SERVICE                 "org.moblin.connman"
32
33 #define CONNMAN_DEBUG_INTERFACE         CONNMAN_SERVICE ".Debug"
34 #define CONNMAN_ERROR_INTERFACE         CONNMAN_SERVICE ".Error"
35 #define CONNMAN_AGENT_INTERFACE         CONNMAN_SERVICE ".Agent"
36
37 #define CONNMAN_MANAGER_INTERFACE       CONNMAN_SERVICE ".Manager"
38 #define CONNMAN_MANAGER_PATH            "/"
39
40 #define CONNMAN_TASK_INTERFACE          CONNMAN_SERVICE ".Task"
41 #define CONNMAN_PROFILE_INTERFACE       CONNMAN_SERVICE ".Profile"
42 #define CONNMAN_SERVICE_INTERFACE       CONNMAN_SERVICE ".Service"
43 #define CONNMAN_DEVICE_INTERFACE        CONNMAN_SERVICE ".Device"
44 #define CONNMAN_NETWORK_INTERFACE       CONNMAN_SERVICE ".Network"
45 #define CONNMAN_PROVIDER_INTERFACE      CONNMAN_SERVICE ".Provider"
46
47 typedef void (* connman_dbus_append_cb_t) (DBusMessageIter *iter,
48                                                         void *user_data);
49
50 DBusConnection *connman_dbus_get_connection(void);
51
52 void connman_dbus_property_append_basic(DBusMessageIter *iter,
53                                         const char *key, int type, void *val);
54 void connman_dbus_property_append_dict(DBusMessageIter *iter, const char *key,
55                         connman_dbus_append_cb_t function, void *user_data);
56 void connman_dbus_property_append_fixed_array(DBusMessageIter *iter,
57                                 const char *key, int type, void *val, int len);
58 void connman_dbus_property_append_variable_array(DBusMessageIter *dict,
59                 const char *key, int type, connman_dbus_append_cb_t function);
60
61 dbus_bool_t connman_dbus_property_changed_basic(const char *path,
62                                 const char *interface, const char *key,
63                                                         int type, void *val);
64 dbus_bool_t connman_dbus_property_changed_dict(const char *path,
65                                 const char *interface, const char *key,
66                         connman_dbus_append_cb_t function, void *user_data);
67
68 static inline void connman_dbus_dict_open(DBusMessageIter *iter,
69                                                         DBusMessageIter *dict)
70 {
71         dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
72                         DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
73                         DBUS_TYPE_STRING_AS_STRING DBUS_TYPE_VARIANT_AS_STRING
74                         DBUS_DICT_ENTRY_END_CHAR_AS_STRING, dict);
75 }
76
77 static inline void connman_dbus_dict_close(DBusMessageIter *iter,
78                                                         DBusMessageIter *dict)
79 {
80         dbus_message_iter_close_container(iter, dict);
81 }
82
83 static inline void connman_dbus_dict_append_variant(DBusMessageIter *dict,
84                                         const char *key, int type, void *val)
85 {
86         DBusMessageIter entry;
87
88         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
89                                                                 NULL, &entry);
90         connman_dbus_property_append_basic(&entry, key, type, val);
91         dbus_message_iter_close_container(dict, &entry);
92 }
93
94 static inline void connman_dbus_dict_append_dict(DBusMessageIter *dict,
95                         const char *key, connman_dbus_append_cb_t function)
96 {
97         DBusMessageIter entry;
98
99         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
100                                                                 NULL, &entry);
101         connman_dbus_property_append_dict(&entry, key, function, NULL);
102         dbus_message_iter_close_container(dict, &entry);
103 }
104
105 static inline void connman_dbus_dict_append_fixed_array(DBusMessageIter *dict,
106                                 const char *key, int type, void *val, int len)
107 {
108         DBusMessageIter entry;
109
110         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
111                                                                 NULL, &entry);
112         connman_dbus_property_append_fixed_array(&entry, key, type, val, len);
113         dbus_message_iter_close_container(dict, &entry);
114 }
115
116 static inline void connman_dbus_dict_append_variable_array(DBusMessageIter *dict,
117                 const char *key, int type, connman_dbus_append_cb_t function)
118 {
119         DBusMessageIter entry;
120
121         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
122                                                                 NULL, &entry);
123         connman_dbus_property_append_variable_array(&entry, key,
124                                                         type, function);
125         dbus_message_iter_close_container(dict, &entry);
126 }
127
128 dbus_bool_t connman_dbus_validate_ident(const char *ident);
129 char *connman_dbus_encode_string(const char *value);
130
131 #ifdef __cplusplus
132 }
133 #endif
134
135 #endif /* __CONNMAN_DBUS_H */