e_dbus: improve readme and news.
[framework/uifw/edbus.git] / README
1 E_dbus 1.1.0
2
3 ******************************************************************************
4
5  FOR ANY ISSUES PLEASE EMAIL:
6  enlightenment-devel@lists.sourceforge.net
7   
8 ******************************************************************************
9   
10 Requirements:
11 -------------
12
13 Must:
14   libc
15   libdbus
16   eina (at least 1.1.0)
17   ecore (at least 1.1.0)
18
19 Recommended:
20   evas (at least 1.1.0)
21
22 This is the start of some basic convenience wrappers around dbus to ease
23 integrating dbus with EFL based applications.
24
25 When using e_dbus, direct use of the low level dbus api is still heavily
26 required for processing messages.
27
28 A few things to note:
29
30 e_dbus_bus_get() currently creates a new private connection to whichever bus
31 is passed in, and hooks this into the ecore main loop. At some point, we
32 should implement internal refcounting and sharing of these private
33 connections (one for each bus type) so that e.g. multiple modules in an app
34 can reuse the same connection. libdbus implements its own shared connections
35 (available via dbus_bus_get()), but the final reference is always retained by
36 libdbus iteself, causing any cleanup handlers on the connection to only be
37 called at app exit. Thus, if a module hooks a connection in to the mainloop,
38 there is no way to clean up fully before unloading the module, causing issues.
39
40 Patches can be sent to the enlightenment dev mailing list, or, if you have
41 commit access, feel free to commit.
42
43
44 ABOUT PROVIDED MODULES:
45 -----------------------
46
47 E_DBus provides easy C API for some D-Bus services, the
48 org.freedesktop.DBus interface is implemented into libedbus/E_DBus.h
49 itself, while the following modules provides more and their respective
50 version:
51
52  * bluez(v4.9x): barebones to toggle state and change visibility.
53  * connman(v0.7x): complete manager, service and technology.
54  * hal(v0.5.x): deprecated, provides basic for e17. See ukit.
55  * notification(v0.7.x): complete client and server.
56  * ofono(v0.5x, v1.0): barebones to toggle state.
57  * ukit(upower-v0.9.x, udisks-1.0.x): most of upower, status api from udisks.
58
59 ------------------------------------------------------------------------------
60 COMPILING AND INSTALLING:
61
62   ./configure
63   make
64 (do this as root unless you are installing in your users directories):
65   make install
66