X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fdbus-faq.xml;h=69ac3f159ada66073433c71a41dcda8313cffe96;hb=e9762e1542449601ff23b0c5fc8d6764e0898d3f;hp=773acee721833d9afbd9aa2c27fad4c61e14e5e4;hpb=76ee87af5b5007839012259304cce50a43e69638;p=platform%2Fupstream%2Fdbus.git diff --git a/doc/dbus-faq.xml b/doc/dbus-faq.xml index 773acee..69ac3f1 100644 --- a/doc/dbus-faq.xml +++ b/doc/dbus-faq.xml @@ -6,9 +6,9 @@
- D-BUS FAQ - Version 0.1 - 22 January 2005 + D-Bus FAQ + Version 0.3 + 17 November 2006 Havoc @@ -22,6 +22,7 @@ David + A Wheeler @@ -32,15 +33,19 @@ - What is D-BUS? + What is D-Bus? - This is probably best answered by reading the D-BUS tutorial. In + This is probably best answered by reading the D-Bus tutorial or + the introduction to the specification. In short, it is a system consisting of 1) a wire protocol for exposing a typical object-oriented language/framework to other applications; and 2) a bus daemon that allows applications to find and monitor one another. + Phrased differently, D-Bus is 1) an interprocess communication (IPC) system and 2) some higher-level + structure (lifecycle tracking, service activation, security policy) provided by two bus daemons, + one systemwide and one per-user-session. @@ -48,17 +53,18 @@ - Is D-BUS stable/finished? + Is D-Bus stable/finished? - D-BUS has not yet reached 1.0. The README - file has a discussion of the API/ABI stability guarantees before and - after 1.0. In short, there are no guarantees before 1.0, and stability - of both protocol and reference library will be maintained after 1.0. - As of January 2005 we don't expect major protocol or API changes prior - to the 1.0 release, but anything is possible. + The low-level library "libdbus" and the protocol specification are considered + ABI stable. The README + file has a discussion of the API/ABI stability guarantees. + Higher-level bindings (such as those for Qt, GLib, Python, Java, C#) each + have their own release schedules and degree of maturity, not linked to + the low-level library and bus daemon release. Check the project page for + the binding you're considering to understand that project's policies. @@ -79,8 +85,8 @@ as well. The AFL is an "X-style" or "BSD-style" license compatible with proprietary licensing, but it does have some requirements; in particular it prohibits you from filing a lawsuit alleging that the - D-BUS software infringes your patents while you continue to - use D-BUS. If you're going to sue, you have to stop using + D-Bus software infringes your patents while you continue to + use D-Bus. If you're going to sue, you have to stop using the software. Read the licenses to determine their meaning, this FAQ entry is not intended to change the meaning or terms of the licenses. @@ -96,11 +102,10 @@ - If you imagine a C++ program that implements a network - service, then the bus name is the domain name - of the computer running this C++ program, the object path - is a C++ object instance pointer, and an interface is a C++ - class (a pure virtual or abstract class, to be exact). + If you imagine a C++ program that implements a network service, then + the bus name is the hostname of the computer running this C++ program, + the object path is a C++ object instance pointer, and an interface is + a C++ class (a pure virtual or abstract class, to be exact). In Java terms, the object path is an object reference, @@ -119,11 +124,12 @@ However, a text editor application could as easily own multiple bus - names (for example, org.kde.KWrite), have multiple - objects (maybe /org/kde/documents/4352), - and each object could implement multiple interfaces, - such as org.freedesktop.Introspectable, - org.freedesktop.BasicTextField, + names (for example, org.kde.KWrite in addition to + generic TextEditor), have multiple objects (maybe + /org/kde/documents/4352 where the number changes + according to the document), and each object could implement multiple + interfaces, such as org.freedesktop.DBus.Introspectable, + org.freedesktop.BasicTextField, org.kde.RichTextDocument. @@ -143,18 +149,45 @@ are normally launched according to the bus name they will have. + + People often misuse the word "service" for any + bus name, but this tends to be ambiguous and confusing so is discouraged. + In the D-Bus docs we try to use "service" only when talking about + programs the bus knows how to launch, i.e. a service always has a + .service file. + - Is D-BUS a "component system"? + Is D-Bus a "component system"? - D-BUS is not a component system. "Component system" was originally + It helps to keep these concepts separate in your mind: + + + + Object/component system + + + + + GUI control/widget embedding interfaces + + + + + Interprocess communication system or wire protocol + + + + + + D-Bus is not a component system. "Component system" was originally defined by COM, and was essentially a workaround for the limitations of the C++ object system (adding introspection, runtime location of objects, ABI guarantees, and so forth). With the C# language and CLR, @@ -176,10 +209,13 @@ in modern languages all objects are effectively "components." - A third, orthogonal feature is interprocess communication or IPC. - D-BUS is an IPC system. Given an object (or "component" if you must), + So components are fancy objects, and some objects are GUI controls. + + + A third, unrelated feature is interprocess communication or IPC. + D-Bus is an IPC system. Given an object (or "component" if you must), you can expose the functionality of that object over an IPC system. - Examples of IPC systems are DCOM, CORBA, SOAP, XML-RPC, and D-BUS. + Examples of IPC systems are DCOM, CORBA, SOAP, XML-RPC, and D-Bus. You can use any of these IPC systems with any object/component system, though some of them are "tuned" for specific object systems. You can think of an IPC system primarily as a wire protocol. @@ -189,26 +225,6 @@ then you can have an out-of-process or dynamically-loaded GUI control. - Summarizing, there are three orthogonal things: - - - - Object/component system - - - - - Control embedding interfaces - - - - - Interprocess communication system or wire protocol - - - - - Another related concept is the plugin or extension. Generic plugin systems such as the Eclipse system are not so different @@ -222,7 +238,7 @@ - How fast is the D-BUS reference implementation? + How fast is the D-Bus reference implementation? @@ -230,13 +246,13 @@ Of course it depends a bit on what you're doing. This mail contains some benchmarking. At the time of that - benchmark, D-BUS one-to-one communication was about 2.5x slower than + benchmark, D-Bus one-to-one communication was about 2.5x slower than simply pushing the data raw over a socket. After the recent rewrite of - the marshaling code, D-BUS is slower than that because a lot of + the marshaling code, D-Bus is slower than that because a lot of optimization work was lost. But it can probably be sped up again. - D-BUS communication with the intermediate bus daemon should be + D-Bus communication with the intermediate bus daemon should be (and as last profiled, was) about twice as slow as one-to-one mode, because a round trip involves four socket reads/writes rather than two socket reads/writes. @@ -251,7 +267,7 @@ not a good idea all things considered. - Raw bandwidth isn't the only concern; D-BUS is designed to + Raw bandwidth isn't the only concern; D-Bus is designed to enable asynchronous communication and avoid round trips. This is frequently a more important performance issue than throughput. @@ -263,7 +279,7 @@ - How large is the D-BUS reference implementation? + How large is the D-Bus reference implementation? @@ -282,39 +298,44 @@ - How does D-BUS differ from other interprocess communication + How does D-Bus differ from other interprocess communication or networking protocols? - The best place to start is to read the D-BUS tutorial, so - you have a concrete idea what D-BUS actually is. If you + Keep in mind, it is not only an IPC system; it also includes + lifecycle tracking, service activation, security policy, and other + higher-level structure and assumptions. + + + The best place to start is to read the D-Bus tutorial, so + you have a concrete idea what D-Bus actually is. If you understand other protocols on a wire format level, you - may also want to read the D-BUS specification to see what - D-BUS looks like on a low level. + may also want to read the D-Bus specification to see what + D-Bus looks like on a low level. - As the tutorial and specification both explain, D-BUS is tuned + As the tutorial and specification both explain, D-Bus is tuned for some specific use cases. Thus, it probably isn't tuned for what you want to do, unless you are doing the things - D-BUS was designed for. Don't make the mistake of thinking - that any system labeled "IPC" is the same thing. + D-Bus was designed for. Don't make the mistake of thinking + that any system involving "IPC" is the same thing. - The D-BUS authors would not recommend using D-BUS + The D-Bus authors would not recommend using D-Bus for applications where it doesn't make sense. - The following questions compare D-BUS to some other - protocols primarily to help you understand D-BUS - and decide whether it's appropriate; D-BUS is neither intended + The following questions compare D-Bus to some other + protocols primarily to help you understand D-Bus + and decide whether it's appropriate; D-Bus is neither intended nor claimed to be the right choice for every application. - It should be possible to bridge D-BUS to other IPC systems, - just as D-BUS can be bridged to object systems. + It should be possible to bridge D-Bus to other IPC systems, + just as D-Bus can be bridged to object systems. - Note: the D-BUS mailing list subscribers are very much not + Note: the D-Bus mailing list subscribers are very much not interested in debating which IPC system is the One True System. So if you want to discuss that, please use another forum. @@ -325,7 +346,7 @@ - How does D-BUS differ from CORBA? + How does D-Bus differ from CORBA? @@ -359,18 +380,18 @@ SOAP are the latest fad. - Like D-BUS, CORBA uses a fast binary protocol (IIOP). Both systems + Like D-Bus, CORBA uses a fast binary protocol (IIOP). Both systems work in terms of objects and methods, and have concepts such as - "oneway" calls. Only D-BUS has direct support for "signals" as in + "oneway" calls. Only D-Bus has direct support for "signals" as in GLib/Qt (or Java listeners, or C# delegates). - D-BUS hardcodes and specifies a lot of things that CORBA leaves open-ended, - because CORBA is more generic and D-BUS has two specific use-cases in mind. - This makes D-BUS a bit simpler. + D-Bus hardcodes and specifies a lot of things that CORBA leaves open-ended, + because CORBA is more generic and D-Bus has two specific use-cases in mind. + This makes D-Bus a bit simpler. - However, unlike CORBA D-BUS does not specify the + However, unlike CORBA D-Bus does not specify the API for the language bindings. Instead, "native" bindings adapted specifically to the conventions of a framework such as QObject, GObject, C#, Java, Python, etc. are encouraged. The libdbus reference @@ -382,14 +403,14 @@ Many CORBA implementations such as ORBit are faster than the libdbus - reference implementation. One reason is that D-BUS considers data + reference implementation. One reason is that D-Bus considers data from the other end of the connection to be untrusted and extensively validates it. But generally speaking other priorities were placed - ahead of raw speed in the libdbus implementation. A fast D-BUS + ahead of raw speed in the libdbus implementation. A fast D-Bus implementation along the lines of ORBit should be possible, of course. - On a more trivial note, D-BUS involves substantially fewer acronyms + On a more trivial note, D-Bus involves substantially fewer acronyms than CORBA. @@ -399,7 +420,7 @@ - How does D-BUS differ from XML-RPC and SOAP? + How does D-Bus differ from XML-RPC and SOAP? @@ -420,7 +441,7 @@ constant fine-grained IPC among applications in a desktop session. - D-BUS offers persistent connections and with the bus daemon + D-Bus offers persistent connections and with the bus daemon supports lifecycle tracking of other applications connected to the bus. With XML-RPC and SOAP, typically each method call exists in isolation and has its own HTTP connection. @@ -431,7 +452,7 @@ - How does D-BUS differ from DCE? + How does D-Bus differ from DCE? @@ -446,7 +467,7 @@ has released an implementation as open source software. DCE is quite capable, and includes a vast amount of functionality such as a distributed time service. As the name implies, DCE is intended for - use in a large, multi-computer distributed application. D-BUS would + use in a large, multi-computer distributed application. D-Bus would not be well-suited for this. @@ -456,7 +477,7 @@ - How does D-BUS differ from DCOM and COM? + How does D-Bus differ from DCOM and COM? @@ -464,7 +485,7 @@ Start by reading . - Comparing D-BUS to COM is apples and oranges; + Comparing D-Bus to COM is apples and oranges; see . @@ -477,7 +498,7 @@ - How does D-BUS differ from ZeroC's Internet Communications Engine (Ice) + How does D-Bus differ from ZeroC's Internet Communications Engine (Ice) @@ -487,7 +508,7 @@ The Internet Communications Engine (Ice) is a powerful IPC mechanism more - on the level of SOAP or CORBA than D-BUS. Ice has a "dual-license" + on the level of SOAP or CORBA than D-Bus. Ice has a "dual-license" business around it; i.e. you can use it under the GPL, or pay for a proprietary license. @@ -497,7 +518,7 @@ - How does D-BUS differ from Inter-Client Exchange (ICE)? + How does D-Bus differ from Inter-Client Exchange (ICE)? @@ -509,7 +530,7 @@ ICE is a binary protocol designed for desktop use, and KDE's DCOP - builds on ICE. ICE is substantially simpler than D-BUS (in contrast + builds on ICE. ICE is substantially simpler than D-Bus (in contrast to most of the other IPC systems mentioned here, which are more complex). ICE doesn't really define a mapping to objects and methods (DCOP adds that layer). The reference implementation of ICE (libICE) @@ -517,7 +538,7 @@ DCOP and XSMP are the only two widely-used applications of ICE, - and both could in principle be replaced by D-BUS. (Though whether + and both could in principle be replaced by D-Bus. (Though whether GNOME and KDE will bother is an open question.) @@ -528,7 +549,7 @@ - How does D-BUS differ from DCOP? + How does D-Bus differ from DCOP? @@ -536,15 +557,15 @@ Start by reading . - D-BUS is intentionally pretty similar to DCOP, and can be thought of as a "DCOP the next generation" suitable for sharing between the various open source desktop projects. - D-BUS is a bit more complex than DCOP, though the Qt binding for D-BUS + D-Bus is a bit more complex than DCOP, though the Qt binding for D-Bus should not be more complex for programmers. The additional complexity - of D-BUS arises from its separation of object references vs. bus names + of D-Bus arises from its separation of object references vs. bus names vs. interfaces as distinct concepts, and its support for one-to-one connections in addition to connections over the bus. The libdbus reference implementation has a lot of API to support multiple bindings @@ -552,14 +573,14 @@ in order to support secure applications such as the systemwide bus. - D-BUS is probably somewhat slower than DCOP due to data validation + D-Bus is probably somewhat slower than DCOP due to data validation and more "layers" in the reference implementation. A comparison hasn't been posted to the list though. - At this time, KDE has not committed to using D-BUS, but there have - been discussions of KDE bridging D-BUS and DCOP, or even changing - DCOP's implementation to use D-BUS internally (so that GNOME and KDE + At this time, KDE has not committed to using D-Bus, but there have + been discussions of KDE bridging D-Bus and DCOP, or even changing + DCOP's implementation to use D-Bus internally (so that GNOME and KDE would end up using exactly the same bus). See the KDE mailing list archives for some of these discussions. @@ -570,7 +591,7 @@ - How does D-BUS differ from [yet more IPC mechanisms]? + How does D-Bus differ from [yet more IPC mechanisms]? @@ -603,22 +624,26 @@ If you're writing a desktop application for UNIX, - then D-BUS is of course our recommendation for + then D-Bus is of course our recommendation for talking to other parts of the desktop session. - (With the caveat that you should use a stable release - of D-BUS; until we reach 1.0, there isn't a stable release.) + + + D-Bus is also designed for communications between system daemons and + communications between the desktop and system daemons. If you're doing something complicated such as clustering, distributed swarms, peer-to-peer, or whatever then the authors of this FAQ don't have expertise in these areas and you should ask someone else or try a search engine. + D-Bus is most likely a poor choice but could be appropriate + for some things. - Note: the D-BUS mailing list is probably not the place to + Note: the D-Bus mailing list is probably not the place to discuss which system is appropriate for your application, though you are welcome to ask specific questions about - D-BUS after reading this FAQ, the tutorial, and + D-Bus after reading this FAQ, the tutorial, and searching the list archives. The best way to search the list archives is probably to use an Internet engine such as Google. On Google, @@ -636,7 +661,7 @@ - The D-BUS web site + The D-Bus web site has a link to the bug tracker, which is the best place to store patches. You can also post them to the list, especially if you want to discuss the patch or get feedback.