4 #define DBUS_API_SUBJECT_TO_CHANGE
16 # define DBUS_API_SUBJECT_TO_CHANGE
19 #include <dbus/dbus.h>
27 # ifdef EFL_EDBUS_BUILD
29 # define EAPI __declspec(dllexport)
32 # endif /* ! DLL_EXPORT */
34 # define EAPI __declspec(dllimport)
35 # endif /* ! EFL_EDBUS_BUILD */
39 # define EAPI __attribute__ ((visibility("default")))
51 * @section edbus_intro_sec Introduction
53 * EDbus is a wrapper around the
54 * <a href="http://www.freedesktop.org/wiki/Software/dbus">dbus</a>
55 * library, which is a message bus system. It also implement a set of
56 * specifications using dbus as interprocess comunication.
58 * @section edbus_modules_sec Modules
60 * @li @ref EDbus_Group Wrapper around the dbus library, which
61 * implementent an inter-process communication (IPC) system for
62 * software applications to communicate with one another.
63 * @li @ref EBluez_Group Implementation of the <a
64 * href="http://www.bluez.org/">BlueZ</a> specifications, for wireless
65 * communications with Bleutooth devices.
66 * @li @ref EConnman_Group Implementation of the <a
67 * href="http://connman.net/">connman</a> specifications, which
68 * manages internet connections within embedded devices running the
69 * Linux operating system.
70 * @li @ref EHal_Group Implementation of the <a
71 * href="http://www.freedesktop.org/wiki/Software/hal">HAL</a>
72 * specifications, which is a (software) layer between the hardware
73 * devices of a computer and the softwares that run on that
74 * computer (Hardware Abstraction Layer). HAL is deprecated, in favor
76 * @li @ref ENotify_Group To de described.
77 * @li @ref EOfono_Group Implementation of the <a
78 * href="http://ofono.org/">ofono</a> specifications, which is an
79 * interface for mobile telephony applications.
80 * @li @ref EUkit_Group Implementation of the <a
81 * href="http://freedesktop.org/wiki/Software/DeviceKit">DeviceKit</a>
82 * specifications, which is, like HAL, an Hardware Abstraction
83 * Layer. DeviceKit is a replacement of the deprecated HAL system. It
84 * has two submodules: UDisks, which manipulate storage devices, and
85 * UPower, which manage power devices.
89 * @defgroup EDbus_Group EDbus
94 #define E_DBUS_FDO_BUS "org.freedesktop.DBus"
95 #define E_DBUS_FDO_PATH "/org/freedesktop/DBus"
96 #define E_DBUS_FDO_INTERFACE E_DBUS_FDO_BUS
101 EAPI extern int E_DBUS_DOMAIN_GLOBAL;
102 EAPI extern int E_DBUS_EVENT_SIGNAL;
104 typedef struct E_DBus_Connection E_DBus_Connection;
105 typedef struct E_DBus_Object E_DBus_Object;
106 typedef struct E_DBus_Interface E_DBus_Interface;
107 typedef struct E_DBus_Signal_Handler E_DBus_Signal_Handler;
109 typedef DBusMessage *(* E_DBus_Method_Cb)(E_DBus_Object *obj, DBusMessage *message);
110 typedef void (*E_DBus_Method_Return_Cb) (void *data, DBusMessage *msg, DBusError *error);
111 typedef void (*E_DBus_Signal_Cb) (void *data, DBusMessage *msg);
113 typedef void (*E_DBus_Object_Property_Get_Cb) (E_DBus_Object *obj, const char *property, int *type, void **value);
114 typedef int (*E_DBus_Object_Property_Set_Cb) (E_DBus_Object *obj, const char *property, int type, void *value);
117 * A callback function for a DBus call
118 * @param user_data the data passed in to the method call
119 * @param event_data a struct containing the return data.
121 typedef void (*E_DBus_Callback_Func) (void *user_data, void *method_return, DBusError *error);
122 typedef void *(*E_DBus_Unmarshal_Func) (DBusMessage *msg, DBusError *err);
123 typedef void (*E_DBus_Free_Func) (void *data);
125 typedef struct E_DBus_Callback E_DBus_Callback;
128 EAPI int e_dbus_init(void);
129 EAPI int e_dbus_shutdown(void);
131 /* setting up the connection */
133 EAPI E_DBus_Connection *e_dbus_bus_get(DBusBusType type);
135 EAPI void e_dbus_connection_ref(E_DBus_Connection *conn);
137 EAPI E_DBus_Connection *e_dbus_connection_setup(DBusConnection *conn);
138 EAPI void e_dbus_connection_close(E_DBus_Connection *conn);
140 /* receiving method calls */
141 EAPI E_DBus_Interface *e_dbus_interface_new(const char *interface);
142 EAPI void e_dbus_interface_ref(E_DBus_Interface *iface);
143 EAPI void e_dbus_interface_unref(E_DBus_Interface *iface);
144 EAPI void e_dbus_object_interface_attach(E_DBus_Object *obj, E_DBus_Interface *iface);
145 EAPI void e_dbus_object_interface_detach(E_DBus_Object *obj, E_DBus_Interface *iface);
146 EAPI int e_dbus_interface_method_add(E_DBus_Interface *iface, const char *member, const char *signature, const char *reply_signature, E_DBus_Method_Cb func);
148 EAPI int e_dbus_interface_signal_add(E_DBus_Interface *iface, const char *name, const char *signature);
150 EAPI E_DBus_Object *e_dbus_object_add(E_DBus_Connection *conn, const char *object_path, void *data);
151 EAPI void e_dbus_object_free(E_DBus_Object *obj);
152 EAPI void *e_dbus_object_data_get(E_DBus_Object *obj);
153 EAPI E_DBus_Connection *e_dbus_object_conn_get(E_DBus_Object *obj);
154 EAPI const char *e_dbus_object_path_get(E_DBus_Object *obj);
155 EAPI const Eina_List *e_dbus_object_interfaces_get(E_DBus_Object *obj);
157 EAPI void e_dbus_object_property_get_cb_set(E_DBus_Object *obj, E_DBus_Object_Property_Get_Cb func);
158 EAPI void e_dbus_object_property_set_cb_set(E_DBus_Object *obj, E_DBus_Object_Property_Set_Cb func);
161 /* sending method calls */
164 EAPI DBusPendingCall *e_dbus_message_send(E_DBus_Connection *conn, DBusMessage *msg, E_DBus_Method_Return_Cb cb_return, int timeout, void *data);
166 EAPI DBusPendingCall *e_dbus_method_call_send(E_DBus_Connection *conn, DBusMessage *msg, E_DBus_Unmarshal_Func unmarshal_func, E_DBus_Callback_Func cb_func, E_DBus_Free_Func free_func, int timeout, void *data);
169 /* signal receiving */
171 EAPI E_DBus_Signal_Handler *e_dbus_signal_handler_add(E_DBus_Connection *conn, const char *sender, const char *path, const char *interface, const char *member, E_DBus_Signal_Cb cb_signal, void *data);
172 EAPI void e_dbus_signal_handler_del(E_DBus_Connection *conn, E_DBus_Signal_Handler *sh);
174 /* standard dbus method calls */
176 EAPI DBusPendingCall *e_dbus_request_name(E_DBus_Connection *conn, const char *name,
178 E_DBus_Method_Return_Cb cb_return,
180 EAPI DBusPendingCall *e_dbus_release_name(E_DBus_Connection *conn, const char *name,
181 E_DBus_Method_Return_Cb cb_return,
184 EAPI DBusPendingCall *e_dbus_get_name_owner(E_DBus_Connection *conn, const char *name,
185 E_DBus_Method_Return_Cb cb_return,
187 EAPI DBusPendingCall *e_dbus_list_names(E_DBus_Connection *conn,
188 E_DBus_Method_Return_Cb cb_return,
190 EAPI DBusPendingCall *e_dbus_list_activatable_names(E_DBus_Connection *conn,
191 E_DBus_Method_Return_Cb cb_return,
193 EAPI DBusPendingCall *e_dbus_name_has_owner(E_DBus_Connection *conn, const char *name,
194 E_DBus_Method_Return_Cb cb_return,
196 EAPI DBusPendingCall *e_dbus_start_service_by_name(E_DBus_Connection *conn, const char *name, unsigned int flags,
197 E_DBus_Method_Return_Cb cb_return,
200 /* standard methods calls on objects */
201 EAPI DBusPendingCall *e_dbus_introspect(E_DBus_Connection *conn, const char *bus,
202 const char *object_path, E_DBus_Method_Return_Cb cb_return, const void *data);
203 EAPI DBusPendingCall *e_dbus_peer_ping(E_DBus_Connection *conn, const char *destination,
204 const char *path, E_DBus_Method_Return_Cb cb_return,
206 EAPI DBusPendingCall *e_dbus_peer_get_machine_id(E_DBus_Connection *conn,
207 const char *destination, const char *path,
208 E_DBus_Method_Return_Cb cb_return,
210 EAPI DBusPendingCall *e_dbus_properties_get_all(E_DBus_Connection *conn, const char *destination,
211 const char *path, const char *interface,
212 E_DBus_Method_Return_Cb cb_return,
214 EAPI DBusPendingCall *e_dbus_properties_get(E_DBus_Connection *conn, const char *destination,
215 const char *path, const char *interface,
216 const char *property,
217 E_DBus_Method_Return_Cb cb_return,
219 EAPI DBusPendingCall *e_dbus_properties_set(E_DBus_Connection *conn, const char *destination,
220 const char *path, const char *interface,
221 const char *property, int value_type,
222 const void *value, E_DBus_Method_Return_Cb cb_return,
226 EAPI E_DBus_Callback *e_dbus_callback_new(E_DBus_Callback_Func cb_func, E_DBus_Unmarshal_Func unmarshal_func, E_DBus_Free_Func free_func, void *user_data);
228 EAPI void e_dbus_callback_free(E_DBus_Callback *callback);
229 EAPI void e_dbus_callback_call(E_DBus_Callback *cb, void *data, DBusError *error);
230 EAPI void *e_dbus_callback_unmarshal(E_DBus_Callback *cb, DBusMessage *msg, DBusError *err);
231 EAPI void e_dbus_callback_return_free(E_DBus_Callback *callback, void *data);