Add user data parameter to dictionary helpers
[platform/upstream/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 *iter,
59                                                 const char *key, int type,
60                         connman_dbus_append_cb_t function, void *user_data);
61
62 dbus_bool_t connman_dbus_property_changed_basic(const char *path,
63                                 const char *interface, const char *key,
64                                                         int type, void *val);
65 dbus_bool_t connman_dbus_property_changed_dict(const char *path,
66                                 const char *interface, const char *key,
67                         connman_dbus_append_cb_t function, void *user_data);
68
69 static inline void connman_dbus_dict_open(DBusMessageIter *iter,
70                                                         DBusMessageIter *dict)
71 {
72         dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
73                         DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
74                         DBUS_TYPE_STRING_AS_STRING DBUS_TYPE_VARIANT_AS_STRING
75                         DBUS_DICT_ENTRY_END_CHAR_AS_STRING, dict);
76 }
77
78 static inline void connman_dbus_dict_close(DBusMessageIter *iter,
79                                                         DBusMessageIter *dict)
80 {
81         dbus_message_iter_close_container(iter, dict);
82 }
83
84 static inline void connman_dbus_dict_append_basic(DBusMessageIter *dict,
85                                         const char *key, int type, void *val)
86 {
87         DBusMessageIter entry;
88
89         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
90                                                                 NULL, &entry);
91         connman_dbus_property_append_basic(&entry, key, type, val);
92         dbus_message_iter_close_container(dict, &entry);
93 }
94
95 static inline void connman_dbus_dict_append_dict(DBusMessageIter *dict,
96                         const char *key, connman_dbus_append_cb_t function,
97                                                         void *user_data)
98 {
99         DBusMessageIter entry;
100
101         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
102                                                                 NULL, &entry);
103         connman_dbus_property_append_dict(&entry, key, function, user_data);
104         dbus_message_iter_close_container(dict, &entry);
105 }
106
107 static inline void connman_dbus_dict_append_fixed_array(DBusMessageIter *dict,
108                                 const char *key, int type, void *val, int len)
109 {
110         DBusMessageIter entry;
111
112         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
113                                                                 NULL, &entry);
114         connman_dbus_property_append_fixed_array(&entry, key, type, val, len);
115         dbus_message_iter_close_container(dict, &entry);
116 }
117
118 static inline void connman_dbus_dict_append_variable_array(DBusMessageIter *dict,
119                 const char *key, int type, connman_dbus_append_cb_t function,
120                                                         void *user_data)
121 {
122         DBusMessageIter entry;
123
124         dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY,
125                                                                 NULL, &entry);
126         connman_dbus_property_append_variable_array(&entry, key,
127                                                 type, function, user_data);
128         dbus_message_iter_close_container(dict, &entry);
129 }
130
131 dbus_bool_t connman_dbus_validate_ident(const char *ident);
132 char *connman_dbus_encode_string(const char *value);
133
134 #ifdef __cplusplus
135 }
136 #endif
137
138 #endif /* __CONNMAN_DBUS_H */