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