doc/dbus-specification.xml

   1 <?xml version="1.0" standalone="no" ?>
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5 ]>
   6 <article id="index">
   7   <articleinfo>
   8     <title>D-Bus Specification</title>
   9     <releaseinfo>Version 0.17</releaseinfo>
  10     <date>2011-06-01</date>
  11     <authorgroup>
  12       <author>
  13         <firstname>Havoc</firstname>
  14         <surname>Pennington</surname>
  15         <affiliation>
  16           <orgname>Red Hat, Inc.</orgname>
  17           <address>
  18             <email>hp@pobox.com</email>
  19           </address>
  20         </affiliation>
  21       </author>
  22       <author>
  23         <firstname>Anders</firstname>
  24         <surname>Carlsson</surname>
  25         <affiliation>
  26           <orgname>CodeFactory AB</orgname>
  27           <address>
  28             <email>andersca@codefactory.se</email>
  29           </address>
  30         </affiliation>
  31       </author>
  32       <author>
  33         <firstname>Alexander</firstname>
  34         <surname>Larsson</surname>
  35         <affiliation>
  36           <orgname>Red Hat, Inc.</orgname>
  37           <address>
  38             <email>alexl@redhat.com</email>
  39           </address>
  40         </affiliation>
  41       </author>
  42       <author>
  43         <firstname>Sven</firstname>
  44         <surname>Herzberg</surname>
  45         <affiliation>
  46           <orgname>Imendio AB</orgname>
  47           <address>
  48             <email>sven@imendio.com</email>
  49           </address>
  50         </affiliation>
  51       </author>
  52       <author>
  53         <firstname>Simon</firstname>
  54         <surname>McVittie</surname>
  55         <affiliation>
  56           <orgname>Collabora Ltd.</orgname>
  57           <address>
  58             <email>simon.mcvittie@collabora.co.uk</email>
  59           </address>
  60         </affiliation>
  61       </author>
  62       <author>
  63         <firstname>David</firstname>
  64         <surname>Zeuthen</surname>
  65         <affiliation>
  66           <orgname>Red Hat, Inc.</orgname>
  67           <address>
  68             <email>davidz@redhat.com</email>
  69           </address>
  70         </affiliation>
  71       </author>
  72     </authorgroup>
  73    <revhistory>
  74      <revision>
  75        <revnumber>current</revnumber>
  76        <date><ulink url='http://cgit.freedesktop.org/dbus/dbus/log/doc/dbus-specification.xml'>commit log</ulink></date>
  77        <authorinitials></authorinitials>
  78        <revremark></revremark>
  79      </revision>
  80      <revision>
  81        <revnumber>0.17</revnumber>
  82        <date>1 June 2011</date>
  83        <authorinitials>smcv/davidz</authorinitials>
  84        <revremark>define ObjectManager; reserve extra pseudo-type-codes used
  85          by GVariant</revremark>
  86      </revision>
  87      <revision>
  88        <revnumber>0.16</revnumber>
  89        <date>11 April 2011</date>
  90        <authorinitials></authorinitials>
  91        <revremark>add path_namespace, arg0namespace; argNpath matches object
  92         paths</revremark>
  93      </revision>
  94      <revision>
  95        <revnumber>0.15</revnumber>
  96        <date>3 November 2010</date>
  97        <authorinitials></authorinitials>
  98        <revremark></revremark>
  99      </revision>
 100      <revision>
 101        <revnumber>0.14</revnumber>
 102        <date>12 May 2010</date>
 103        <authorinitials></authorinitials>
 104        <revremark></revremark>
 105      </revision>
 106      <revision>
 107        <revnumber>0.13</revnumber>
 108        <date>23 Dezember 2009</date>
 109        <authorinitials></authorinitials>
 110        <revremark></revremark>
 111      </revision>
 112      <revision>
 113        <revnumber>0.12</revnumber>
 114        <date>7 November, 2006</date>
 115        <authorinitials></authorinitials>
 116        <revremark></revremark>
 117      </revision>
 118      <revision>
 119        <revnumber>0.11</revnumber>
 120        <date>6 February 2005</date>
 121        <authorinitials></authorinitials>
 122        <revremark></revremark>
 123      </revision>
 124      <revision>
 125        <revnumber>0.10</revnumber>
 126        <date>28 January 2005</date>
 127        <authorinitials></authorinitials>
 128        <revremark></revremark>
 129      </revision>
 130      <revision>
 131        <revnumber>0.9</revnumber>
 132        <date>7 Januar 2005</date>
 133        <authorinitials></authorinitials>
 134        <revremark></revremark>
 135      </revision>
 136      <revision>
 137        <revnumber>0.8</revnumber>
 138        <date>06 September 2003</date>
 139        <authorinitials></authorinitials>
 140        <revremark>First released document.</revremark>
 141      </revision>
 142    </revhistory>
 143   </articleinfo>
 144
 145   <sect1 id="introduction">
 146     <title>Introduction</title>
 147     <para>
 148       D-Bus is a system for low-latency, low-overhead, easy to use
 149       interprocess communication (IPC). In more detail:
 150       <itemizedlist>
 151         <listitem>
 152           <para>
 153             D-Bus is <emphasis>low-latency</emphasis> because it is designed
 154             to avoid round trips and allow asynchronous operation, much like
 155             the X protocol.
 156           </para>
 157         </listitem>
 158         <listitem>
 159           <para>
 160             D-Bus is <emphasis>low-overhead</emphasis> because it uses a
 161             binary protocol, and does not have to convert to and from a text
 162             format such as XML. Because D-Bus is intended for potentially
 163             high-resolution same-machine IPC, not primarily for Internet IPC,
 164             this is an interesting optimization.
 165           </para>
 166         </listitem>
 167         <listitem>
 168           <para>
 169             D-Bus is <emphasis>easy to use</emphasis> because it works in terms
 170             of <firstterm>messages</firstterm> rather than byte streams, and
 171             automatically handles a lot of the hard IPC issues. Also, the D-Bus
 172             library is designed to be wrapped in a way that lets developers use
 173             their framework's existing object/type system, rather than learning
 174             a new one specifically for IPC.
 175           </para>
 176         </listitem>
 177       </itemizedlist>
 178     </para>
 179
 180     <para>
 181       The base D-Bus protocol is a one-to-one (peer-to-peer or client-server)
 182       protocol, specified in <xref linkend="message-protocol"/>. That is, it is
 183       a system for one application to talk to a single other
 184       application. However, the primary intended application of the protocol is the
 185       D-Bus <firstterm>message bus</firstterm>, specified in <xref
 186       linkend="message-bus"/>. The message bus is a special application that
 187       accepts connections from multiple other applications, and forwards
 188       messages among them.
 189     </para>
 190
 191     <para>
 192       Uses of D-Bus include notification of system changes (notification of when
 193       a camera is plugged in to a computer, or a new version of some software
 194       has been installed), or desktop interoperability, for example a file
 195       monitoring service or a configuration service.
 196     </para>
 197
 198     <para>
 199       D-Bus is designed for two specific use cases:
 200       <itemizedlist>
 201         <listitem>
 202           <para>
 203             A "system bus" for notifications from the system to user sessions,
 204             and to allow the system to request input from user sessions.
 205           </para>
 206         </listitem>
 207         <listitem>
 208           <para>
 209             A "session bus" used to implement desktop environments such as
 210             GNOME and KDE.
 211           </para>
 212         </listitem>
 213       </itemizedlist>
 214       D-Bus is not intended to be a generic IPC system for any possible
 215       application, and intentionally omits many features found in other
 216       IPC systems for this reason.
 217     </para>
 218
 219     <para>
 220       At the same time, the bus daemons offer a number of features not found in
 221       other IPC systems, such as single-owner "bus names" (similar to X
 222       selections), on-demand startup of services, and security policies.
 223       In many ways, these features are the primary motivation for developing
 224       D-Bus; other systems would have sufficed if IPC were the only goal.
 225     </para>
 226
 227     <para>
 228       D-Bus may turn out to be useful in unanticipated applications, but future
 229       versions of this spec and the reference implementation probably will not
 230       incorporate features that interfere with the core use cases.
 231     </para>
 232
 233     <para>
 234       The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
 235       "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
 236       document are to be interpreted as described in RFC 2119. However, the
 237       document could use a serious audit to be sure it makes sense to do
 238       so. Also, they are not capitalized.
 239     </para>
 240
 241     <sect2 id="stability">
 242       <title>Protocol and Specification Stability</title>
 243       <para>
 244         The D-Bus protocol is frozen (only compatible extensions are allowed) as
 245         of November 8, 2006.  However, this specification could still use a fair
 246         bit of work to make interoperable reimplementation possible without
 247         reference to the D-Bus reference implementation. Thus, this
 248         specification is not marked 1.0. To mark it 1.0, we'd like to see
 249         someone invest significant effort in clarifying the specification
 250         language, and growing the specification to cover more aspects of the
 251         reference implementation's behavior.
 252       </para>
 253       <para>
 254         Until this work is complete, any attempt to reimplement D-Bus will
 255         probably require looking at the reference implementation and/or asking
 256         questions on the D-Bus mailing list about intended behavior.
 257         Questions on the list are very welcome.
 258       </para>
 259       <para>
 260         Nonetheless, this document should be a useful starting point and is
 261         to our knowledge accurate, though incomplete.
 262       </para>
 263     </sect2>
 264
 265   </sect1>
 266
 267   <sect1 id="type-system">
 268     <title>Type System</title>
 269
 270     <para>
 271       D-Bus has a type system, in which values of various types can be
 272       serialized into a sequence of bytes referred to as the
 273       <firstterm>wire format</firstterm> in a standard way.
 274       Converting a value from some other representation into the wire
 275       format is called <firstterm>marshaling</firstterm> and converting
 276       it back from the wire format is <firstterm>unmarshaling</firstterm>.
 277     </para>
 278
 279     <sect2 id="message-protocol-signatures">
 280       <title>Type Signatures</title>
 281
 282       <para>
 283         The D-Bus protocol does not include type tags in the marshaled data; a
 284         block of marshaled values must have a known <firstterm>type
 285         signature</firstterm>.  The type signature is made up of <firstterm>type
 286         codes</firstterm>. A type code is an ASCII character representing the
 287         type of a value. Because ASCII characters are used, the type signature
 288         will always form a valid ASCII string. A simple string compare
 289         determines whether two type signatures are equivalent.
 290       </para>
 291
 292       <para>
 293         As a simple example, the type code for 32-bit integer (<literal>INT32</literal>) is
 294         the ASCII character 'i'. So the signature for a block of values
 295         containing a single <literal>INT32</literal> would be:
 296         <programlisting>
 297           "i"
 298         </programlisting>
 299         A block of values containing two <literal>INT32</literal> would have this signature:
 300         <programlisting>
 301           "ii"
 302         </programlisting>
 303       </para>
 304
 305       <para>
 306         All <firstterm>basic</firstterm> types work like
 307         <literal>INT32</literal> in this example. To marshal and unmarshal
 308         basic types, you simply read one value from the data
 309         block corresponding to each type code in the signature.
 310         In addition to basic types, there are four <firstterm>container</firstterm>
 311         types: <literal>STRUCT</literal>, <literal>ARRAY</literal>, <literal>VARIANT</literal>,
 312         and <literal>DICT_ENTRY</literal>.
 313       </para>
 314
 315       <para>
 316         <literal>STRUCT</literal> has a type code, ASCII character 'r', but this type
 317         code does not appear in signatures. Instead, ASCII characters
 318         '(' and ')' are used to mark the beginning and end of the struct.
 319         So for example, a struct containing two integers would have this
 320         signature:
 321         <programlisting>
 322           "(ii)"
 323         </programlisting>
 324         Structs can be nested, so for example a struct containing
 325         an integer and another struct:
 326         <programlisting>
 327           "(i(ii))"
 328         </programlisting>
 329         The value block storing that struct would contain three integers; the
 330         type signature allows you to distinguish "(i(ii))" from "((ii)i)" or
 331         "(iii)" or "iii".
 332       </para>
 333
 334       <para>
 335         The <literal>STRUCT</literal> type code 'r' is not currently used in the D-Bus protocol,
 336         but is useful in code that implements the protocol. This type code
 337         is specified to allow such code to interoperate in non-protocol contexts.
 338       </para>
 339
 340       <para>
 341         Empty structures are not allowed; there must be at least one
 342         type code between the parentheses.
 343       </para>
 344
 345       <para>
 346         <literal>ARRAY</literal> has ASCII character 'a' as type code. The array type code must be
 347         followed by a <firstterm>single complete type</firstterm>. The single
 348         complete type following the array is the type of each array element. So
 349         the simple example is:
 350         <programlisting>
 351           "ai"
 352         </programlisting>
 353         which is an array of 32-bit integers. But an array can be of any type,
 354         such as this array-of-struct-with-two-int32-fields:
 355         <programlisting>
 356           "a(ii)"
 357         </programlisting>
 358         Or this array of array of integer:
 359         <programlisting>
 360           "aai"
 361         </programlisting>
 362       </para>
 363
 364       <para>
 365         The phrase <firstterm>single complete type</firstterm> deserves some
 366         definition. A single complete type is a basic type code, a variant type code,
 367         an array with its element type, or a struct with its fields.
 368         So the following signatures are not single complete types:
 369         <programlisting>
 370           "aa"
 371         </programlisting>
 372         <programlisting>
 373           "(ii"
 374         </programlisting>
 375         <programlisting>
 376           "ii)"
 377         </programlisting>
 378         And the following signatures contain multiple complete types:
 379         <programlisting>
 380           "ii"
 381         </programlisting>
 382         <programlisting>
 383           "aiai"
 384         </programlisting>
 385         <programlisting>
 386           "(ii)(ii)"
 387         </programlisting>
 388         Note however that a single complete type may <emphasis>contain</emphasis>
 389         multiple other single complete types.
 390       </para>
 391
 392       <para>
 393         <literal>VARIANT</literal> has ASCII character 'v' as its type code. A marshaled value of
 394         type <literal>VARIANT</literal> will have the signature of a single complete type as part
 395         of the <emphasis>value</emphasis>.  This signature will be followed by a
 396         marshaled value of that type.
 397       </para>
 398
 399       <para>
 400         A <literal>DICT_ENTRY</literal> works exactly like a struct, but rather
 401         than parentheses it uses curly braces, and it has more restrictions.
 402         The restrictions are: it occurs only as an array element type; it has
 403         exactly two single complete types inside the curly braces; the first
 404         single complete type (the "key") must be a basic type rather than a
 405         container type. Implementations must not accept dict entries outside of
 406         arrays, must not accept dict entries with zero, one, or more than two
 407         fields, and must not accept dict entries with non-basic-typed keys. A
 408         dict entry is always a key-value pair.
 409       </para>
 410
 411       <para>
 412         The first field in the <literal>DICT_ENTRY</literal> is always the key.
 413         A message is considered corrupt if the same key occurs twice in the same
 414         array of <literal>DICT_ENTRY</literal>. However, for performance reasons
 415         implementations are not required to reject dicts with duplicate keys.
 416       </para>
 417
 418       <para>
 419         In most languages, an array of dict entry would be represented as a
 420         map, hash table, or dict object.
 421       </para>
 422
 423       <para>
 424         The following table summarizes the D-Bus types.
 425         <informaltable>
 426           <tgroup cols="3">
 427             <thead>
 428               <row>
 429                 <entry>Conventional Name</entry>
 430                 <entry>Code</entry>
 431                 <entry>Description</entry>
 432               </row>
 433             </thead>
 434             <tbody>
 435               <row>
 436                 <entry><literal>INVALID</literal></entry>
 437                 <entry>0 (ASCII NUL)</entry>
 438                 <entry>Not a valid type code, used to terminate signatures</entry>
 439               </row><row>
 440                 <entry><literal>BYTE</literal></entry>
 441                 <entry>121 (ASCII 'y')</entry>
 442                 <entry>8-bit unsigned integer</entry>
 443               </row><row>
 444                 <entry><literal>BOOLEAN</literal></entry>
 445                 <entry>98 (ASCII 'b')</entry>
 446                 <entry>Boolean value, 0 is <literal>FALSE</literal> and 1 is <literal>TRUE</literal>. Everything else is invalid.</entry>
 447               </row><row>
 448                 <entry><literal>INT16</literal></entry>
 449                 <entry>110 (ASCII 'n')</entry>
 450                 <entry>16-bit signed integer</entry>
 451               </row><row>
 452                 <entry><literal>UINT16</literal></entry>
 453                 <entry>113 (ASCII 'q')</entry>
 454                 <entry>16-bit unsigned integer</entry>
 455               </row><row>
 456                 <entry><literal>INT32</literal></entry>
 457                 <entry>105 (ASCII 'i')</entry>
 458                 <entry>32-bit signed integer</entry>
 459               </row><row>
 460                 <entry><literal>UINT32</literal></entry>
 461                 <entry>117 (ASCII 'u')</entry>
 462                 <entry>32-bit unsigned integer</entry>
 463               </row><row>
 464                 <entry><literal>INT64</literal></entry>
 465                 <entry>120 (ASCII 'x')</entry>
 466                 <entry>64-bit signed integer</entry>
 467               </row><row>
 468                 <entry><literal>UINT64</literal></entry>
 469                 <entry>116 (ASCII 't')</entry>
 470                 <entry>64-bit unsigned integer</entry>
 471               </row><row>
 472                 <entry><literal>DOUBLE</literal></entry>
 473                 <entry>100 (ASCII 'd')</entry>
 474                 <entry>IEEE 754 double</entry>
 475               </row><row>
 476                 <entry><literal>STRING</literal></entry>
 477                 <entry>115 (ASCII 's')</entry>
 478                 <entry>UTF-8 string (<emphasis>must</emphasis> be valid UTF-8). Must be nul terminated and contain no other nul bytes.</entry>
 479               </row><row>
 480                 <entry><literal>OBJECT_PATH</literal></entry>
 481                 <entry>111 (ASCII 'o')</entry>
 482                 <entry>Name of an object instance</entry>
 483               </row><row>
 484                 <entry><literal>SIGNATURE</literal></entry>
 485                 <entry>103 (ASCII 'g')</entry>
 486                 <entry>A type signature</entry>
 487               </row><row>
 488                 <entry><literal>ARRAY</literal></entry>
 489                 <entry>97 (ASCII 'a')</entry>
 490                 <entry>Array</entry>
 491               </row><row>
 492                 <entry><literal>STRUCT</literal></entry>
 493                 <entry>114 (ASCII 'r'), 40 (ASCII '('), 41 (ASCII ')')</entry>
 494                 <entry>Struct; type code 114 'r' is reserved for use in
 495                   bindings and implementations to represent the general
 496                   concept of a struct, and must not appear in signatures
 497                   used on D-Bus.</entry>
 498               </row><row>
 499                 <entry><literal>VARIANT</literal></entry>
 500                 <entry>118 (ASCII 'v') </entry>
 501                 <entry>Variant type (the type of the value is part of the value itself)</entry>
 502               </row><row>
 503                 <entry><literal>DICT_ENTRY</literal></entry>
 504                 <entry>101 (ASCII 'e'), 123 (ASCII '{'), 125 (ASCII '}') </entry>
 505                 <entry>Entry in a dict or map (array of key-value pairs).
 506                   Type code 101 'e' is reserved for use in bindings and
 507                   implementations to represent the general concept of a
 508                   dict or dict-entry, and must not appear in signatures
 509                   used on D-Bus.</entry>
 510               </row><row>
 511                 <entry><literal>UNIX_FD</literal></entry>
 512                 <entry>104 (ASCII 'h')</entry>
 513                 <entry>Unix file descriptor</entry>
 514               </row>
 515               <row>
 516                 <entry>(reserved)</entry>
 517                 <entry>109 (ASCII 'm')</entry>
 518                 <entry>Reserved for <ulink
 519                     url="https://bugs.freedesktop.org/show_bug.cgi?id=27857">a
 520                   'maybe' type compatible with the one in GVariant</ulink>,
 521                   and must not appear in signatures used on D-Bus until
 522                   specified here</entry>
 523               </row>
 524               <row>
 525                 <entry>(reserved)</entry>
 526                 <entry>42 (ASCII '*')</entry>
 527                 <entry>Reserved for use in bindings/implementations to
 528                   represent any <firstterm>single complete type</firstterm>,
 529                   and must not appear in signatures used on D-Bus.</entry>
 530               </row>
 531               <row>
 532                 <entry>(reserved)</entry>
 533                 <entry>63 (ASCII '?')</entry>
 534                 <entry>Reserved for use in bindings/implementations to
 535                   represent any <firstterm>basic type</firstterm>, and must
 536                   not appear in signatures used on D-Bus.</entry>
 537               </row>
 538               <row>
 539                 <entry>(reserved)</entry>
 540                 <entry>64 (ASCII '@'), 38 (ASCII '&amp;'),
 541                   94 (ASCII '^')</entry>
 542                 <entry>Reserved for internal use by bindings/implementations,
 543                   and must not appear in signatures used on D-Bus.
 544                   GVariant uses these type-codes to encode calling
 545                   conventions.</entry>
 546               </row>
 547             </tbody>
 548           </tgroup>
 549         </informaltable>
 550       </para>
 551
 552     </sect2>
 553
 554     <sect2 id="message-protocol-marshaling">
 555       <title>Marshaling (Wire Format)</title>
 556
 557       <para>
 558         Given a type signature, a block of bytes can be converted into typed
 559         values. This section describes the format of the block of bytes.  Byte
 560         order and alignment issues are handled uniformly for all D-Bus types.
 561       </para>
 562
 563       <para>
 564         A block of bytes has an associated byte order. The byte order
 565         has to be discovered in some way; for D-Bus messages, the
 566         byte order is part of the message header as described in
 567         <xref linkend="message-protocol-messages"/>. For now, assume
 568         that the byte order is known to be either little endian or big
 569           endian.
 570       </para>
 571
 572       <para>
 573         Each value in a block of bytes is aligned "naturally," for example
 574         4-byte values are aligned to a 4-byte boundary, and 8-byte values to an
 575         8-byte boundary. To properly align a value, <firstterm>alignment
 576         padding</firstterm> may be necessary. The alignment padding must always
 577         be the minimum required padding to properly align the following value;
 578         and it must always be made up of nul bytes. The alignment padding must
 579         not be left uninitialized (it can't contain garbage), and more padding
 580         than required must not be used.
 581       </para>
 582
 583       <para>
 584         Given all this, the types are marshaled on the wire as follows:
 585         <informaltable>
 586           <tgroup cols="3">
 587             <thead>
 588               <row>
 589                 <entry>Conventional Name</entry>
 590                 <entry>Encoding</entry>
 591                 <entry>Alignment</entry>
 592               </row>
 593             </thead>
 594             <tbody>
 595               <row>
 596                 <entry><literal>INVALID</literal></entry>
 597                 <entry>Not applicable; cannot be marshaled.</entry>
 598                 <entry>N/A</entry>
 599               </row><row>
 600                 <entry><literal>BYTE</literal></entry>
 601                 <entry>A single 8-bit byte.</entry>
 602                 <entry>1</entry>
 603               </row><row>
 604                 <entry><literal>BOOLEAN</literal></entry>
 605                 <entry>As for <literal>UINT32</literal>, but only 0 and 1 are valid values.</entry>
 606                 <entry>4</entry>
 607               </row><row>
 608                 <entry><literal>INT16</literal></entry>
 609                 <entry>16-bit signed integer in the message's byte order.</entry>
 610                 <entry>2</entry>
 611               </row><row>
 612                 <entry><literal>UINT16</literal></entry>
 613                 <entry>16-bit unsigned integer in the message's byte order.</entry>
 614                 <entry>2</entry>
 615               </row><row>
 616                 <entry><literal>INT32</literal></entry>
 617                 <entry>32-bit signed integer in the message's byte order.</entry>
 618                 <entry>4</entry>
 619               </row><row>
 620                 <entry><literal>UINT32</literal></entry>
 621                 <entry>32-bit unsigned integer in the message's byte order.</entry>
 622                 <entry>4</entry>
 623               </row><row>
 624                 <entry><literal>INT64</literal></entry>
 625                 <entry>64-bit signed integer in the message's byte order.</entry>
 626                 <entry>8</entry>
 627               </row><row>
 628                 <entry><literal>UINT64</literal></entry>
 629                 <entry>64-bit unsigned integer in the message's byte order.</entry>
 630                 <entry>8</entry>
 631               </row><row>
 632                 <entry><literal>DOUBLE</literal></entry>
 633                 <entry>64-bit IEEE 754 double in the message's byte order.</entry>
 634                 <entry>8</entry>
 635               </row><row>
 636                 <entry><literal>STRING</literal></entry>
 637                 <entry>A <literal>UINT32</literal> indicating the string's
 638                   length in bytes excluding its terminating nul, followed by
 639                   non-nul string data of the given length, followed by a terminating nul
 640                   byte.
 641                 </entry>
 642                 <entry>
 643                   4 (for the length)
 644                 </entry>
 645               </row><row>
 646                 <entry><literal>OBJECT_PATH</literal></entry>
 647                 <entry>Exactly the same as <literal>STRING</literal> except the
 648                   content must be a valid object path (see below).
 649                 </entry>
 650                 <entry>
 651                   4 (for the length)
 652                 </entry>
 653               </row><row>
 654                 <entry><literal>SIGNATURE</literal></entry>
 655                 <entry>The same as <literal>STRING</literal> except the length is a single
 656                   byte (thus signatures have a maximum length of 255)
 657                   and the content must be a valid signature (see below).
 658                 </entry>
 659                 <entry>
 660                   1
 661                 </entry>
 662               </row><row>
 663                 <entry><literal>ARRAY</literal></entry>
 664                 <entry>
 665                   A <literal>UINT32</literal> giving the length of the array data in bytes, followed by
 666                   alignment padding to the alignment boundary of the array element type,
 667                   followed by each array element. The array length is from the
 668                   end of the alignment padding to the end of the last element,
 669                   i.e. it does not include the padding after the length,
 670                   or any padding after the last element.
 671                   Arrays have a maximum length defined to be 2 to the 26th power or
 672                   67108864. Implementations must not send or accept arrays exceeding this
 673                   length.
 674                 </entry>
 675                 <entry>
 676                   4 (for the length)
 677                 </entry>
 678               </row><row>
 679                 <entry><literal>STRUCT</literal></entry>
 680                 <entry>
 681                   A struct must start on an 8-byte boundary regardless of the
 682                   type of the struct fields. The struct value consists of each
 683                   field marshaled in sequence starting from that 8-byte
 684                   alignment boundary.
 685                 </entry>
 686                 <entry>
 687                   8
 688                 </entry>
 689               </row><row>
 690                 <entry><literal>VARIANT</literal></entry>
 691                 <entry>
 692                   A variant type has a marshaled
 693                   <literal>SIGNATURE</literal> followed by a marshaled
 694                   value with the type given in the signature.  Unlike
 695                   a message signature, the variant signature can
 696                   contain only a single complete type.  So "i", "ai"
 697                   or "(ii)" is OK, but "ii" is not.  Use of variants may not
 698                   cause a total message depth to be larger than 64, including
 699                   other container types such as structures.
 700                 </entry>
 701                 <entry>
 702                   1 (alignment of the signature)
 703                 </entry>
 704               </row><row>
 705                 <entry><literal>DICT_ENTRY</literal></entry>
 706                 <entry>
 707                   Identical to STRUCT.
 708                 </entry>
 709                 <entry>
 710                   8
 711                 </entry>
 712               </row><row>
 713                 <entry><literal>UNIX_FD</literal></entry>
 714                 <entry>32-bit unsigned integer in the message's byte
 715                 order. The actual file descriptors need to be
 716                 transferred out-of-band via some platform specific
 717                 mechanism. On the wire, values of this type store the index to the
 718                 file descriptor in the array of file descriptors that
 719                 accompany the message.</entry>
 720                 <entry>4</entry>
 721               </row>
 722             </tbody>
 723           </tgroup>
 724         </informaltable>
 725       </para>
 726
 727       <sect3 id="message-protocol-marshaling-object-path">
 728         <title>Valid Object Paths</title>
 729
 730         <para>
 731           An object path is a name used to refer to an object instance.
 732           Conceptually, each participant in a D-Bus message exchange may have
 733           any number of object instances (think of C++ or Java objects) and each
 734           such instance will have a path. Like a filesystem, the object
 735           instances in an application form a hierarchical tree.
 736         </para>
 737
 738         <para>
 739           The following rules define a valid object path. Implementations must
 740           not send or accept messages with invalid object paths.
 741           <itemizedlist>
 742             <listitem>
 743               <para>
 744                 The path may be of any length.
 745               </para>
 746             </listitem>
 747             <listitem>
 748               <para>
 749                 The path must begin with an ASCII '/' (integer 47) character,
 750                 and must consist of elements separated by slash characters.
 751               </para>
 752             </listitem>
 753             <listitem>
 754               <para>
 755                 Each element must only contain the ASCII characters
 756                 "[A-Z][a-z][0-9]_"
 757               </para>
 758             </listitem>
 759             <listitem>
 760               <para>
 761                 No element may be the empty string.
 762               </para>
 763             </listitem>
 764             <listitem>
 765               <para>
 766                 Multiple '/' characters cannot occur in sequence.
 767               </para>
 768             </listitem>
 769             <listitem>
 770               <para>
 771                 A trailing '/' character is not allowed unless the
 772                 path is the root path (a single '/' character).
 773               </para>
 774             </listitem>
 775           </itemizedlist>
 776         </para>
 777
 778       </sect3>
 779
 780
 781       <sect3 id="message-protocol-marshaling-signature">
 782         <title>Valid Signatures</title>
 783         <para>
 784           An implementation must not send or accept invalid signatures.
 785           Valid signatures will conform to the following rules:
 786           <itemizedlist>
 787             <listitem>
 788               <para>
 789                 The signature ends with a nul byte.
 790               </para>
 791             </listitem>
 792             <listitem>
 793               <para>
 794                 The signature is a list of single complete types.
 795                 Arrays must have element types, and structs must
 796                 have both open and close parentheses.
 797               </para>
 798             </listitem>
 799             <listitem>
 800               <para>
 801                 Only type codes and open and close parentheses are
 802                 allowed in the signature. The <literal>STRUCT</literal> type code
 803                 is not allowed in signatures, because parentheses
 804                 are used instead.
 805               </para>
 806             </listitem>
 807             <listitem>
 808               <para>
 809                 The maximum depth of container type nesting is 32 array type
 810                 codes and 32 open parentheses. This implies that the maximum
 811                 total depth of recursion is 64, for an "array of array of array
 812                 of ... struct of struct of struct of ..."  where there are 32
 813                 array and 32 struct.
 814               </para>
 815             </listitem>
 816             <listitem>
 817               <para>
 818                 The maximum length of a signature is 255.
 819               </para>
 820             </listitem>
 821             <listitem>
 822               <para>
 823                 Signatures must be nul-terminated.
 824               </para>
 825             </listitem>
 826           </itemizedlist>
 827         </para>
 828       </sect3>
 829
 830     </sect2>
 831
 832   </sect1>
 833
 834   <sect1 id="message-protocol">
 835     <title>Message Protocol</title>
 836
 837     <para>
 838       A <firstterm>message</firstterm> consists of a
 839       <firstterm>header</firstterm> and a <firstterm>body</firstterm>. If you
 840       think of a message as a package, the header is the address, and the body
 841       contains the package contents. The message delivery system uses the header
 842       information to figure out where to send the message and how to interpret
 843       it; the recipient interprets the body of the message.
 844     </para>
 845
 846     <para>
 847       The body of the message is made up of zero or more
 848       <firstterm>arguments</firstterm>, which are typed values, such as an
 849       integer or a byte array.
 850     </para>
 851
 852     <para>
 853       Both header and body use the D-Bus <link linkend="type-system">type
 854         system</link> and format for serializing data.
 855     </para>
 856
 857     <sect2 id="message-protocol-messages">
 858       <title>Message Format</title>
 859
 860       <para>
 861         A message consists of a header and a body. The header is a block of
 862         values with a fixed signature and meaning.  The body is a separate block
 863         of values, with a signature specified in the header.
 864       </para>
 865
 866       <para>
 867         The length of the header must be a multiple of 8, allowing the body to
 868         begin on an 8-byte boundary when storing the entire message in a single
 869         buffer. If the header does not naturally end on an 8-byte boundary
 870         up to 7 bytes of nul-initialized alignment padding must be added.
 871       </para>
 872
 873       <para>
 874         The message body need not end on an 8-byte boundary.
 875       </para>
 876
 877       <para>
 878         The maximum length of a message, including header, header alignment padding,
 879         and body is 2 to the 27th power or 134217728. Implementations must not
 880         send or accept messages exceeding this size.
 881       </para>
 882
 883       <para>
 884         The signature of the header is:
 885         <programlisting>
 886           "yyyyuua(yv)"
 887         </programlisting>
 888         Written out more readably, this is:
 889         <programlisting>
 890           BYTE, BYTE, BYTE, BYTE, UINT32, UINT32, ARRAY of STRUCT of (BYTE,VARIANT)
 891         </programlisting>
 892       </para>
 893
 894       <para>
 895         These values have the following meanings:
 896         <informaltable>
 897           <tgroup cols="2">
 898             <thead>
 899               <row>
 900                 <entry>Value</entry>
 901                 <entry>Description</entry>
 902               </row>
 903             </thead>
 904             <tbody>
 905               <row>
 906                 <entry>1st <literal>BYTE</literal></entry>
 907                 <entry>Endianness flag; ASCII 'l' for little-endian
 908                   or ASCII 'B' for big-endian. Both header and body are
 909                 in this endianness.</entry>
 910               </row>
 911               <row>
 912                 <entry>2nd <literal>BYTE</literal></entry>
 913                 <entry><firstterm>Message type</firstterm>. Unknown types must be ignored.
 914                   Currently-defined types are described below.
 915                 </entry>
 916               </row>
 917               <row>
 918                 <entry>3rd <literal>BYTE</literal></entry>
 919                 <entry>Bitwise OR of flags. Unknown flags
 920                   must be ignored. Currently-defined flags are described below.
 921                 </entry>
 922               </row>
 923               <row>
 924                 <entry>4th <literal>BYTE</literal></entry>
 925                 <entry>Major protocol version of the sending application.  If
 926                 the major protocol version of the receiving application does not
 927                 match, the applications will not be able to communicate and the
 928                 D-Bus connection must be disconnected. The major protocol
 929                 version for this version of the specification is 1.
 930                 </entry>
 931               </row>
 932               <row>
 933                 <entry>1st <literal>UINT32</literal></entry>
 934                 <entry>Length in bytes of the message body, starting
 935                   from the end of the header. The header ends after
 936                   its alignment padding to an 8-boundary.
 937                 </entry>
 938               </row>
 939               <row>
 940                 <entry>2nd <literal>UINT32</literal></entry>
 941                 <entry>The serial of this message, used as a cookie
 942                   by the sender to identify the reply corresponding
 943                   to this request. This must not be zero.
 944                 </entry>
 945               </row>
 946               <row>
 947                 <entry><literal>ARRAY</literal> of <literal>STRUCT</literal> of (<literal>BYTE</literal>,<literal>VARIANT</literal>)</entry>
 948                 <entry>An array of zero or more <firstterm>header
 949                   fields</firstterm> where the byte is the field code, and the
 950                   variant is the field value. The message type determines
 951                   which fields are required.
 952                 </entry>
 953               </row>
 954             </tbody>
 955           </tgroup>
 956         </informaltable>
 957       </para>
 958       <para>
 959         <firstterm>Message types</firstterm> that can appear in the second byte
 960         of the header are:
 961         <informaltable>
 962           <tgroup cols="3">
 963             <thead>
 964               <row>
 965                 <entry>Conventional name</entry>
 966                 <entry>Decimal value</entry>
 967                 <entry>Description</entry>
 968               </row>
 969             </thead>
 970             <tbody>
 971               <row>
 972                 <entry><literal>INVALID</literal></entry>
 973                 <entry>0</entry>
 974                 <entry>This is an invalid type.</entry>
 975               </row>
 976               <row>
 977                 <entry><literal>METHOD_CALL</literal></entry>
 978                 <entry>1</entry>
 979                 <entry>Method call.</entry>
 980               </row>
 981               <row>
 982                 <entry><literal>METHOD_RETURN</literal></entry>
 983                 <entry>2</entry>
 984                 <entry>Method reply with returned data.</entry>
 985               </row>
 986               <row>
 987                 <entry><literal>ERROR</literal></entry>
 988                 <entry>3</entry>
 989                 <entry>Error reply. If the first argument exists and is a
 990                 string, it is an error message.</entry>
 991               </row>
 992               <row>
 993                 <entry><literal>SIGNAL</literal></entry>
 994                 <entry>4</entry>
 995                 <entry>Signal emission.</entry>
 996               </row>
 997             </tbody>
 998           </tgroup>
 999         </informaltable>
1000       </para>
1001       <para>
1002         Flags that can appear in the third byte of the header:
1003         <informaltable>
1004           <tgroup cols="3">
1005             <thead>
1006               <row>
1007                 <entry>Conventional name</entry>
1008                 <entry>Hex value</entry>
1009                 <entry>Description</entry>
1010               </row>
1011             </thead>
1012             <tbody>
1013               <row>
1014                 <entry><literal>NO_REPLY_EXPECTED</literal></entry>
1015                 <entry>0x1</entry>
1016                 <entry>This message does not expect method return replies or
1017                 error replies; the reply can be omitted as an
1018                 optimization. However, it is compliant with this specification
1019                 to return the reply despite this flag and the only harm
1020                   from doing so is extra network traffic.
1021                 </entry>
1022               </row>
1023               <row>
1024                 <entry><literal>NO_AUTO_START</literal></entry>
1025                 <entry>0x2</entry>
1026                 <entry>The bus must not launch an owner
1027                   for the destination name in response to this message.
1028                 </entry>
1029               </row>
1030             </tbody>
1031           </tgroup>
1032         </informaltable>
1033       </para>
1034
1035       <sect3 id="message-protocol-header-fields">
1036         <title>Header Fields</title>
1037
1038         <para>
1039           The array at the end of the header contains <firstterm>header
1040           fields</firstterm>, where each field is a 1-byte field code followed
1041           by a field value. A header must contain the required header fields for
1042           its message type, and zero or more of any optional header
1043           fields. Future versions of this protocol specification may add new
1044           fields. Implementations must ignore fields they do not
1045           understand. Implementations must not invent their own header fields;
1046           only changes to this specification may introduce new header fields.
1047         </para>
1048
1049         <para>
1050           Again, if an implementation sees a header field code that it does not
1051           expect, it must ignore that field, as it will be part of a new
1052           (but compatible) version of this specification. This also applies
1053           to known header fields appearing in unexpected messages, for
1054           example: if a signal has a reply serial it must be ignored
1055           even though it has no meaning as of this version of the spec.
1056         </para>
1057
1058         <para>
1059           However, implementations must not send or accept known header fields
1060           with the wrong type stored in the field value. So for example a
1061           message with an <literal>INTERFACE</literal> field of type
1062           <literal>UINT32</literal> would be considered corrupt.
1063         </para>
1064
1065         <para>
1066           Here are the currently-defined header fields:
1067           <informaltable>
1068             <tgroup cols="5">
1069               <thead>
1070                 <row>
1071                   <entry>Conventional Name</entry>
1072                   <entry>Decimal Code</entry>
1073                   <entry>Type</entry>
1074                   <entry>Required In</entry>
1075                   <entry>Description</entry>
1076                 </row>
1077               </thead>
1078               <tbody>
1079                 <row>
1080                   <entry><literal>INVALID</literal></entry>
1081                   <entry>0</entry>
1082                   <entry>N/A</entry>
1083                   <entry>not allowed</entry>
1084                   <entry>Not a valid field name (error if it appears in a message)</entry>
1085                 </row>
1086                 <row>
1087                   <entry><literal>PATH</literal></entry>
1088                   <entry>1</entry>
1089                   <entry><literal>OBJECT_PATH</literal></entry>
1090                   <entry><literal>METHOD_CALL</literal>, <literal>SIGNAL</literal></entry>
1091                   <entry>The object to send a call to,
1092                     or the object a signal is emitted from.
1093                     The special path
1094                     <literal>/org/freedesktop/DBus/Local</literal> is reserved;
1095                     implementations should not send messages with this path,
1096                     and the reference implementation of the bus daemon will
1097                     disconnect any application that attempts to do so.
1098                   </entry>
1099                 </row>
1100                 <row>
1101                   <entry><literal>INTERFACE</literal></entry>
1102                   <entry>2</entry>
1103                   <entry><literal>STRING</literal></entry>
1104                   <entry><literal>SIGNAL</literal></entry>
1105                   <entry>
1106                     The interface to invoke a method call on, or
1107                     that a signal is emitted from. Optional for
1108                     method calls, required for signals.
1109                     The special interface
1110                     <literal>org.freedesktop.DBus.Local</literal> is reserved;
1111                     implementations should not send messages with this
1112                     interface, and the reference implementation of the bus
1113                     daemon will disconnect any application that attempts to
1114                     do so.
1115                   </entry>
1116                 </row>
1117                 <row>
1118                   <entry><literal>MEMBER</literal></entry>
1119                   <entry>3</entry>
1120                   <entry><literal>STRING</literal></entry>
1121                   <entry><literal>METHOD_CALL</literal>, <literal>SIGNAL</literal></entry>
1122                   <entry>The member, either the method name or signal name.</entry>
1123                 </row>
1124                 <row>
1125                   <entry><literal>ERROR_NAME</literal></entry>
1126                   <entry>4</entry>
1127                   <entry><literal>STRING</literal></entry>
1128                   <entry><literal>ERROR</literal></entry>
1129                   <entry>The name of the error that occurred, for errors</entry>
1130                 </row>
1131                 <row>
1132                   <entry><literal>REPLY_SERIAL</literal></entry>
1133                   <entry>5</entry>
1134                   <entry><literal>UINT32</literal></entry>
1135                   <entry><literal>ERROR</literal>, <literal>METHOD_RETURN</literal></entry>
1136                   <entry>The serial number of the message this message is a reply
1137                     to. (The serial number is the second <literal>UINT32</literal> in the header.)</entry>
1138                 </row>
1139                 <row>
1140                   <entry><literal>DESTINATION</literal></entry>
1141                   <entry>6</entry>
1142                   <entry><literal>STRING</literal></entry>
1143                   <entry>optional</entry>
1144                   <entry>The name of the connection this message is intended for.
1145                     Only used in combination with the message bus, see
1146                     <xref linkend="message-bus"/>.</entry>
1147                 </row>
1148                 <row>
1149                   <entry><literal>SENDER</literal></entry>
1150                   <entry>7</entry>
1151                   <entry><literal>STRING</literal></entry>
1152                   <entry>optional</entry>
1153                   <entry>Unique name of the sending connection.
1154                     The message bus fills in this field so it is reliable; the field is
1155                     only meaningful in combination with the message bus.</entry>
1156                 </row>
1157                 <row>
1158                   <entry><literal>SIGNATURE</literal></entry>
1159                   <entry>8</entry>
1160                   <entry><literal>SIGNATURE</literal></entry>
1161                   <entry>optional</entry>
1162                   <entry>The signature of the message body.
1163                   If omitted, it is assumed to be the
1164                   empty signature "" (i.e. the body must be 0-length).</entry>
1165                 </row>
1166                 <row>
1167                   <entry><literal>UNIX_FDS</literal></entry>
1168                   <entry>9</entry>
1169                   <entry><literal>UINT32</literal></entry>
1170                   <entry>optional</entry>
1171                   <entry>The number of Unix file descriptors that
1172                   accompany the message.  If omitted, it is assumed
1173                   that no Unix file descriptors accompany the
1174                   message. The actual file descriptors need to be
1175                   transferred via platform specific mechanism
1176                   out-of-band. They must be sent at the same time as
1177                   part of the message itself. They may not be sent
1178                   before the first byte of the message itself is
1179                   transferred or after the last byte of the message
1180                   itself.</entry>
1181                 </row>
1182               </tbody>
1183             </tgroup>
1184           </informaltable>
1185         </para>
1186       </sect3>
1187     </sect2>
1188
1189     <sect2 id="message-protocol-names">
1190       <title>Valid Names</title>
1191       <para>
1192         The various names in D-Bus messages have some restrictions.
1193       </para>
1194       <para>
1195         There is a <firstterm>maximum name length</firstterm>
1196         of 255 which applies to bus names, interfaces, and members.
1197       </para>
1198       <sect3 id="message-protocol-names-interface">
1199         <title>Interface names</title>
1200         <para>
1201           Interfaces have names with type <literal>STRING</literal>, meaning that
1202           they must be valid UTF-8. However, there are also some
1203           additional restrictions that apply to interface names
1204           specifically:
1205           <itemizedlist>
1206             <listitem><para>Interface names are composed of 1 or more elements separated by
1207                 a period ('.') character. All elements must contain at least
1208                 one character.
1209                 </para>
1210             </listitem>
1211             <listitem><para>Each element must only contain the ASCII characters
1212                 "[A-Z][a-z][0-9]_" and must not begin with a digit.
1213                 </para>
1214             </listitem>
1215
1216             <listitem><para>Interface names must contain at least one '.' (period)
1217               character (and thus at least two elements).
1218               </para></listitem>
1219
1220             <listitem><para>Interface names must not begin with a '.' (period) character.</para></listitem>
1221             <listitem><para>Interface names must not exceed the maximum name length.</para></listitem>
1222           </itemizedlist>
1223         </para>
1224       </sect3>
1225       <sect3 id="message-protocol-names-bus">
1226         <title>Bus names</title>
1227         <para>
1228           Connections have one or more bus names associated with them.
1229           A connection has exactly one bus name that is a unique connection
1230           name. The unique connection name remains with the connection for
1231           its entire lifetime.
1232           A bus name is of type <literal>STRING</literal>,
1233           meaning that it must be valid UTF-8. However, there are also
1234           some additional restrictions that apply to bus names
1235           specifically:
1236           <itemizedlist>
1237             <listitem><para>Bus names that start with a colon (':')
1238                 character are unique connection names.
1239                 </para>
1240             </listitem>
1241             <listitem><para>Bus names are composed of 1 or more elements separated by
1242                 a period ('.') character. All elements must contain at least
1243                 one character.
1244                 </para>
1245             </listitem>
1246             <listitem><para>Each element must only contain the ASCII characters
1247                 "[A-Z][a-z][0-9]_-". Only elements that are part of a unique
1248                 connection name may begin with a digit, elements in
1249                 other bus names must not begin with a digit.
1250                 </para>
1251             </listitem>
1252
1253             <listitem><para>Bus names must contain at least one '.' (period)
1254               character (and thus at least two elements).
1255               </para></listitem>
1256
1257             <listitem><para>Bus names must not begin with a '.' (period) character.</para></listitem>
1258             <listitem><para>Bus names must not exceed the maximum name length.</para></listitem>
1259           </itemizedlist>
1260         </para>
1261         <para>
1262           Note that the hyphen ('-') character is allowed in bus names but
1263           not in interface names.
1264         </para>
1265       </sect3>
1266       <sect3 id="message-protocol-names-member">
1267         <title>Member names</title>
1268         <para>
1269           Member (i.e. method or signal) names:
1270           <itemizedlist>
1271             <listitem><para>Must only contain the ASCII characters
1272                 "[A-Z][a-z][0-9]_" and may not begin with a
1273                 digit.</para></listitem>
1274             <listitem><para>Must not contain the '.' (period) character.</para></listitem>
1275             <listitem><para>Must not exceed the maximum name length.</para></listitem>
1276             <listitem><para>Must be at least 1 byte in length.</para></listitem>
1277           </itemizedlist>
1278         </para>
1279       </sect3>
1280       <sect3 id="message-protocol-names-error">
1281         <title>Error names</title>
1282         <para>
1283           Error names have the same restrictions as interface names.
1284         </para>
1285       </sect3>
1286     </sect2>
1287
1288     <sect2 id="message-protocol-types">
1289       <title>Message Types</title>
1290       <para>
1291         Each of the message types (<literal>METHOD_CALL</literal>, <literal>METHOD_RETURN</literal>, <literal>ERROR</literal>, and
1292         <literal>SIGNAL</literal>) has its own expected usage conventions and header fields.
1293         This section describes these conventions.
1294       </para>
1295       <sect3 id="message-protocol-types-method">
1296         <title>Method Calls</title>
1297         <para>
1298           Some messages invoke an operation on a remote object.  These are
1299           called method call messages and have the type tag <literal>METHOD_CALL</literal>. Such
1300           messages map naturally to methods on objects in a typical program.
1301         </para>
1302         <para>
1303           A method call message is required to have a <literal>MEMBER</literal> header field
1304           indicating the name of the method. Optionally, the message has an
1305           <literal>INTERFACE</literal> field giving the interface the method is a part of. In the
1306           absence of an <literal>INTERFACE</literal> field, if two interfaces on the same object have
1307           a method with the same name, it is undefined which of the two methods
1308           will be invoked. Implementations may also choose to return an error in
1309           this ambiguous case. However, if a method name is unique
1310           implementations must not require an interface field.
1311         </para>
1312         <para>
1313           Method call messages also include a <literal>PATH</literal> field
1314           indicating the object to invoke the method on. If the call is passing
1315           through a message bus, the message will also have a
1316           <literal>DESTINATION</literal> field giving the name of the connection
1317           to receive the message.
1318         </para>
1319         <para>
1320           When an application handles a method call message, it is required to
1321           return a reply. The reply is identified by a <literal>REPLY_SERIAL</literal> header field
1322           indicating the serial number of the <literal>METHOD_CALL</literal> being replied to. The
1323           reply can have one of two types; either <literal>METHOD_RETURN</literal> or <literal>ERROR</literal>.
1324         </para>
1325         <para>
1326           If the reply has type <literal>METHOD_RETURN</literal>, the arguments to the reply message
1327           are the return value(s) or "out parameters" of the method call.
1328           If the reply has type <literal>ERROR</literal>, then an "exception" has been thrown,
1329           and the call fails; no return value will be provided. It makes
1330           no sense to send multiple replies to the same method call.
1331         </para>
1332         <para>
1333           Even if a method call has no return values, a <literal>METHOD_RETURN</literal>
1334           reply is required, so the caller will know the method
1335           was successfully processed.
1336         </para>
1337         <para>
1338           The <literal>METHOD_RETURN</literal> or <literal>ERROR</literal> reply message must have the <literal>REPLY_SERIAL</literal>
1339           header field.
1340         </para>
1341         <para>
1342           If a <literal>METHOD_CALL</literal> message has the flag <literal>NO_REPLY_EXPECTED</literal>,
1343           then as an optimization the application receiving the method
1344           call may choose to omit the reply message (regardless of
1345           whether the reply would have been <literal>METHOD_RETURN</literal> or <literal>ERROR</literal>).
1346           However, it is also acceptable to ignore the <literal>NO_REPLY_EXPECTED</literal>
1347           flag and reply anyway.
1348         </para>
1349         <para>
1350           Unless a message has the flag <literal>NO_AUTO_START</literal>, if the
1351           destination name does not exist then a program to own the destination
1352           name will be started before the message is delivered.  The message
1353           will be held until the new program is successfully started or has
1354           failed to start; in case of failure, an error will be returned. This
1355           flag is only relevant in the context of a message bus, it is ignored
1356           during one-to-one communication with no intermediate bus.
1357         </para>
1358         <sect4 id="message-protocol-types-method-apis">
1359           <title>Mapping method calls to native APIs</title>
1360           <para>
1361             APIs for D-Bus may map method calls to a method call in a specific
1362             programming language, such as C++, or may map a method call written
1363             in an IDL to a D-Bus message.
1364           </para>
1365           <para>
1366             In APIs of this nature, arguments to a method are often termed "in"
1367             (which implies sent in the <literal>METHOD_CALL</literal>), or "out" (which implies
1368             returned in the <literal>METHOD_RETURN</literal>). Some APIs such as CORBA also have
1369             "inout" arguments, which are both sent and received, i.e. the caller
1370             passes in a value which is modified. Mapped to D-Bus, an "inout"
1371             argument is equivalent to an "in" argument, followed by an "out"
1372             argument. You can't pass things "by reference" over the wire, so
1373             "inout" is purely an illusion of the in-process API.
1374           </para>
1375           <para>
1376             Given a method with zero or one return values, followed by zero or more
1377             arguments, where each argument may be "in", "out", or "inout", the
1378             caller constructs a message by appending each "in" or "inout" argument,
1379             in order. "out" arguments are not represented in the caller's message.
1380           </para>
1381           <para>
1382             The recipient constructs a reply by appending first the return value
1383             if any, then each "out" or "inout" argument, in order.
1384             "in" arguments are not represented in the reply message.
1385           </para>
1386           <para>
1387             Error replies are normally mapped to exceptions in languages that have
1388             exceptions.
1389           </para>
1390           <para>
1391             In converting from native APIs to D-Bus, it is perhaps nice to
1392             map D-Bus naming conventions ("FooBar") to native conventions
1393             such as "fooBar" or "foo_bar" automatically. This is OK
1394             as long as you can say that the native API is one that
1395             was specifically written for D-Bus. It makes the most sense
1396             when writing object implementations that will be exported
1397             over the bus. Object proxies used to invoke remote D-Bus
1398             objects probably need the ability to call any D-Bus method,
1399             and thus a magic name mapping like this could be a problem.
1400           </para>
1401           <para>
1402             This specification doesn't require anything of native API bindings;
1403             the preceding is only a suggested convention for consistency
1404             among bindings.
1405           </para>
1406         </sect4>
1407       </sect3>
1408
1409       <sect3 id="message-protocol-types-signal">
1410         <title>Signal Emission</title>
1411         <para>
1412           Unlike method calls, signal emissions have no replies.
1413           A signal emission is simply a single message of type <literal>SIGNAL</literal>.
1414           It must have three header fields: <literal>PATH</literal> giving the object
1415           the signal was emitted from, plus <literal>INTERFACE</literal> and <literal>MEMBER</literal> giving
1416           the fully-qualified name of the signal. The <literal>INTERFACE</literal> header is required
1417           for signals, though it is optional for method calls.
1418         </para>
1419       </sect3>
1420
1421       <sect3 id="message-protocol-types-errors">
1422         <title>Errors</title>
1423         <para>
1424           Messages of type <literal>ERROR</literal> are most commonly replies
1425           to a <literal>METHOD_CALL</literal>, but may be returned in reply
1426           to any kind of message. The message bus for example
1427           will return an <literal>ERROR</literal> in reply to a signal emission if
1428           the bus does not have enough memory to send the signal.
1429         </para>
1430         <para>
1431           An <literal>ERROR</literal> may have any arguments, but if the first
1432           argument is a <literal>STRING</literal>, it must be an error message.
1433           The error message may be logged or shown to the user
1434           in some way.
1435         </para>
1436       </sect3>
1437
1438       <sect3 id="message-protocol-types-notation">
1439         <title>Notation in this document</title>
1440         <para>
1441           This document uses a simple pseudo-IDL to describe particular method
1442           calls and signals. Here is an example of a method call:
1443           <programlisting>
1444             org.freedesktop.DBus.StartServiceByName (in STRING name, in UINT32 flags,
1445                                                      out UINT32 resultcode)
1446           </programlisting>
1447           This means <literal>INTERFACE</literal> = org.freedesktop.DBus, <literal>MEMBER</literal> = StartServiceByName,
1448           <literal>METHOD_CALL</literal> arguments are <literal>STRING</literal> and <literal>UINT32</literal>, <literal>METHOD_RETURN</literal> argument
1449           is <literal>UINT32</literal>. Remember that the <literal>MEMBER</literal> field can't contain any '.' (period)
1450           characters so it's known that the last part of the name in
1451           the "IDL" is the member name.
1452         </para>
1453         <para>
1454           In C++ that might end up looking like this:
1455           <programlisting>
1456             unsigned int org::freedesktop::DBus::StartServiceByName (const char  *name,
1457                                                                      unsigned int flags);
1458           </programlisting>
1459           or equally valid, the return value could be done as an argument:
1460           <programlisting>
1461             void org::freedesktop::DBus::StartServiceByName (const char   *name,
1462                                                              unsigned int  flags,
1463                                                              unsigned int *resultcode);
1464           </programlisting>
1465           It's really up to the API designer how they want to make
1466           this look. You could design an API where the namespace wasn't used
1467           in C++, using STL or Qt, using varargs, or whatever you wanted.
1468         </para>
1469         <para>
1470           Signals are written as follows:
1471           <programlisting>
1472             org.freedesktop.DBus.NameLost (STRING name)
1473           </programlisting>
1474           Signals don't specify "in" vs. "out" because only
1475           a single direction is possible.
1476         </para>
1477         <para>
1478           It isn't especially encouraged to use this lame pseudo-IDL in actual
1479           API implementations; you might use the native notation for the
1480           language you're using, or you might use COM or CORBA IDL, for example.
1481         </para>
1482       </sect3>
1483     </sect2>
1484
1485     <sect2 id="message-protocol-handling-invalid">
1486       <title>Invalid Protocol and Spec Extensions</title>
1487
1488       <para>
1489         For security reasons, the D-Bus protocol should be strictly parsed and
1490         validated, with the exception of defined extension points. Any invalid
1491         protocol or spec violations should result in immediately dropping the
1492         connection without notice to the other end. Exceptions should be
1493         carefully considered, e.g. an exception may be warranted for a
1494         well-understood idiosyncrasy of a widely-deployed implementation.  In
1495         cases where the other end of a connection is 100% trusted and known to
1496         be friendly, skipping validation for performance reasons could also make
1497         sense in certain cases.
1498       </para>
1499
1500       <para>
1501         Generally speaking violations of the "must" requirements in this spec
1502         should be considered possible attempts to exploit security, and violations
1503         of the "should" suggestions should be considered legitimate (though perhaps
1504         they should generate an error in some cases).
1505       </para>
1506
1507       <para>
1508         The following extension points are built in to D-Bus on purpose and must
1509         not be treated as invalid protocol. The extension points are intended
1510         for use by future versions of this spec, they are not intended for third
1511         parties.  At the moment, the only way a third party could extend D-Bus
1512         without breaking interoperability would be to introduce a way to negotiate new
1513         feature support as part of the auth protocol, using EXTENSION_-prefixed
1514         commands. There is not yet a standard way to negotiate features.
1515         <itemizedlist>
1516           <listitem>
1517             <para>
1518               In the authentication protocol (see <xref linkend="auth-protocol"/>) unknown
1519                 commands result in an ERROR rather than a disconnect. This enables
1520                 future extensions to the protocol. Commands starting with EXTENSION_ are
1521                 reserved for third parties.
1522             </para>
1523           </listitem>
1524           <listitem>
1525             <para>
1526               The authentication protocol supports pluggable auth mechanisms.
1527             </para>
1528           </listitem>
1529           <listitem>
1530             <para>
1531               The address format (see <xref linkend="addresses"/>) supports new
1532               kinds of transport.
1533             </para>
1534           </listitem>
1535           <listitem>
1536             <para>
1537               Messages with an unknown type (something other than
1538               <literal>METHOD_CALL</literal>, <literal>METHOD_RETURN</literal>,
1539               <literal>ERROR</literal>, <literal>SIGNAL</literal>) are ignored.
1540               Unknown-type messages must still be well-formed in the same way
1541               as the known messages, however. They still have the normal
1542               header and body.
1543             </para>
1544           </listitem>
1545           <listitem>
1546             <para>
1547               Header fields with an unknown or unexpected field code must be ignored,
1548               though again they must still be well-formed.
1549             </para>
1550           </listitem>
1551           <listitem>
1552             <para>
1553               New standard interfaces (with new methods and signals) can of course be added.
1554             </para>
1555           </listitem>
1556         </itemizedlist>
1557       </para>
1558
1559     </sect2>
1560
1561   </sect1>
1562
1563   <sect1 id="auth-protocol">
1564     <title>Authentication Protocol</title>
1565     <para>
1566       Before the flow of messages begins, two applications must
1567       authenticate. A simple plain-text protocol is used for
1568       authentication; this protocol is a SASL profile, and maps fairly
1569       directly from the SASL specification. The message encoding is
1570       NOT used here, only plain text messages.
1571     </para>
1572     <para>
1573       In examples, "C:" and "S:" indicate lines sent by the client and
1574       server respectively.
1575     </para>
1576     <sect2 id="auth-protocol-overview">
1577       <title>Protocol Overview</title>
1578       <para>
1579         The protocol is a line-based protocol, where each line ends with
1580         \r\n. Each line begins with an all-caps ASCII command name containing
1581         only the character range [A-Z_], a space, then any arguments for the
1582         command, then the \r\n ending the line. The protocol is
1583         case-sensitive. All bytes must be in the ASCII character set.
1584
1585         Commands from the client to the server are as follows:
1586
1587         <itemizedlist>
1588           <listitem><para>AUTH [mechanism] [initial-response]</para></listitem>
1589           <listitem><para>CANCEL</para></listitem>
1590           <listitem><para>BEGIN</para></listitem>
1591           <listitem><para>DATA &lt;data in hex encoding&gt;</para></listitem>
1592           <listitem><para>ERROR [human-readable error explanation]</para></listitem>
1593           <listitem><para>NEGOTIATE_UNIX_FD</para></listitem>
1594         </itemizedlist>
1595
1596         From server to client are as follows:
1597
1598         <itemizedlist>
1599           <listitem><para>REJECTED &lt;space-separated list of mechanism names&gt;</para></listitem>
1600           <listitem><para>OK &lt;GUID in hex&gt;</para></listitem>
1601           <listitem><para>DATA &lt;data in hex encoding&gt;</para></listitem>
1602           <listitem><para>ERROR</para></listitem>
1603           <listitem><para>AGREE_UNIX_FD</para></listitem>
1604         </itemizedlist>
1605       </para>
1606       <para>
1607         Unofficial extensions to the command set must begin with the letters
1608         "EXTENSION_", to avoid conflicts with future official commands.
1609         For example, "EXTENSION_COM_MYDOMAIN_DO_STUFF".
1610       </para>
1611     </sect2>
1612     <sect2 id="auth-nul-byte">
1613       <title>Special credentials-passing nul byte</title>
1614       <para>
1615         Immediately after connecting to the server, the client must send a
1616         single nul byte. This byte may be accompanied by credentials
1617         information on some operating systems that use sendmsg() with
1618         SCM_CREDS or SCM_CREDENTIALS to pass credentials over UNIX domain
1619         sockets. However, the nul byte must be sent even on other kinds of
1620         socket, and even on operating systems that do not require a byte to be
1621         sent in order to transmit credentials. The text protocol described in
1622         this document begins after the single nul byte. If the first byte
1623         received from the client is not a nul byte, the server may disconnect
1624         that client.
1625       </para>
1626       <para>
1627         A nul byte in any context other than the initial byte is an error;
1628         the protocol is ASCII-only.
1629       </para>
1630       <para>
1631         The credentials sent along with the nul byte may be used with the
1632         SASL mechanism EXTERNAL.
1633       </para>
1634     </sect2>
1635     <sect2 id="auth-command-auth">
1636       <title>AUTH command</title>
1637       <para>
1638         If an AUTH command has no arguments, it is a request to list
1639         available mechanisms. The server must respond with a REJECTED
1640         command listing the mechanisms it understands, or with an error.
1641       </para>
1642       <para>
1643         If an AUTH command specifies a mechanism, and the server supports
1644         said mechanism, the server should begin exchanging SASL
1645         challenge-response data with the client using DATA commands.
1646       </para>
1647       <para>
1648         If the server does not support the mechanism given in the AUTH
1649         command, it must send either a REJECTED command listing the mechanisms
1650         it does support, or an error.
1651       </para>
1652       <para>
1653         If the [initial-response] argument is provided, it is intended for use
1654         with mechanisms that have no initial challenge (or an empty initial
1655         challenge), as if it were the argument to an initial DATA command. If
1656         the selected mechanism has an initial challenge and [initial-response]
1657         was provided, the server should reject authentication by sending
1658         REJECTED.
1659       </para>
1660       <para>
1661         If authentication succeeds after exchanging DATA commands,
1662         an OK command must be sent to the client.
1663       </para>
1664       <para>
1665         The first octet received by the server after the \r\n of the BEGIN
1666         command from the client must be the first octet of the
1667         authenticated/encrypted stream of D-Bus messages.
1668       </para>
1669       <para>
1670         If BEGIN is received by the server, the first octet received
1671         by the client after the \r\n of the OK command must be the
1672         first octet of the authenticated/encrypted stream of D-Bus
1673         messages.
1674       </para>
1675     </sect2>
1676     <sect2 id="auth-command-cancel">
1677       <title>CANCEL Command</title>
1678       <para>
1679         At any time up to sending the BEGIN command, the client may send a
1680         CANCEL command. On receiving the CANCEL command, the server must
1681         send a REJECTED command and abort the current authentication
1682         exchange.
1683       </para>
1684     </sect2>
1685     <sect2 id="auth-command-data">
1686       <title>DATA Command</title>
1687       <para>
1688         The DATA command may come from either client or server, and simply
1689         contains a hex-encoded block of data to be interpreted
1690         according to the SASL mechanism in use.
1691       </para>
1692       <para>
1693         Some SASL mechanisms support sending an "empty string";
1694         FIXME we need some way to do this.
1695       </para>
1696     </sect2>
1697     <sect2 id="auth-command-begin">
1698       <title>BEGIN Command</title>
1699       <para>
1700         The BEGIN command acknowledges that the client has received an
1701         OK command from the server, and that the stream of messages
1702         is about to begin.
1703       </para>
1704       <para>
1705         The first octet received by the server after the \r\n of the BEGIN
1706         command from the client must be the first octet of the
1707         authenticated/encrypted stream of D-Bus messages.
1708       </para>
1709     </sect2>
1710     <sect2 id="auth-command-rejected">
1711       <title>REJECTED Command</title>
1712       <para>
1713         The REJECTED command indicates that the current authentication
1714         exchange has failed, and further exchange of DATA is inappropriate.
1715         The client would normally try another mechanism, or try providing
1716         different responses to challenges.
1717       </para><para>
1718         Optionally, the REJECTED command has a space-separated list of
1719         available auth mechanisms as arguments. If a server ever provides
1720         a list of supported mechanisms, it must provide the same list
1721         each time it sends a REJECTED message. Clients are free to
1722         ignore all lists received after the first.
1723       </para>
1724     </sect2>
1725     <sect2 id="auth-command-ok">
1726       <title>OK Command</title>
1727       <para>
1728         The OK command indicates that the client has been
1729         authenticated. The client may now proceed with negotiating
1730         Unix file descriptor passing. To do that it shall send
1731         NEGOTIATE_UNIX_FD to the server.
1732       </para>
1733       <para>
1734         Otherwise, the client must respond to the OK command by
1735         sending a BEGIN command, followed by its stream of messages,
1736         or by disconnecting.  The server must not accept additional
1737         commands using this protocol after the BEGIN command has been
1738         received. Further communication will be a stream of D-Bus
1739         messages (optionally encrypted, as negotiated) rather than
1740         this protocol.
1741       </para>
1742       <para>
1743         If a client sends BEGIN the first octet received by the client
1744         after the \r\n of the OK command must be the first octet of
1745         the authenticated/encrypted stream of D-Bus messages.
1746       </para>
1747       <para>
1748         The OK command has one argument, which is the GUID of the server.
1749         See <xref linkend="addresses"/> for more on server GUIDs.
1750       </para>
1751     </sect2>
1752     <sect2 id="auth-command-error">
1753       <title>ERROR Command</title>
1754       <para>
1755         The ERROR command indicates that either server or client did not
1756         know a command, does not accept the given command in the current
1757         context, or did not understand the arguments to the command. This
1758         allows the protocol to be extended; a client or server can send a
1759         command present or permitted only in new protocol versions, and if
1760         an ERROR is received instead of an appropriate response, fall back
1761         to using some other technique.
1762       </para>
1763       <para>
1764         If an ERROR is sent, the server or client that sent the
1765         error must continue as if the command causing the ERROR had never been
1766         received. However, the the server or client receiving the error
1767         should try something other than whatever caused the error;
1768         if only canceling/rejecting the authentication.
1769       </para>
1770       <para>
1771         If the D-Bus protocol changes incompatibly at some future time,
1772         applications implementing the new protocol would probably be able to
1773         check for support of the new protocol by sending a new command and
1774         receiving an ERROR from applications that don't understand it. Thus the
1775         ERROR feature of the auth protocol is an escape hatch that lets us
1776         negotiate extensions or changes to the D-Bus protocol in the future.
1777       </para>
1778     </sect2>
1779     <sect2 id="auth-command-negotiate-unix-fd">
1780       <title>NEGOTIATE_UNIX_FD Command</title>
1781       <para>
1782         The NEGOTIATE_UNIX_FD command indicates that the client
1783         supports Unix file descriptor passing. This command may only
1784         be sent after the connection is authenticated, i.e. after OK
1785         was received by the client. This command may only be sent on
1786         transports that support Unix file descriptor passing.
1787       </para>
1788       <para>
1789         On receiving NEGOTIATE_UNIX_FD the server must respond with
1790         either AGREE_UNIX_FD or ERROR. It shall respond the former if
1791         the transport chosen supports Unix file descriptor passing and
1792         the server supports this feature. It shall respond the latter
1793         if the transport does not support Unix file descriptor
1794         passing, the server does not support this feature, or the
1795         server decides not to enable file descriptor passing due to
1796         security or other reasons.
1797       </para>
1798     </sect2>
1799     <sect2 id="auth-command-agree-unix-fd">
1800       <title>AGREE_UNIX_FD Command</title>
1801       <para>
1802         The AGREE_UNIX_FD command indicates that the server supports
1803         Unix file descriptor passing. This command may only be sent
1804         after the connection is authenticated, and the client sent
1805         NEGOTIATE_UNIX_FD to enable Unix file descriptor passing. This
1806         command may only be sent on transports that support Unix file
1807         descriptor passing.
1808       </para>
1809       <para>
1810         On receiving AGREE_UNIX_FD the client must respond with BEGIN,
1811         followed by its stream of messages, or by disconnecting.  The
1812         server must not accept additional commands using this protocol
1813         after the BEGIN command has been received. Further
1814         communication will be a stream of D-Bus messages (optionally
1815         encrypted, as negotiated) rather than this protocol.
1816       </para>
1817     </sect2>
1818     <sect2 id="auth-command-future">
1819       <title>Future Extensions</title>
1820       <para>
1821         Future extensions to the authentication and negotiation
1822         protocol are possible. For that new commands may be
1823         introduced. If a client or server receives an unknown command
1824         it shall respond with ERROR and not consider this fatal. New
1825         commands may be introduced both before, and after
1826         authentication, i.e. both before and after the OK command.
1827       </para>
1828     </sect2>
1829     <sect2 id="auth-examples">
1830       <title>Authentication examples</title>
1831
1832       <para>
1833         <figure>
1834           <title>Example of successful magic cookie authentication</title>
1835           <programlisting>
1836             (MAGIC_COOKIE is a made up mechanism)
1837
1838             C: AUTH MAGIC_COOKIE 3138363935333137393635383634
1839             S: OK 1234deadbeef
1840             C: BEGIN
1841           </programlisting>
1842         </figure>
1843         <figure>
1844           <title>Example of finding out mechanisms then picking one</title>
1845           <programlisting>
1846             C: AUTH
1847             S: REJECTED KERBEROS_V4 SKEY
1848             C: AUTH SKEY 7ab83f32ee
1849             S: DATA 8799cabb2ea93e
1850             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
1851             S: OK 1234deadbeef
1852             C: BEGIN
1853           </programlisting>
1854         </figure>
1855         <figure>
1856           <title>Example of client sends unknown command then falls back to regular auth</title>
1857           <programlisting>
1858             C: FOOBAR
1859             S: ERROR
1860             C: AUTH MAGIC_COOKIE 3736343435313230333039
1861             S: OK 1234deadbeef
1862             C: BEGIN
1863           </programlisting>
1864         </figure>
1865         <figure>
1866           <title>Example of server doesn't support initial auth mechanism</title>
1867           <programlisting>
1868             C: AUTH MAGIC_COOKIE 3736343435313230333039
1869             S: REJECTED KERBEROS_V4 SKEY
1870             C: AUTH SKEY 7ab83f32ee
1871             S: DATA 8799cabb2ea93e
1872             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
1873             S: OK 1234deadbeef
1874             C: BEGIN
1875           </programlisting>
1876         </figure>
1877         <figure>
1878           <title>Example of wrong password or the like followed by successful retry</title>
1879           <programlisting>
1880             C: AUTH MAGIC_COOKIE 3736343435313230333039
1881             S: REJECTED KERBEROS_V4 SKEY
1882             C: AUTH SKEY 7ab83f32ee
1883             S: DATA 8799cabb2ea93e
1884             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
1885             S: REJECTED
1886             C: AUTH SKEY 7ab83f32ee
1887             S: DATA 8799cabb2ea93e
1888             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
1889             S: OK 1234deadbeef
1890             C: BEGIN
1891           </programlisting>
1892         </figure>
1893         <figure>
1894           <title>Example of skey cancelled and restarted</title>
1895           <programlisting>
1896             C: AUTH MAGIC_COOKIE 3736343435313230333039
1897             S: REJECTED KERBEROS_V4 SKEY
1898             C: AUTH SKEY 7ab83f32ee
1899             S: DATA 8799cabb2ea93e
1900             C: CANCEL
1901             S: REJECTED
1902             C: AUTH SKEY 7ab83f32ee
1903             S: DATA 8799cabb2ea93e
1904             C: DATA 8ac876e8f68ee9809bfa876e6f9876g8fa8e76e98f
1905             S: OK 1234deadbeef
1906             C: BEGIN
1907           </programlisting>
1908         </figure>
1909         <figure>
1910           <title>Example of successful magic cookie authentication with successful negotiation of Unix FD passing</title>
1911           <programlisting>
1912             (MAGIC_COOKIE is a made up mechanism)
1913
1914             C: AUTH MAGIC_COOKIE 3138363935333137393635383634
1915             S: OK 1234deadbeef
1916             C: NEGOTIATE_UNIX_FD
1917             S: AGREE_UNIX_FD
1918             C: BEGIN
1919           </programlisting>
1920         </figure>
1921         <figure>
1922           <title>Example of successful magic cookie authentication with unsuccessful negotiation of Unix FD passing</title>
1923           <programlisting>
1924             (MAGIC_COOKIE is a made up mechanism)
1925
1926             C: AUTH MAGIC_COOKIE 3138363935333137393635383634
1927             S: OK 1234deadbeef
1928             C: NEGOTIATE_UNIX_FD
1929             S: ERROR
1930             C: BEGIN
1931           </programlisting>
1932         </figure>
1933       </para>
1934     </sect2>
1935     <sect2 id="auth-states">
1936       <title>Authentication state diagrams</title>
1937
1938       <para>
1939         This section documents the auth protocol in terms of
1940         a state machine for the client and the server. This is
1941         probably the most robust way to implement the protocol.
1942       </para>
1943
1944       <sect3 id="auth-states-client">
1945         <title>Client states</title>
1946
1947         <para>
1948           To more precisely describe the interaction between the
1949           protocol state machine and the authentication mechanisms the
1950           following notation is used: MECH(CHALL) means that the
1951           server challenge CHALL was fed to the mechanism MECH, which
1952           returns one of
1953
1954           <itemizedlist>
1955             <listitem>
1956               <para>
1957                 CONTINUE(RESP) means continue the auth conversation
1958                 and send RESP as the response to the server;
1959               </para>
1960             </listitem>
1961
1962             <listitem>
1963               <para>
1964                 OK(RESP) means that after sending RESP to the server
1965                 the client side of the auth conversation is finished
1966                 and the server should return "OK";
1967               </para>
1968             </listitem>
1969
1970             <listitem>
1971               <para>
1972                 ERROR means that CHALL was invalid and could not be
1973                 processed.
1974               </para>
1975             </listitem>
1976           </itemizedlist>
1977
1978           Both RESP and CHALL may be empty.
1979         </para>
1980
1981         <para>
1982           The Client starts by getting an initial response from the
1983           default mechanism and sends AUTH MECH RESP, or AUTH MECH if
1984           the mechanism did not provide an initial response.  If the
1985           mechanism returns CONTINUE, the client starts in state
1986           <emphasis>WaitingForData</emphasis>, if the mechanism
1987           returns OK the client starts in state
1988           <emphasis>WaitingForOK</emphasis>.
1989         </para>
1990
1991         <para>
1992           The client should keep track of available mechanisms and
1993           which it mechanisms it has already attempted. This list is
1994           used to decide which AUTH command to send. When the list is
1995           exhausted, the client should give up and close the
1996           connection.
1997         </para>
1998
1999         <formalpara>
2000           <title><emphasis>WaitingForData</emphasis></title>
2001           <para>
2002             <itemizedlist>
2003               <listitem>
2004                 <para>
2005                   Receive DATA CHALL
2006                   <simplelist>
2007                     <member>
2008                       MECH(CHALL) returns CONTINUE(RESP) &rarr; send
2009                       DATA RESP, goto
2010                       <emphasis>WaitingForData</emphasis>
2011                     </member>
2012
2013                     <member>
2014                       MECH(CHALL) returns OK(RESP) &rarr; send DATA
2015                       RESP, goto <emphasis>WaitingForOK</emphasis>
2016                     </member>
2017
2018                     <member>
2019                       MECH(CHALL) returns ERROR &rarr; send ERROR
2020                       [msg], goto <emphasis>WaitingForData</emphasis>
2021                     </member>
2022                   </simplelist>
2023                 </para>
2024               </listitem>
2025
2026               <listitem>
2027                 <para>
2028                   Receive REJECTED [mechs] &rarr;
2029                   send AUTH [next mech], goto
2030                   WaitingForData or <emphasis>WaitingForOK</emphasis>
2031                 </para>
2032               </listitem>
2033               <listitem>
2034                 <para>
2035                   Receive ERROR &rarr; send
2036                   CANCEL, goto
2037                   <emphasis>WaitingForReject</emphasis>
2038                 </para>
2039               </listitem>
2040               <listitem>
2041                 <para>
2042                   Receive OK &rarr; send
2043                   BEGIN, terminate auth
2044                   conversation, authenticated
2045                 </para>
2046               </listitem>
2047               <listitem>
2048                 <para>
2049                   Receive anything else &rarr; send
2050                   ERROR, goto
2051                   <emphasis>WaitingForData</emphasis>
2052                 </para>
2053               </listitem>
2054             </itemizedlist>
2055           </para>
2056         </formalpara>
2057
2058         <formalpara>
2059           <title><emphasis>WaitingForOK</emphasis></title>
2060           <para>
2061             <itemizedlist>
2062               <listitem>
2063                 <para>
2064                   Receive OK &rarr; send BEGIN, terminate auth
2065                   conversation, <emphasis>authenticated</emphasis>
2066                 </para>
2067               </listitem>
2068               <listitem>
2069                 <para>
2070                   Receive REJECT [mechs] &rarr; send AUTH [next mech],
2071                   goto <emphasis>WaitingForData</emphasis> or
2072                   <emphasis>WaitingForOK</emphasis>
2073                 </para>
2074               </listitem>
2075
2076               <listitem>
2077                 <para>
2078                   Receive DATA &rarr; send CANCEL, goto
2079                   <emphasis>WaitingForReject</emphasis>
2080                 </para>
2081               </listitem>
2082
2083               <listitem>
2084                 <para>
2085                   Receive ERROR &rarr; send CANCEL, goto
2086                   <emphasis>WaitingForReject</emphasis>
2087                 </para>
2088               </listitem>
2089
2090               <listitem>
2091                 <para>
2092                   Receive anything else &rarr; send ERROR, goto
2093                   <emphasis>WaitingForOK</emphasis>
2094                 </para>
2095               </listitem>
2096             </itemizedlist>
2097           </para>
2098         </formalpara>
2099
2100         <formalpara>
2101           <title><emphasis>WaitingForReject</emphasis></title>
2102           <para>
2103             <itemizedlist>
2104               <listitem>
2105                 <para>
2106                   Receive REJECT [mechs] &rarr; send AUTH [next mech],
2107                   goto <emphasis>WaitingForData</emphasis> or
2108                   <emphasis>WaitingForOK</emphasis>
2109                 </para>
2110               </listitem>
2111
2112               <listitem>
2113                 <para>
2114                   Receive anything else &rarr; terminate auth
2115                   conversation, disconnect
2116                 </para>
2117               </listitem>
2118             </itemizedlist>
2119           </para>
2120         </formalpara>
2121
2122       </sect3>
2123
2124       <sect3 id="auth-states-server">
2125         <title>Server states</title>
2126
2127         <para>
2128           For the server MECH(RESP) means that the client response
2129           RESP was fed to the the mechanism MECH, which returns one of
2130
2131           <itemizedlist>
2132             <listitem>
2133               <para>
2134                 CONTINUE(CHALL) means continue the auth conversation and
2135                 send CHALL as the challenge to the client;
2136               </para>
2137             </listitem>
2138
2139             <listitem>
2140               <para>
2141                 OK means that the client has been successfully
2142                 authenticated;
2143               </para>
2144             </listitem>
2145
2146             <listitem>
2147               <para>
2148                 REJECT means that the client failed to authenticate or
2149                 there was an error in RESP.
2150               </para>
2151             </listitem>
2152           </itemizedlist>
2153
2154           The server starts out in state
2155           <emphasis>WaitingForAuth</emphasis>.  If the client is
2156           rejected too many times the server must disconnect the
2157           client.
2158         </para>
2159
2160         <formalpara>
2161           <title><emphasis>WaitingForAuth</emphasis></title>
2162           <para>
2163             <itemizedlist>
2164
2165               <listitem>
2166                 <para>
2167                   Receive AUTH &rarr; send REJECTED [mechs], goto
2168                   <emphasis>WaitingForAuth</emphasis>
2169                 </para>
2170               </listitem>
2171
2172               <listitem>
2173                 <para>
2174                   Receive AUTH MECH RESP
2175
2176                   <simplelist>
2177                     <member>
2178                       MECH not valid mechanism &rarr; send REJECTED
2179                       [mechs], goto
2180                       <emphasis>WaitingForAuth</emphasis>
2181                     </member>
2182
2183                     <member>
2184                       MECH(RESP) returns CONTINUE(CHALL) &rarr; send
2185                       DATA CHALL, goto
2186                       <emphasis>WaitingForData</emphasis>
2187                     </member>
2188
2189                     <member>
2190                       MECH(RESP) returns OK &rarr; send OK, goto
2191                       <emphasis>WaitingForBegin</emphasis>
2192                     </member>
2193
2194                     <member>
2195                       MECH(RESP) returns REJECT &rarr; send REJECTED
2196                       [mechs], goto
2197                       <emphasis>WaitingForAuth</emphasis>
2198                     </member>
2199                   </simplelist>
2200                 </para>
2201               </listitem>
2202
2203               <listitem>
2204                 <para>
2205                   Receive BEGIN &rarr; terminate
2206                   auth conversation, disconnect
2207                 </para>
2208               </listitem>
2209
2210               <listitem>
2211                 <para>
2212                   Receive ERROR &rarr; send REJECTED [mechs], goto
2213                   <emphasis>WaitingForAuth</emphasis>
2214                 </para>
2215               </listitem>
2216
2217               <listitem>
2218                 <para>
2219                   Receive anything else &rarr; send
2220                   ERROR, goto
2221                   <emphasis>WaitingForAuth</emphasis>
2222                 </para>
2223               </listitem>
2224             </itemizedlist>
2225           </para>
2226         </formalpara>
2227
2228
2229         <formalpara>
2230           <title><emphasis>WaitingForData</emphasis></title>
2231           <para>
2232             <itemizedlist>
2233               <listitem>
2234                 <para>
2235                   Receive DATA RESP
2236                   <simplelist>
2237                     <member>
2238                       MECH(RESP) returns CONTINUE(CHALL) &rarr; send
2239                       DATA CHALL, goto
2240                       <emphasis>WaitingForData</emphasis>
2241                     </member>
2242
2243                     <member>
2244                       MECH(RESP) returns OK &rarr; send OK, goto
2245                       <emphasis>WaitingForBegin</emphasis>
2246                     </member>
2247
2248                     <member>
2249                       MECH(RESP) returns REJECT &rarr; send REJECTED
2250                       [mechs], goto
2251                       <emphasis>WaitingForAuth</emphasis>
2252                     </member>
2253                   </simplelist>
2254                 </para>
2255               </listitem>
2256
2257               <listitem>
2258                 <para>
2259                   Receive BEGIN &rarr; terminate auth conversation,
2260                   disconnect
2261                 </para>
2262               </listitem>
2263
2264               <listitem>
2265                 <para>
2266                   Receive CANCEL &rarr; send REJECTED [mechs], goto
2267                   <emphasis>WaitingForAuth</emphasis>
2268                 </para>
2269               </listitem>
2270
2271               <listitem>
2272                 <para>
2273                   Receive ERROR &rarr; send REJECTED [mechs], goto
2274                   <emphasis>WaitingForAuth</emphasis>
2275                 </para>
2276               </listitem>
2277
2278               <listitem>
2279                 <para>
2280                   Receive anything else &rarr; send ERROR, goto
2281                   <emphasis>WaitingForData</emphasis>
2282                 </para>
2283               </listitem>
2284             </itemizedlist>
2285           </para>
2286         </formalpara>
2287
2288         <formalpara>
2289           <title><emphasis>WaitingForBegin</emphasis></title>
2290           <para>
2291             <itemizedlist>
2292               <listitem>
2293                 <para>
2294                   Receive BEGIN &rarr; terminate auth conversation,
2295                   client authenticated
2296                 </para>
2297               </listitem>
2298
2299               <listitem>
2300                 <para>
2301                   Receive CANCEL &rarr; send REJECTED [mechs], goto
2302                   <emphasis>WaitingForAuth</emphasis>
2303                 </para>
2304               </listitem>
2305
2306               <listitem>
2307                 <para>
2308                   Receive ERROR &rarr; send REJECTED [mechs], goto
2309                   <emphasis>WaitingForAuth</emphasis>
2310                 </para>
2311               </listitem>
2312
2313               <listitem>
2314                 <para>
2315                   Receive anything else &rarr; send ERROR, goto
2316                   <emphasis>WaitingForBegin</emphasis>
2317                 </para>
2318               </listitem>
2319             </itemizedlist>
2320           </para>
2321         </formalpara>
2322
2323       </sect3>
2324
2325     </sect2>
2326     <sect2 id="auth-mechanisms">
2327       <title>Authentication mechanisms</title>
2328       <para>
2329         This section describes some new authentication mechanisms.
2330         D-Bus also allows any standard SASL mechanism of course.
2331       </para>
2332       <sect3 id="auth-mechanisms-sha">
2333         <title>DBUS_COOKIE_SHA1</title>
2334         <para>
2335           The DBUS_COOKIE_SHA1 mechanism is designed to establish that a client
2336           has the ability to read a private file owned by the user being
2337           authenticated. If the client can prove that it has access to a secret
2338           cookie stored in this file, then the client is authenticated.
2339           Thus the security of DBUS_COOKIE_SHA1 depends on a secure home
2340           directory.
2341         </para>
2342         <para>
2343           Throughout this description, "hex encoding" must output the digits
2344           from a to f in lower-case; the digits A to F must not be used
2345           in the DBUS_COOKIE_SHA1 mechanism.
2346         </para>
2347         <para>
2348           Authentication proceeds as follows:
2349           <itemizedlist>
2350             <listitem>
2351               <para>
2352                 The client sends the username it would like to authenticate
2353                 as, hex-encoded.
2354               </para>
2355             </listitem>
2356             <listitem>
2357               <para>
2358                 The server sends the name of its "cookie context" (see below); a
2359                 space character; the integer ID of the secret cookie the client
2360                 must demonstrate knowledge of; a space character; then a
2361                 randomly-generated challenge string, all of this hex-encoded into
2362                 one, single string.
2363               </para>
2364             </listitem>
2365             <listitem>
2366               <para>
2367                 The client locates the cookie and generates its own
2368                 randomly-generated challenge string. The client then concatenates
2369                 the server's decoded challenge, a ":" character, its own challenge,
2370                 another ":" character, and the cookie. It computes the SHA-1 hash
2371                 of this composite string as a hex digest. It concatenates the
2372                 client's challenge string, a space character, and the SHA-1 hex
2373                 digest, hex-encodes the result and sends it back to the server.
2374               </para>
2375             </listitem>
2376             <listitem>
2377               <para>
2378                 The server generates the same concatenated string used by the
2379                 client and computes its SHA-1 hash. It compares the hash with
2380                 the hash received from the client; if the two hashes match, the
2381                 client is authenticated.
2382               </para>
2383             </listitem>
2384           </itemizedlist>
2385         </para>
2386         <para>
2387           Each server has a "cookie context," which is a name that identifies a
2388           set of cookies that apply to that server. A sample context might be
2389           "org_freedesktop_session_bus". Context names must be valid ASCII,
2390           nonzero length, and may not contain the characters slash ("/"),
2391           backslash ("\"), space (" "), newline ("\n"), carriage return ("\r"),
2392           tab ("\t"), or period ("."). There is a default context,
2393           "org_freedesktop_general" that's used by servers that do not specify
2394           otherwise.
2395         </para>
2396         <para>
2397           Cookies are stored in a user's home directory, in the directory
2398           <filename>~/.dbus-keyrings/</filename>. This directory must
2399           not be readable or writable by other users. If it is,
2400           clients and servers must ignore it. The directory
2401           contains cookie files named after the cookie context.
2402         </para>
2403         <para>
2404           A cookie file contains one cookie per line. Each line
2405           has three space-separated fields:
2406           <itemizedlist>
2407             <listitem>
2408               <para>
2409                 The cookie ID number, which must be a non-negative integer and
2410                 may not be used twice in the same file.
2411               </para>
2412             </listitem>
2413             <listitem>
2414               <para>
2415                 The cookie's creation time, in UNIX seconds-since-the-epoch
2416                 format.
2417               </para>
2418             </listitem>
2419             <listitem>
2420               <para>
2421                 The cookie itself, a hex-encoded random block of bytes. The cookie
2422                 may be of any length, though obviously security increases
2423                 as the length increases.
2424               </para>
2425             </listitem>
2426           </itemizedlist>
2427         </para>
2428         <para>
2429           Only server processes modify the cookie file.
2430           They must do so with this procedure:
2431           <itemizedlist>
2432             <listitem>
2433               <para>
2434                 Create a lockfile name by appending ".lock" to the name of the
2435                 cookie file.  The server should attempt to create this file
2436                 using <literal>O_CREAT | O_EXCL</literal>.  If file creation
2437                 fails, the lock fails. Servers should retry for a reasonable
2438                 period of time, then they may choose to delete an existing lock
2439                 to keep users from having to manually delete a stale
2440                 lock. <footnote><para>Lockfiles are used instead of real file
2441                 locking <literal>fcntl()</literal> because real locking
2442                 implementations are still flaky on network
2443                 filesystems.</para></footnote>
2444               </para>
2445             </listitem>
2446             <listitem>
2447               <para>
2448                 Once the lockfile has been created, the server loads the cookie
2449                 file. It should then delete any cookies that are old (the
2450                 timeout can be fairly short), or more than a reasonable
2451                 time in the future (so that cookies never accidentally
2452                 become permanent, if the clock was set far into the future
2453                 at some point). If no recent keys remain, the
2454                 server may generate a new key.
2455               </para>
2456             </listitem>
2457             <listitem>
2458               <para>
2459                 The pruned and possibly added-to cookie file
2460                 must be resaved atomically (using a temporary
2461                 file which is rename()'d).
2462               </para>
2463             </listitem>
2464             <listitem>
2465               <para>
2466                 The lock must be dropped by deleting the lockfile.
2467               </para>
2468             </listitem>
2469           </itemizedlist>
2470         </para>
2471         <para>
2472           Clients need not lock the file in order to load it,
2473           because servers are required to save the file atomically.
2474         </para>
2475       </sect3>
2476     </sect2>
2477   </sect1>
2478   <sect1 id="addresses">
2479     <title>Server Addresses</title>
2480     <para>
2481       Server addresses consist of a transport name followed by a colon, and
2482       then an optional, comma-separated list of keys and values in the form key=value.
2483       Each value is escaped.
2484     </para>
2485     <para>
2486       For example:
2487       <programlisting>unix:path=/tmp/dbus-test</programlisting>
2488       Which is the address to a unix socket with the path /tmp/dbus-test.
2489     </para>
2490     <para>
2491       Value escaping is similar to URI escaping but simpler.
2492       <itemizedlist>
2493         <listitem>
2494           <para>
2495             The set of optionally-escaped bytes is:
2496             <literal>[0-9A-Za-z_-/.\]</literal>. To escape, each
2497             <emphasis>byte</emphasis> (note, not character) which is not in the
2498             set of optionally-escaped bytes must be replaced with an ASCII
2499             percent (<literal>%</literal>) and the value of the byte in hex.
2500             The hex value must always be two digits, even if the first digit is
2501             zero. The optionally-escaped bytes may be escaped if desired.
2502           </para>
2503         </listitem>
2504         <listitem>
2505           <para>
2506             To unescape, append each byte in the value; if a byte is an ASCII
2507             percent (<literal>%</literal>) character then append the following
2508             hex value instead. It is an error if a <literal>%</literal> byte
2509             does not have two hex digits following. It is an error if a
2510             non-optionally-escaped byte is seen unescaped.
2511           </para>
2512         </listitem>
2513       </itemizedlist>
2514       The set of optionally-escaped bytes is intended to preserve address
2515       readability and convenience.
2516     </para>
2517
2518     <para>
2519       A server may specify a key-value pair with the key <literal>guid</literal>
2520       and the value a hex-encoded 16-byte sequence. <xref linkend="uuids"/>
2521       describes the format of the <literal>guid</literal> field.  If present,
2522       this UUID may be used to distinguish one server address from another. A
2523       server should use a different UUID for each address it listens on. For
2524       example, if a message bus daemon offers both UNIX domain socket and TCP
2525       connections, but treats clients the same regardless of how they connect,
2526       those two connections are equivalent post-connection but should have
2527       distinct UUIDs to distinguish the kinds of connection.
2528     </para>
2529
2530     <para>
2531       The intent of the address UUID feature is to allow a client to avoid
2532       opening multiple identical connections to the same server, by allowing the
2533       client to check whether an address corresponds to an already-existing
2534       connection.  Comparing two addresses is insufficient, because addresses
2535       can be recycled by distinct servers, and equivalent addresses may look
2536       different if simply compared as strings (for example, the host in a TCP
2537       address can be given as an IP address or as a hostname).
2538     </para>
2539
2540     <para>
2541       Note that the address key is <literal>guid</literal> even though the
2542       rest of the API and documentation says "UUID," for historical reasons.
2543     </para>
2544
2545     <para>
2546       [FIXME clarify if attempting to connect to each is a requirement
2547       or just a suggestion]
2548       When connecting to a server, multiple server addresses can be
2549       separated by a semi-colon. The library will then try to connect
2550       to the first address and if that fails, it'll try to connect to
2551       the next one specified, and so forth. For example
2552       <programlisting>unix:path=/tmp/dbus-test;unix:path=/tmp/dbus-test2</programlisting>
2553     </para>
2554
2555   </sect1>
2556
2557   <sect1 id="transports">
2558     <title>Transports</title>
2559     <para>
2560       [FIXME we need to specify in detail each transport and its possible arguments]
2561
2562       Current transports include: unix domain sockets (including
2563       abstract namespace on linux), launchd, TCP/IP, and a debug/testing transport
2564       using in-process pipes. Future possible transports include one that
2565       tunnels over X11 protocol.
2566     </para>
2567
2568     <sect2 id="transports-unix-domain-sockets">
2569       <title>Unix Domain Sockets</title>
2570       <para>
2571         Unix domain sockets can be either paths in the file system or on Linux
2572         kernels, they can be abstract which are similar to paths but
2573         do not show up in the file system.
2574       </para>
2575
2576       <para>
2577         When a socket is opened by the D-Bus library it truncates the path
2578         name right before the first trailing Nul byte.  This is true for both
2579         normal paths and abstract paths.  Note that this is a departure from
2580         previous versions of D-Bus that would create sockets with a fixed
2581         length path name.  Names which were shorter than the fixed length
2582         would be padded by Nul bytes.
2583       </para>
2584       <para>
2585         Unix domain sockets are not available on windows.
2586       </para>
2587       <sect3 id="transports-unix-domain-sockets-addresses">
2588         <title>Server Address Format</title>
2589         <para>
2590           Unix domain socket addresses are identified by the "unix:" prefix
2591           and support the following key/value pairs:
2592         </para>
2593         <informaltable>
2594          <tgroup cols="3">
2595           <thead>
2596            <row>
2597             <entry>Name</entry>
2598             <entry>Values</entry>
2599             <entry>Description</entry>
2600            </row>
2601           </thead>
2602           <tbody>
2603            <row>
2604             <entry>path</entry>
2605             <entry>(path)</entry>
2606             <entry>path of the unix domain socket. If set, the "tmpdir" and "abstract" key must not be set.</entry>
2607           </row>
2608           <row>
2609             <entry>tmpdir</entry>
2610             <entry>(path)</entry>
2611             <entry>temporary directory in which a socket file with a random file name starting with 'dbus-' will be created by the server. This key can only be used in server addresses, not in client addresses. If set, the "path" and "abstract" key must not be set.</entry>
2612           </row>
2613           <row>
2614             <entry>abstract</entry>
2615             <entry>(string)</entry>
2616             <entry>unique string (path) in the abstract namespace. If set, the "path" or "tempdir" key must not be set.</entry>
2617           </row>
2618         </tbody>
2619         </tgroup>
2620        </informaltable>
2621       </sect3>
2622     </sect2>
2623     <sect2 id="transports-launchd">
2624       <title>launchd</title>
2625       <para>
2626         launchd is a open-source server management system that replaces init, inetd
2627         and cron on Apple Mac OS X versions 10.4 and above. It provides a common session
2628         bus address for each user and deprecates the X11-enabled D-Bus launcher on OSX.
2629       </para>
2630
2631       <para>
2632         launchd allocates a socket and provides it with the unix path through the
2633         DBUS_LAUNCHD_SESSION_BUS_SOCKET variable in launchd's environment. Every process
2634         spawned by launchd (or dbus-daemon, if it was started by launchd) can access
2635         it through its environment.
2636         Other processes can query for the launchd socket by executing:
2637         $ launchctl getenv DBUS_LAUNCHD_SESSION_BUS_SOCKET
2638         This is normally done by the D-Bus client library so doesn't have to be done
2639         manually.
2640       </para>
2641       <para>
2642         launchd is not available on Microsoft Windows.
2643       </para>
2644       <sect3 id="transports-launchd-addresses">
2645         <title>Server Address Format</title>
2646         <para>
2647           launchd addresses are identified by the "launchd:" prefix
2648           and support the following key/value pairs:
2649         </para>
2650         <informaltable>
2651          <tgroup cols="3">
2652           <thead>
2653            <row>
2654             <entry>Name</entry>
2655             <entry>Values</entry>
2656             <entry>Description</entry>
2657            </row>
2658           </thead>
2659           <tbody>
2660            <row>
2661             <entry>env</entry>
2662             <entry>(environment variable)</entry>
2663             <entry>path of the unix domain socket for the launchd created dbus-daemon.</entry>
2664           </row>
2665         </tbody>
2666         </tgroup>
2667        </informaltable>
2668       </sect3>
2669     </sect2>
2670     <sect2 id="transports-tcp-sockets">
2671       <title>TCP Sockets</title>
2672       <para>
2673         The tcp transport provides TCP/IP based connections between clients
2674         located on the same or different hosts.
2675       </para>
2676       <para>
2677         Using tcp transport without any additional secure authentification mechanismus
2678         over a network is unsecure.
2679       </para>
2680       <para>
2681         Windows notes: Because of the tcp stack on windows does not provide sending
2682         credentials over a tcp connection, the EXTERNAL authentification
2683         mechanismus does not work.
2684       </para>
2685       <sect3 id="transports-tcp-sockets-addresses">
2686         <title>Server Address Format</title>
2687         <para>
2688          TCP/IP socket addresses are identified by the "tcp:" prefix
2689          and support the following key/value pairs:
2690         </para>
2691         <informaltable>
2692          <tgroup cols="3">
2693           <thead>
2694            <row>
2695             <entry>Name</entry>
2696             <entry>Values</entry>
2697             <entry>Description</entry>
2698            </row>
2699           </thead>
2700           <tbody>
2701            <row>
2702             <entry>host</entry>
2703             <entry>(string)</entry>
2704             <entry>dns name or ip address</entry>
2705           </row>
2706           <row>
2707            <entry>port</entry>
2708            <entry>(number)</entry>
2709            <entry>The tcp port the server will open. A zero value let the server
2710             choose a free port provided from the underlaying operating system.
2711             libdbus is able to retrieve the real used port from the server.
2712            </entry>
2713           </row>
2714           <row>
2715            <entry>family</entry>
2716            <entry>(string)</entry>
2717            <entry>If set, provide the type of socket family either "ipv4" or "ipv6". If unset, the family is unspecified.</entry>
2718           </row>
2719          </tbody>
2720         </tgroup>
2721        </informaltable>
2722       </sect3>
2723     </sect2>
2724     <sect2 id="transports-nonce-tcp-sockets">
2725       <title>Nonce-secured TCP Sockets</title>
2726       <para>
2727         The nonce-tcp transport provides a secured TCP transport, using a
2728         simple authentication mechanism to ensure that only clients with read
2729         access to a certain location in the filesystem can connect to the server.
2730         The server writes a secret, the nonce, to a file and an incoming client
2731         connection is only accepted if the client sends the nonce right after
2732         the connect. The nonce mechanism requires no setup and is orthogonal to
2733         the higher-level authentication mechanisms described in the
2734         Authentication section.
2735       </para>
2736
2737       <para>
2738         On start, the server generates a random 16 byte nonce and writes it
2739         to a file in the user's temporary directory. The nonce file location
2740         is published as part of the server's D-Bus address using the
2741         "noncefile" key-value pair.
2742
2743         After an accept, the server reads 16 bytes from the socket. If the
2744         read bytes do not match the nonce stored in the nonce file, the
2745         server MUST immediately drop the connection.
2746         If the nonce match the received byte sequence, the client is accepted
2747         and the transport behaves like an unsecured tcp transport.
2748       </para>
2749       <para>
2750         After a successful connect to the server socket, the client MUST read
2751         the nonce from the file published by the server via the noncefile=
2752         key-value pair and send it over the socket. After that, the
2753         transport behaves like an unsecured tcp transport.
2754       </para>
2755       <sect3 id="transports-nonce-tcp-sockets-addresses">
2756         <title>Server Address Format</title>
2757         <para>
2758          Nonce TCP/IP socket addresses uses the "nonce-tcp:" prefix
2759          and support the following key/value pairs:
2760         </para>
2761         <informaltable>
2762          <tgroup cols="3">
2763           <thead>
2764            <row>
2765             <entry>Name</entry>
2766             <entry>Values</entry>
2767             <entry>Description</entry>
2768            </row>
2769           </thead>
2770           <tbody>
2771            <row>
2772             <entry>host</entry>
2773             <entry>(string)</entry>
2774             <entry>dns name or ip address</entry>
2775           </row>
2776           <row>
2777            <entry>port</entry>
2778            <entry>(number)</entry>
2779            <entry>The tcp port the server will open. A zero value let the server
2780             choose a free port provided from the underlaying operating system.
2781             libdbus is able to retrieve the real used port from the server.
2782            </entry>
2783           </row>
2784           <row>
2785            <entry>family</entry>
2786            <entry>(string)</entry>
2787            <entry>If set, provide the type of socket family either "ipv4" or "ipv6". If unset, the family is unspecified.</entry>
2788           </row>
2789           <row>
2790            <entry>noncefile</entry>
2791            <entry>(path)</entry>
2792            <entry>file location containing the secret</entry>
2793           </row>
2794          </tbody>
2795         </tgroup>
2796        </informaltable>
2797       </sect3>
2798     </sect2>
2799    </sect1>
2800    <sect1 id="meta-transports">
2801     <title>Meta Transports</title>
2802     <para>
2803       Meta transports are a kind of transport with special enhancements or
2804       behavior. Currently available meta transports include: autolaunch
2805     </para>
2806
2807     <sect2 id="meta-transports-autolaunch">
2808      <title>Autolaunch</title>
2809      <para>The autolaunch transport provides a way for dbus clients to autodetect
2810        a running dbus session bus and to autolaunch a session bus if not present.
2811      </para>
2812      <sect3 id="meta-transports-autolaunch-addresses">
2813        <title>Server Address Format</title>
2814        <para>
2815          Autolaunch addresses uses the "autolaunch:" prefix and support the
2816          following key/value pairs:
2817        </para>
2818        <informaltable>
2819         <tgroup cols="3">
2820          <thead>
2821           <row>
2822            <entry>Name</entry>
2823            <entry>Values</entry>
2824            <entry>Description</entry>
2825           </row>
2826          </thead>
2827          <tbody>
2828           <row>
2829            <entry>scope</entry>
2830            <entry>(string)</entry>
2831            <entry>scope of autolaunch (Windows only)
2832             <itemizedlist>
2833              <listitem>
2834               <para>
2835                "*install-path" - limit session bus to dbus installation path.
2836                The dbus installation path is determined from the location of
2837                the shared dbus library. If the library is located in a 'bin'
2838                subdirectory the installation root is the directory above,
2839                otherwise the directory where the library lives is taken as
2840                installation root.
2841                <programlisting>
2842                    &lt;install-root&gt;/bin/[lib]dbus-1.dll
2843                    &lt;install-root&gt;/[lib]dbus-1.dll
2844                </programlisting>
2845               </para>
2846              </listitem>
2847              <listitem>
2848               <para>
2849                "*user" - limit session bus to the recent user.
2850               </para>
2851              </listitem>
2852              <listitem>
2853               <para>
2854                other values - specify dedicated session bus like "release",
2855                "debug" or other
2856               </para>
2857              </listitem>
2858             </itemizedlist>
2859            </entry>
2860          </row>
2861         </tbody>
2862        </tgroup>
2863       </informaltable>
2864      </sect3>
2865
2866      <sect3 id="meta-transports-autolaunch-windows-implementation">
2867       <title>Windows implementation</title>
2868       <para>
2869         On start, the server opens a platform specific transport, creates a mutex
2870         and a shared memory section containing the related session bus address.
2871         This mutex will be inspected by the dbus client library to detect a
2872         running dbus session bus. The access to the mutex and the shared memory
2873         section are protected by global locks.
2874       </para>
2875       <para>
2876        In the recent implementation the autolaunch transport uses a tcp transport
2877        on localhost with a port choosen from the operating system. This detail may
2878        change in the future.
2879       </para>
2880       <para>
2881         Disclaimer: The recent implementation is in an early state and may not
2882         work in all cirumstances and/or may have security issues. Because of this
2883         the implementation is not documentated yet.
2884       </para>
2885      </sect3>
2886     </sect2>
2887    </sect1>
2888    <sect1 id="naming-conventions">
2889     <title>Naming Conventions</title>
2890
2891     <para>
2892       D-Bus namespaces are all lowercase and correspond to reversed domain
2893       names, as with Java. e.g. "org.freedesktop"
2894     </para>
2895     <para>
2896       Interface, signal, method, and property names are "WindowsStyleCaps", note
2897       that the first letter is capitalized, unlike Java.
2898     </para>
2899     <para>
2900       Object paths are normally all lowercase with underscores used rather than
2901       hyphens.
2902     </para>
2903   </sect1>
2904
2905   <sect1 id="uuids">
2906     <title>UUIDs</title>
2907     <para>
2908       A working D-Bus implementation uses universally-unique IDs in two places.
2909       First, each server address has a UUID identifying the address,
2910       as described in <xref linkend="addresses"/>. Second, each operating
2911       system kernel instance running a D-Bus client or server has a UUID
2912       identifying that kernel, retrieved by invoking the method
2913       org.freedesktop.DBus.Peer.GetMachineId() (see <xref
2914       linkend="standard-interfaces-peer"/>).
2915     </para>
2916     <para>
2917       The term "UUID" in this document is intended literally, i.e. an
2918       identifier that is universally unique. It is not intended to refer to
2919       RFC4122, and in fact the D-Bus UUID is not compatible with that RFC.
2920     </para>
2921     <para>
2922       The UUID must contain 128 bits of data and be hex-encoded.  The
2923       hex-encoded string may not contain hyphens or other non-hex-digit
2924       characters, and it must be exactly 32 characters long.  To generate a
2925       UUID, the current reference implementation concatenates 96 bits of random
2926       data followed by the 32-bit time in seconds since the UNIX epoch (in big
2927       endian byte order).
2928     </para>
2929     <para>
2930       It would also be acceptable and probably better to simply generate 128
2931       bits of random data, as long as the random number generator is of high
2932       quality. The timestamp could conceivably help if the random bits are not
2933       very random. With a quality random number generator, collisions are
2934       extremely unlikely even with only 96 bits, so it's somewhat academic.
2935     </para>
2936     <para>
2937       Implementations should, however, stick to random data for the first 96 bits
2938       of the UUID.
2939     </para>
2940   </sect1>
2941
2942   <sect1 id="standard-interfaces">
2943     <title>Standard Interfaces</title>
2944     <para>
2945       See <xref linkend="message-protocol-types-notation"/> for details on
2946        the notation used in this section. There are some standard interfaces
2947       that may be useful across various D-Bus applications.
2948     </para>
2949     <sect2 id="standard-interfaces-peer">
2950       <title><literal>org.freedesktop.DBus.Peer</literal></title>
2951       <para>
2952         The <literal>org.freedesktop.DBus.Peer</literal> interface
2953         has two methods:
2954         <programlisting>
2955           org.freedesktop.DBus.Peer.Ping ()
2956           org.freedesktop.DBus.Peer.GetMachineId (out STRING machine_uuid)
2957         </programlisting>
2958       </para>
2959       <para>
2960         On receipt of the <literal>METHOD_CALL</literal> message
2961         <literal>org.freedesktop.DBus.Peer.Ping</literal>, an application should do
2962         nothing other than reply with a <literal>METHOD_RETURN</literal> as
2963         usual.  It does not matter which object path a ping is sent to.  The
2964         reference implementation handles this method automatically.
2965       </para>
2966       <para>
2967         On receipt of the <literal>METHOD_CALL</literal> message
2968         <literal>org.freedesktop.DBus.Peer.GetMachineId</literal>, an application should
2969         reply with a <literal>METHOD_RETURN</literal> containing a hex-encoded
2970         UUID representing the identity of the machine the process is running on.
2971         This UUID must be the same for all processes on a single system at least
2972         until that system next reboots. It should be the same across reboots
2973         if possible, but this is not always possible to implement and is not
2974         guaranteed.
2975         It does not matter which object path a GetMachineId is sent to.  The
2976         reference implementation handles this method automatically.
2977       </para>
2978       <para>
2979         The UUID is intended to be per-instance-of-the-operating-system, so may represent
2980         a virtual machine running on a hypervisor, rather than a physical machine.
2981         Basically if two processes see the same UUID, they should also see the same
2982         shared memory, UNIX domain sockets, process IDs, and other features that require
2983         a running OS kernel in common between the processes.
2984       </para>
2985       <para>
2986         The UUID is often used where other programs might use a hostname. Hostnames
2987         can change without rebooting, however, or just be "localhost" - so the UUID
2988         is more robust.
2989       </para>
2990       <para>
2991         <xref linkend="uuids"/> explains the format of the UUID.
2992       </para>
2993     </sect2>
2994
2995     <sect2 id="standard-interfaces-introspectable">
2996       <title><literal>org.freedesktop.DBus.Introspectable</literal></title>
2997       <para>
2998         This interface has one method:
2999         <programlisting>
3000           org.freedesktop.DBus.Introspectable.Introspect (out STRING xml_data)
3001         </programlisting>
3002       </para>
3003       <para>
3004         Objects instances may implement
3005         <literal>Introspect</literal> which returns an XML description of
3006         the object, including its interfaces (with signals and methods), objects
3007         below it in the object path tree, and its properties.
3008       </para>
3009       <para>
3010         <xref linkend="introspection-format"/> describes the format of this XML string.
3011       </para>
3012     </sect2>
3013     <sect2 id="standard-interfaces-properties">
3014       <title><literal>org.freedesktop.DBus.Properties</literal></title>
3015       <para>
3016         Many native APIs will have a concept of object <firstterm>properties</firstterm>
3017         or <firstterm>attributes</firstterm>. These can be exposed via the
3018         <literal>org.freedesktop.DBus.Properties</literal> interface.
3019       </para>
3020       <para>
3021         <programlisting>
3022               org.freedesktop.DBus.Properties.Get (in STRING interface_name,
3023                                                    in STRING property_name,
3024                                                    out VARIANT value);
3025               org.freedesktop.DBus.Properties.Set (in STRING interface_name,
3026                                                    in STRING property_name,
3027                                                    in VARIANT value);
3028               org.freedesktop.DBus.Properties.GetAll (in STRING interface_name,
3029                                                       out DICT&lt;STRING,VARIANT&gt; props);
3030         </programlisting>
3031       </para>
3032       <para>
3033         The available properties and whether they are writable can be determined
3034         by calling <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>,
3035         see <xref linkend="standard-interfaces-introspectable"/>.
3036       </para>
3037       <para>
3038         An empty string may be provided for the interface name; in this case,
3039         if there are multiple properties on an object with the same name,
3040         the results are undefined (picking one by according to an arbitrary
3041         deterministic rule, or returning an error, are the reasonable
3042         possibilities).
3043       </para>
3044       <para>
3045         If one or more properties change on an object, the
3046         <literal>org.freedesktop.DBus.Properties.PropertiesChanged</literal>
3047         signal may be emitted (this signal was added in 0.14):
3048       </para>
3049       <para>
3050         <programlisting>
3051               org.freedesktop.DBus.Properties.PropertiesChanged (STRING interface_name,
3052                                                                  DICT&lt;STRING,VARIANT&gt; changed_properties,
3053                                                                  ARRAY&lt;STRING&gt; invalidated_properties);
3054         </programlisting>
3055       </para>
3056       <para>
3057         where <literal>changed_properties</literal> is a dictionary
3058         containing the changed properties with the new values and
3059         <literal>invalidated_properties</literal> is an array of
3060         properties that changed but the value is not conveyed.
3061       </para>
3062       <para>
3063         Whether the <literal>PropertiesChanged</literal> signal is
3064         supported can be determined by calling
3065         <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>. Note
3066         that the signal may be supported for an object but it may
3067         differ how whether and how it is used on a per-property basis
3068         (for e.g. performance or security reasons). Each property (or
3069         the parent interface) must be annotated with the
3070         <literal>org.freedesktop.DBus.Property.EmitsChangedSignal</literal>
3071         annotation to convey this (usually the default value
3072         <literal>true</literal> is sufficient meaning that the
3073         annotation does not need to be used). See <xref
3074         linkend="introspection-format"/> for details on this
3075         annotation.
3076       </para>
3077     </sect2>
3078
3079     <sect2 id="standard-interfaces-objectmanager">
3080       <title><literal>org.freedesktop.DBus.ObjectManager</literal></title>
3081       <para>
3082         An API can optionally make use of this interface for one or
3083         more sub-trees of objects. The root of each sub-tree implements
3084         this interface so other applications can get all objects,
3085         interfaces and properties in a single method call.  It is
3086         appropriate to use this interface if users of the tree of
3087         objects are expected to be interested in all interfaces of all
3088         objects in the tree; a more granular API should be used if
3089         users of the objects are expected to be interested in a small
3090         subset of the objects, a small subset of their interfaces, or
3091         both.
3092       </para>
3093       <para>
3094         The method that applications can use to get all objects and
3095         properties is <literal>GetManagedObjects</literal>:
3096       </para>
3097       <para>
3098         <programlisting>
3099           org.freedesktop.DBus.ObjectManager.GetManagedObjects (out DICT&lt;OBJPATH,DICT&lt;STRING,DICT&lt;STRING,VARIANT&gt;&gt;&gt; objpath_interfaces_and_properties);
3100         </programlisting>
3101       </para>
3102       <para>
3103         The return value of this method is a dict whose keys are
3104         object paths. All returned object paths are children of the
3105         object path implementing this interface, i.e. their object
3106         paths start with the ObjectManager's object path plus '/'.
3107       </para>
3108       <para>
3109         Each value is a dict whose keys are interfaces names.  Each
3110         value in this inner dict is the same dict that would be
3111         returned by the <link
3112         linkend="standard-interfaces-properties">org.freedesktop.DBus.Properties.GetAll()</link>
3113         method for that combination of object path and interface. If
3114         an interface has no properties, the empty dict is returned.
3115       </para>
3116       <para>
3117         Changes are emitted using the following two signals:
3118       </para>
3119       <para>
3120         <programlisting>
3121           org.freedesktop.DBus.ObjectManager.InterfacesAdded (OBJPATH object_path,
3122                                                               DICT&lt;STRING,DICT&lt;STRING,VARIANT&gt;&gt; interfaces_and_properties);
3123           org.freedesktop.DBus.ObjectManager.InterfacesRemoved (OBJPATH object_path,
3124                                                                 ARRAY&lt;STRING&gt; interfaces);
3125         </programlisting>
3126       </para>
3127       <para>
3128         The <literal>InterfacesAdded</literal> signal is emitted when
3129         either a new object is added or when an existing object gains
3130         one or more interfaces. The
3131         <literal>InterfacesRemoved</literal> signal is emitted
3132         whenever an object is removed or it loses one or more
3133         interfaces. The second parameter of the
3134         <literal>InterfacesAdded</literal> signal contains a dict with
3135         the interfaces and properties (if any) that have been added to
3136         the given object path. Similarly, the second parameter of the
3137         <literal>InterfacesRemoved</literal> signal contains an array
3138         of the interfaces that were removed. Note that changes on
3139         properties on existing interfaces are not reported using this
3140         interface - an application should also monitor the existing <link
3141         linkend="standard-interfaces-properties">PropertiesChanged</link>
3142         signal on each object.
3143       </para>
3144       <para>
3145         Applications SHOULD NOT export objects that are children of an
3146         object (directly or otherwise) implementing this interface but
3147         which are not returned in the reply from the
3148         <literal>GetManagedObjects()</literal> method of this
3149         interface on the given object.
3150       </para>
3151       <para>
3152         The intent of the <literal>ObjectManager</literal> interface
3153         is to make it easy to write a robust client
3154         implementation. The trivial client implementation only needs
3155         to make two method calls:
3156       </para>
3157       <para>
3158         <programlisting>
3159           org.freedesktop.DBus.AddMatch (bus_proxy,
3160                                          "type='signal',name='org.example.App',path_namespace='/org/example/App'");
3161           objects = org.freedesktop.DBus.ObjectManager.GetManagedObjects (app_proxy);
3162         </programlisting>
3163       </para>
3164       <para>
3165         on the message bus and the remote application's
3166         <literal>ObjectManager</literal>, respectively. Whenever a new
3167         remote object is created (or an existing object gains a new
3168         interface), the <literal>InterfacesAdded</literal> signal is
3169         emitted, and since this signal contains all properties for the
3170         interfaces, no calls to the
3171         <literal>org.freedesktop.Properties</literal> interface on the
3172         remote object are needed. Additionally, since the initial
3173         <literal>AddMatch()</literal> rule already includes signal
3174         messages from the newly created child object, no new
3175         <literal>AddMatch()</literal> call is needed.
3176       </para>
3177
3178       <para>
3179         <emphasis>
3180           The <literal>org.freedesktop.DBus.ObjectManager</literal>
3181           interface was added in version 0.17 of the D-Bus
3182           specification.
3183         </emphasis>
3184       </para>
3185     </sect2>
3186   </sect1>
3187
3188   <sect1 id="introspection-format">
3189     <title>Introspection Data Format</title>
3190     <para>
3191       As described in <xref linkend="standard-interfaces-introspectable"/>,
3192       objects may be introspected at runtime, returning an XML string
3193       that describes the object. The same XML format may be used in
3194       other contexts as well, for example as an "IDL" for generating
3195       static language bindings.
3196     </para>
3197     <para>
3198       Here is an example of introspection data:
3199       <programlisting>
3200         &lt;!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
3201          "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"&gt;
3202         &lt;node name="/org/freedesktop/sample_object"&gt;
3203           &lt;interface name="org.freedesktop.SampleInterface"&gt;
3204             &lt;method name="Frobate"&gt;
3205               &lt;arg name="foo" type="i" direction="in"/&gt;
3206               &lt;arg name="bar" type="s" direction="out"/&gt;
3207               &lt;arg name="baz" type="a{us}" direction="out"/&gt;
3208               &lt;annotation name="org.freedesktop.DBus.Deprecated" value="true"/&gt;
3209             &lt;/method&gt;
3210             &lt;method name="Bazify"&gt;
3211               &lt;arg name="bar" type="(iiu)" direction="in"/&gt;
3212               &lt;arg name="bar" type="v" direction="out"/&gt;
3213             &lt;/method&gt;
3214             &lt;method name="Mogrify"&gt;
3215               &lt;arg name="bar" type="(iiav)" direction="in"/&gt;
3216             &lt;/method&gt;
3217             &lt;signal name="Changed"&gt;
3218               &lt;arg name="new_value" type="b"/&gt;
3219             &lt;/signal&gt;
3220             &lt;property name="Bar" type="y" access="readwrite"/&gt;
3221           &lt;/interface&gt;
3222           &lt;node name="child_of_sample_object"/&gt;
3223           &lt;node name="another_child_of_sample_object"/&gt;
3224        &lt;/node&gt;
3225       </programlisting>
3226     </para>
3227     <para>
3228       A more formal DTD and spec needs writing, but here are some quick notes.
3229       <itemizedlist>
3230         <listitem>
3231           <para>
3232             Only the root &lt;node&gt; element can omit the node name, as it's
3233             known to be the object that was introspected.  If the root
3234             &lt;node&gt; does have a name attribute, it must be an absolute
3235             object path. If child &lt;node&gt; have object paths, they must be
3236             relative.
3237           </para>
3238         </listitem>
3239         <listitem>
3240           <para>
3241             If a child &lt;node&gt; has any sub-elements, then they
3242             must represent a complete introspection of the child.
3243             If a child &lt;node&gt; is empty, then it may or may
3244             not have sub-elements; the child must be introspected
3245             in order to find out. The intent is that if an object
3246             knows that its children are "fast" to introspect
3247             it can go ahead and return their information, but
3248             otherwise it can omit it.
3249           </para>
3250         </listitem>
3251         <listitem>
3252           <para>
3253             The direction element on &lt;arg&gt; may be omitted,
3254             in which case it defaults to "in" for method calls
3255             and "out" for signals. Signals only allow "out"
3256             so while direction may be specified, it's pointless.
3257           </para>
3258         </listitem>
3259         <listitem>
3260           <para>
3261             The possible directions are "in" and "out",
3262             unlike CORBA there is no "inout"
3263           </para>
3264         </listitem>
3265         <listitem>
3266           <para>
3267             The possible property access flags are
3268             "readwrite", "read", and "write"
3269           </para>
3270         </listitem>
3271         <listitem>
3272           <para>
3273             Multiple interfaces can of course be listed for
3274             one &lt;node&gt;.
3275           </para>
3276         </listitem>
3277         <listitem>
3278           <para>
3279             The "name" attribute on arguments is optional.
3280           </para>
3281         </listitem>
3282       </itemizedlist>
3283     </para>
3284     <para>
3285         Method, interface, property, and signal elements may have
3286         "annotations", which are generic key/value pairs of metadata.
3287         They are similar conceptually to Java's annotations and C# attributes.
3288         Well-known annotations:
3289      </para>
3290      <informaltable>
3291        <tgroup cols="3">
3292          <thead>
3293            <row>
3294              <entry>Name</entry>
3295              <entry>Values (separated by ,)</entry>
3296              <entry>Description</entry>
3297            </row>
3298          </thead>
3299          <tbody>
3300            <row>
3301              <entry>org.freedesktop.DBus.Deprecated</entry>
3302              <entry>true,false</entry>
3303              <entry>Whether or not the entity is deprecated; defaults to false</entry>
3304            </row>
3305            <row>
3306              <entry>org.freedesktop.DBus.GLib.CSymbol</entry>
3307              <entry>(string)</entry>
3308              <entry>The C symbol; may be used for methods and interfaces</entry>
3309            </row>
3310            <row>
3311              <entry>org.freedesktop.DBus.Method.NoReply</entry>
3312              <entry>true,false</entry>
3313              <entry>If set, don't expect a reply to the method call; defaults to false.</entry>
3314            </row>
3315            <row>
3316              <entry>org.freedesktop.DBus.Property.EmitsChangedSignal</entry>
3317              <entry>true,invalidates,false</entry>
3318              <entry>
3319                <para>
3320                  If set to <literal>false</literal>, the
3321                  <literal>org.freedesktop.DBus.Properties.PropertiesChanged</literal>
3322                  signal, see <xref
3323                  linkend="standard-interfaces-properties"/> is not
3324                  guaranteed to be emitted if the property changes.
3325                </para>
3326                <para>
3327                  If set to <literal>invalidates</literal> the signal
3328                  is emitted but the value is not included in the
3329                  signal.
3330                </para>
3331                <para>
3332                  If set to <literal>true</literal> the signal is
3333                  emitted with the value included.
3334                </para>
3335                <para>
3336                  The value for the annotation defaults to
3337                  <literal>true</literal> if the enclosing interface
3338                  element does not specify the annotation. Otherwise it
3339                  defaults to the value specified in the enclosing
3340                  interface element.
3341                </para>
3342              </entry>
3343            </row>
3344          </tbody>
3345        </tgroup>
3346      </informaltable>
3347   </sect1>
3348   <sect1 id="message-bus">
3349     <title>Message Bus Specification</title>
3350     <sect2 id="message-bus-overview">
3351       <title>Message Bus Overview</title>
3352       <para>
3353         The message bus accepts connections from one or more applications.
3354         Once connected, applications can exchange messages with other
3355         applications that are also connected to the bus.
3356       </para>
3357       <para>
3358         In order to route messages among connections, the message bus keeps a
3359         mapping from names to connections. Each connection has one
3360         unique-for-the-lifetime-of-the-bus name automatically assigned.
3361         Applications may request additional names for a connection. Additional
3362         names are usually "well-known names" such as
3363         "org.freedesktop.TextEditor". When a name is bound to a connection,
3364         that connection is said to <firstterm>own</firstterm> the name.
3365       </para>
3366       <para>
3367         The bus itself owns a special name, <literal>org.freedesktop.DBus</literal>.
3368         This name routes messages to the bus, allowing applications to make
3369         administrative requests. For example, applications can ask the bus
3370         to assign a name to a connection.
3371       </para>
3372       <para>
3373         Each name may have <firstterm>queued owners</firstterm>.  When an
3374         application requests a name for a connection and the name is already in
3375         use, the bus will optionally add the connection to a queue waiting for
3376         the name. If the current owner of the name disconnects or releases
3377         the name, the next connection in the queue will become the new owner.
3378       </para>
3379
3380       <para>
3381         This feature causes the right thing to happen if you start two text
3382         editors for example; the first one may request "org.freedesktop.TextEditor",
3383         and the second will be queued as a possible owner of that name. When
3384         the first exits, the second will take over.
3385       </para>
3386
3387       <para>
3388         Messages may have a <literal>DESTINATION</literal> field (see <xref
3389           linkend="message-protocol-header-fields"/>), resulting in a
3390         <firstterm>unicast message</firstterm>.  If the
3391         <literal>DESTINATION</literal> field is present, it specifies a message
3392         recipient by name. Method calls and replies normally specify this field.
3393         The message bus must send messages (of any type) with the
3394         <literal>DESTINATION</literal> field set to the specified recipient,
3395         regardless of whether the recipient has set up a match rule matching
3396         the message.
3397       </para>
3398
3399       <para>
3400         When the message bus receives a signal, if the
3401         <literal>DESTINATION</literal> field is absent, it is considered to
3402         be a <firstterm>broadcast signal</firstterm>, and is sent to all
3403         applications with <firstterm>message matching rules</firstterm> that
3404         match the message. Most signal messages are broadcasts.
3405       </para>
3406
3407       <para>
3408         Unicast signal messages (those with a <literal>DESTINATION</literal>
3409         field) are not commonly used, but they are treated like any unicast
3410         message: they are delivered to the specified receipient,
3411         regardless of its match rules.  One use for unicast signals is to
3412         avoid a race condition in which a signal is emitted before the intended
3413         recipient can call <xref linkend="bus-messages-add-match"/> to
3414         receive that signal: if the signal is sent directly to that recipient
3415         using a unicast message, it does not need to add a match rule at all,
3416         and there is no race condition.  Another use for unicast signals,
3417         on message buses whose security policy prevents eavesdropping, is to
3418         send sensitive information which should only be visible to one
3419         recipient.
3420       </para>
3421
3422       <para>
3423         When the message bus receives a method call, if the
3424         <literal>DESTINATION</literal> field is absent, the call is taken to be
3425         a standard one-to-one message and interpreted by the message bus
3426         itself. For example, sending an
3427         <literal>org.freedesktop.DBus.Peer.Ping</literal> message with no
3428         <literal>DESTINATION</literal> will cause the message bus itself to
3429         reply to the ping immediately; the message bus will not make this
3430         message visible to other applications.
3431       </para>
3432
3433       <para>
3434         Continuing the <literal>org.freedesktop.DBus.Peer.Ping</literal> example, if
3435         the ping message were sent with a <literal>DESTINATION</literal> name of
3436         <literal>com.yoyodyne.Screensaver</literal>, then the ping would be
3437         forwarded, and the Yoyodyne Corporation screensaver application would be
3438         expected to reply to the ping.
3439       </para>
3440     </sect2>
3441
3442     <sect2 id="message-bus-names">
3443       <title>Message Bus Names</title>
3444       <para>
3445         Each connection has at least one name, assigned at connection time and
3446         returned in response to the
3447         <literal>org.freedesktop.DBus.Hello</literal> method call.  This
3448         automatically-assigned name is called the connection's <firstterm>unique
3449         name</firstterm>.  Unique names are never reused for two different
3450         connections to the same bus.
3451       </para>
3452       <para>
3453         Ownership of a unique name is a prerequisite for interaction with
3454         the message bus. It logically follows that the unique name is always
3455         the first name that an application comes to own, and the last
3456         one that it loses ownership of.
3457       </para>
3458       <para>
3459         Unique connection names must begin with the character ':' (ASCII colon
3460         character); bus names that are not unique names must not begin
3461         with this character. (The bus must reject any attempt by an application
3462         to manually request a name beginning with ':'.) This restriction
3463         categorically prevents "spoofing"; messages sent to a unique name
3464         will always go to the expected connection.
3465       </para>
3466       <para>
3467         When a connection is closed, all the names that it owns are deleted (or
3468         transferred to the next connection in the queue if any).
3469       </para>
3470       <para>
3471         A connection can request additional names to be associated with it using
3472         the <literal>org.freedesktop.DBus.RequestName</literal> message. <xref
3473         linkend="message-protocol-names-bus"/> describes the format of a valid
3474         name. These names can be released again using the
3475         <literal>org.freedesktop.DBus.ReleaseName</literal> message.
3476       </para>
3477
3478       <sect3 id="bus-messages-request-name">
3479         <title><literal>org.freedesktop.DBus.RequestName</literal></title>
3480         <para>
3481           As a method:
3482           <programlisting>
3483             UINT32 RequestName (in STRING name, in UINT32 flags)
3484           </programlisting>
3485           Message arguments:
3486           <informaltable>
3487             <tgroup cols="3">
3488               <thead>
3489                 <row>
3490                   <entry>Argument</entry>
3491                   <entry>Type</entry>
3492                   <entry>Description</entry>
3493                 </row>
3494               </thead>
3495               <tbody>
3496                 <row>
3497                   <entry>0</entry>
3498                   <entry>STRING</entry>
3499                   <entry>Name to request</entry>
3500                 </row>
3501                 <row>
3502                   <entry>1</entry>
3503                   <entry>UINT32</entry>
3504                   <entry>Flags</entry>
3505                 </row>
3506               </tbody>
3507             </tgroup>
3508           </informaltable>
3509           Reply arguments:
3510           <informaltable>
3511             <tgroup cols="3">
3512               <thead>
3513                 <row>
3514                   <entry>Argument</entry>
3515                   <entry>Type</entry>
3516                   <entry>Description</entry>
3517                 </row>
3518               </thead>
3519               <tbody>
3520                 <row>
3521                   <entry>0</entry>
3522                   <entry>UINT32</entry>
3523                   <entry>Return value</entry>
3524                 </row>
3525               </tbody>
3526             </tgroup>
3527           </informaltable>
3528         </para>
3529         <para>
3530           This method call should be sent to
3531           <literal>org.freedesktop.DBus</literal> and asks the message bus to
3532           assign the given name to the method caller. Each name maintains a
3533           queue of possible owners, where the head of the queue is the primary
3534           or current owner of the name. Each potential owner in the queue
3535           maintains the DBUS_NAME_FLAG_ALLOW_REPLACEMENT and
3536           DBUS_NAME_FLAG_DO_NOT_QUEUE settings from its latest RequestName
3537           call.  When RequestName is invoked the following occurs:
3538           <itemizedlist>
3539             <listitem>
3540               <para>
3541                 If the method caller is currently the primary owner of the name,
3542                 the DBUS_NAME_FLAG_ALLOW_REPLACEMENT and DBUS_NAME_FLAG_DO_NOT_QUEUE
3543                 values are updated with the values from the new RequestName call,
3544                 and nothing further happens.
3545               </para>
3546             </listitem>
3547
3548             <listitem>
3549               <para>
3550                 If the current primary owner (head of the queue) has
3551                 DBUS_NAME_FLAG_ALLOW_REPLACEMENT set, and the RequestName
3552                 invocation has the DBUS_NAME_FLAG_REPLACE_EXISTING flag, then
3553                 the caller of RequestName replaces the current primary owner at
3554                 the head of the queue and the current primary owner moves to the
3555                 second position in the queue. If the caller of RequestName was
3556                 in the queue previously its flags are updated with the values from
3557                 the new RequestName in addition to moving it to the head of the queue.
3558               </para>
3559             </listitem>
3560
3561             <listitem>
3562               <para>
3563                 If replacement is not possible, and the method caller is
3564                 currently in the queue but not the primary owner, its flags are
3565                 updated with the values from the new RequestName call.
3566               </para>
3567             </listitem>
3568
3569             <listitem>
3570               <para>
3571                 If replacement is not possible, and the method caller is
3572                 currently not in the queue, the method caller is appended to the
3573                 queue.
3574               </para>
3575             </listitem>
3576
3577             <listitem>
3578               <para>
3579                 If any connection in the queue has DBUS_NAME_FLAG_DO_NOT_QUEUE
3580                 set and is not the primary owner, it is removed from the
3581                 queue. This can apply to the previous primary owner (if it
3582                 was replaced) or the method caller (if it updated the
3583                 DBUS_NAME_FLAG_DO_NOT_QUEUE flag while still stuck in the
3584                 queue, or if it was just added to the queue with that flag set).
3585               </para>
3586             </listitem>
3587           </itemizedlist>
3588         </para>
3589         <para>
3590           Note that DBUS_NAME_FLAG_REPLACE_EXISTING results in "jumping the
3591           queue," even if another application already in the queue had specified
3592           DBUS_NAME_FLAG_REPLACE_EXISTING.  This comes up if a primary owner
3593           that does not allow replacement goes away, and the next primary owner
3594           does allow replacement. In this case, queued items that specified
3595           DBUS_NAME_FLAG_REPLACE_EXISTING <emphasis>do not</emphasis>
3596           automatically replace the new primary owner. In other words,
3597           DBUS_NAME_FLAG_REPLACE_EXISTING is not saved, it is only used at the
3598           time RequestName is called. This is deliberate to avoid an infinite loop
3599           anytime two applications are both DBUS_NAME_FLAG_ALLOW_REPLACEMENT
3600           and DBUS_NAME_FLAG_REPLACE_EXISTING.
3601         </para>
3602         <para>
3603           The flags argument contains any of the following values logically ORed
3604           together:
3605
3606           <informaltable>
3607             <tgroup cols="3">
3608               <thead>
3609                 <row>
3610                   <entry>Conventional Name</entry>
3611                   <entry>Value</entry>
3612                   <entry>Description</entry>
3613                 </row>
3614               </thead>
3615               <tbody>
3616                 <row>
3617                   <entry>DBUS_NAME_FLAG_ALLOW_REPLACEMENT</entry>
3618                   <entry>0x1</entry>
3619                   <entry>
3620
3621                     If an application A specifies this flag and succeeds in
3622                     becoming the owner of the name, and another application B
3623                     later calls RequestName with the
3624                     DBUS_NAME_FLAG_REPLACE_EXISTING flag, then application A
3625                     will lose ownership and receive a
3626                     <literal>org.freedesktop.DBus.NameLost</literal> signal, and
3627                     application B will become the new owner. If DBUS_NAME_FLAG_ALLOW_REPLACEMENT
3628                     is not specified by application A, or DBUS_NAME_FLAG_REPLACE_EXISTING
3629                     is not specified by application B, then application B will not replace
3630                     application A as the owner.
3631
3632                   </entry>
3633                 </row>
3634                 <row>
3635                   <entry>DBUS_NAME_FLAG_REPLACE_EXISTING</entry>
3636                   <entry>0x2</entry>
3637                   <entry>
3638
3639                     Try to replace the current owner if there is one. If this
3640                     flag is not set the application will only become the owner of
3641                     the name if there is no current owner. If this flag is set,
3642                     the application will replace the current owner if
3643                     the current owner specified DBUS_NAME_FLAG_ALLOW_REPLACEMENT.
3644
3645                   </entry>
3646                 </row>
3647                 <row>
3648                   <entry>DBUS_NAME_FLAG_DO_NOT_QUEUE</entry>
3649                   <entry>0x4</entry>
3650                   <entry>
3651
3652                     Without this flag, if an application requests a name that is
3653                     already owned, the application will be placed in a queue to
3654                     own the name when the current owner gives it up. If this
3655                     flag is given, the application will not be placed in the
3656                     queue, the request for the name will simply fail.  This flag
3657                     also affects behavior when an application is replaced as
3658                     name owner; by default the application moves back into the
3659                     waiting queue, unless this flag was provided when the application
3660                     became the name owner.
3661
3662                   </entry>
3663                 </row>
3664               </tbody>
3665             </tgroup>
3666           </informaltable>
3667
3668           The return code can be one of the following values:
3669
3670           <informaltable>
3671             <tgroup cols="3">
3672               <thead>
3673                 <row>
3674                   <entry>Conventional Name</entry>
3675                   <entry>Value</entry>
3676                   <entry>Description</entry>
3677                 </row>
3678               </thead>
3679               <tbody>
3680                 <row>
3681                   <entry>DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER</entry>
3682                   <entry>1</entry> <entry>The caller is now the primary owner of
3683                   the name, replacing any previous owner. Either the name had no
3684                   owner before, or the caller specified
3685                   DBUS_NAME_FLAG_REPLACE_EXISTING and the current owner specified
3686                   DBUS_NAME_FLAG_ALLOW_REPLACEMENT.</entry>
3687                 </row>
3688                 <row>
3689                   <entry>DBUS_REQUEST_NAME_REPLY_IN_QUEUE</entry>
3690                   <entry>2</entry>
3691
3692                   <entry>The name already had an owner,
3693                     DBUS_NAME_FLAG_DO_NOT_QUEUE was not specified, and either
3694                     the current owner did not specify
3695                     DBUS_NAME_FLAG_ALLOW_REPLACEMENT or the requesting
3696                     application did not specify DBUS_NAME_FLAG_REPLACE_EXISTING.
3697                     </entry>
3698                 </row>
3699                 <row>
3700                   <entry>DBUS_REQUEST_NAME_REPLY_EXISTS</entry> <entry>3</entry>
3701                   <entry>The name already has an owner,
3702                   DBUS_NAME_FLAG_DO_NOT_QUEUE was specified, and either
3703                   DBUS_NAME_FLAG_ALLOW_REPLACEMENT was not specified by the
3704                   current owner, or DBUS_NAME_FLAG_REPLACE_EXISTING was not
3705                   specified by the requesting application.</entry>
3706                 </row>
3707                 <row>
3708                   <entry>DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER</entry>
3709                   <entry>4</entry>
3710                   <entry>The application trying to request ownership of a name is already the owner of it.</entry>
3711                 </row>
3712               </tbody>
3713             </tgroup>
3714           </informaltable>
3715         </para>
3716        </sect3>
3717
3718        <sect3 id="bus-messages-release-name">
3719         <title><literal>org.freedesktop.DBus.ReleaseName</literal></title>
3720         <para>
3721           As a method:
3722           <programlisting>
3723             UINT32 ReleaseName (in STRING name)
3724           </programlisting>
3725           Message arguments:
3726           <informaltable>
3727             <tgroup cols="3">
3728               <thead>
3729                 <row>
3730                   <entry>Argument</entry>
3731                   <entry>Type</entry>
3732                   <entry>Description</entry>
3733                 </row>
3734               </thead>
3735               <tbody>
3736                 <row>
3737                   <entry>0</entry>
3738                   <entry>STRING</entry>
3739                   <entry>Name to release</entry>
3740                 </row>
3741               </tbody>
3742             </tgroup>
3743           </informaltable>
3744           Reply arguments:
3745           <informaltable>
3746             <tgroup cols="3">
3747               <thead>
3748                 <row>
3749                   <entry>Argument</entry>
3750                   <entry>Type</entry>
3751                   <entry>Description</entry>
3752                 </row>
3753               </thead>
3754               <tbody>
3755                 <row>
3756                   <entry>0</entry>
3757                   <entry>UINT32</entry>
3758                   <entry>Return value</entry>
3759                 </row>
3760               </tbody>
3761             </tgroup>
3762           </informaltable>
3763         </para>
3764         <para>
3765           This method call should be sent to
3766           <literal>org.freedesktop.DBus</literal> and asks the message bus to
3767           release the method caller's claim to the given name. If the caller is
3768           the primary owner, a new primary owner will be selected from the
3769           queue if any other owners are waiting. If the caller is waiting in
3770           the queue for the name, the caller will removed from the queue and
3771           will not be made an owner of the name if it later becomes available.
3772           If there are no other owners in the queue for the name, it will be
3773           removed from the bus entirely.
3774
3775           The return code can be one of the following values:
3776
3777           <informaltable>
3778             <tgroup cols="3">
3779               <thead>
3780                 <row>
3781                   <entry>Conventional Name</entry>
3782                   <entry>Value</entry>
3783                   <entry>Description</entry>
3784                 </row>
3785               </thead>
3786               <tbody>
3787                 <row>
3788                   <entry>DBUS_RELEASE_NAME_REPLY_RELEASED</entry>
3789                   <entry>1</entry> <entry>The caller has released his claim on
3790                   the given name. Either the caller was the primary owner of
3791                   the name, and the name is now unused or taken by somebody
3792                   waiting in the queue for the name, or the caller was waiting
3793                   in the queue for the name and has now been removed from the
3794                   queue.</entry>
3795                 </row>
3796                 <row>
3797                   <entry>DBUS_RELEASE_NAME_REPLY_NON_EXISTENT</entry>
3798                   <entry>2</entry>
3799                   <entry>The given name does not exist on this bus.</entry>
3800                 </row>
3801                 <row>
3802                   <entry>DBUS_RELEASE_NAME_REPLY_NOT_OWNER</entry>
3803                   <entry>3</entry>
3804                   <entry>The caller was not the primary owner of this name,
3805                   and was also not waiting in the queue to own this name.</entry>
3806                 </row>
3807               </tbody>
3808             </tgroup>
3809           </informaltable>
3810         </para>
3811        </sect3>
3812
3813        <sect3 id="bus-messages-list-queued-owners">
3814         <title><literal>org.freedesktop.DBus.ListQueuedOwners</literal></title>
3815         <para>
3816           As a method:
3817           <programlisting>
3818             ARRAY of STRING ListQueuedOwners (in STRING name)
3819           </programlisting>
3820           Message arguments:
3821           <informaltable>
3822             <tgroup cols="3">
3823               <thead>
3824                 <row>
3825                   <entry>Argument</entry>
3826                   <entry>Type</entry>
3827                   <entry>Description</entry>
3828                 </row>
3829               </thead>
3830               <tbody>
3831                 <row>
3832                   <entry>0</entry>
3833                   <entry>STRING</entry>
3834                   <entry>The well-known bus name to query, such as
3835                     <literal>com.example.cappuccino</literal></entry>
3836                 </row>
3837               </tbody>
3838             </tgroup>
3839           </informaltable>
3840           Reply arguments:
3841           <informaltable>
3842             <tgroup cols="3">
3843               <thead>
3844                 <row>
3845                   <entry>Argument</entry>
3846                   <entry>Type</entry>
3847                   <entry>Description</entry>
3848                 </row>
3849               </thead>
3850               <tbody>
3851                 <row>
3852                   <entry>0</entry>
3853                   <entry>ARRAY of STRING</entry>
3854                   <entry>The unique bus names of connections currently queued
3855                     for the name</entry>
3856                 </row>
3857               </tbody>
3858             </tgroup>
3859           </informaltable>
3860         </para>
3861         <para>
3862           This method call should be sent to
3863           <literal>org.freedesktop.DBus</literal> and lists the connections
3864           currently queued for a bus name (see
3865           <xref linkend="term-queued-owner"/>).
3866         </para>
3867        </sect3>
3868     </sect2>
3869
3870     <sect2 id="message-bus-routing">
3871       <title>Message Bus Message Routing</title>
3872       <para>
3873         FIXME
3874       </para>
3875
3876       <sect3 id="message-bus-routing-eavesdropping">
3877         <title>Eavesdropping</title>
3878         <para>
3879           Receiving a unicast message whose <literal>DESTINATION</literal>
3880           indicates a different recipient is called
3881           <firstterm>eavesdropping</firstterm>. On a message bus which acts as
3882           a security boundary (like the standard system bus), the security
3883           policy should usually prevent eavesdropping, since unicast messages
3884           are normally kept private and may contain security-sensitive
3885           information.
3886         </para>
3887
3888         <para>
3889           Eavesdropping is mainly useful for debugging tools, such as
3890           the <literal>dbus-monitor</literal> tool in the reference
3891           implementation of D-Bus. Tools which eavesdrop on the message bus
3892           should be careful to avoid sending a reply or error in response to
3893           messages intended for a different client.
3894         </para>
3895
3896         <para>
3897           Clients may attempt to eavesdrop by adding match rules
3898           (see <xref linkend="message-bus-routing-match-rules"/>) containing
3899           the <literal>eavesdrop='true'</literal> match. If the message bus'
3900           security policy does not allow eavesdropping, the match rule can
3901           still be added, but will not have any practical effect. For
3902           compatibility with older message bus implementations, if adding such
3903           a match rule results in an error reply, the client may fall back to
3904           adding the same rule with the <literal>eavesdrop</literal> match
3905           omitted.
3906         </para>
3907       </sect3>
3908
3909       <sect3 id="message-bus-routing-match-rules">
3910         <title>Match Rules</title>
3911         <para>
3912           An important part of the message bus routing protocol is match
3913           rules. Match rules describe the messages that should be sent to a
3914           client, based on the contents of the message.  Broadcast signals
3915           are only sent to clients which have a suitable match rule: this
3916           avoids waking up client processes to deal with signals that are
3917           not relevant to that client.
3918         </para>
3919         <para>
3920           Messages that list a client as their <literal>DESTINATION</literal>
3921           do not need to match the client's match rules, and are sent to that
3922           client regardless. As a result, match rules are mainly used to
3923           receive a subset of broadcast signals.
3924         </para>
3925         <para>
3926           Match rules can also be used for eavesdropping
3927           (see <xref linkend="message-bus-routing-eavesdropping"/>),
3928           if the security policy of the message bus allows it.
3929         </para>
3930         <para>
3931           Match rules are added using the AddMatch bus method
3932           (see <xref linkend="bus-messages-add-match"/>).  Rules are
3933           specified as a string of comma separated key/value pairs.
3934           Excluding a key from the rule indicates a wildcard match.
3935           For instance excluding the the member from a match rule but
3936           adding a sender would let all messages from that sender through.
3937           An example of a complete rule would be
3938           "type='signal',sender='org.freedesktop.DBus',interface='org.freedesktop.DBus',member='Foo',path='/bar/foo',destination=':452345.34',arg2='bar'"
3939         </para>
3940         <para>
3941           The following table describes the keys that can be used to create
3942           a match rule:
3943           The following table summarizes the D-Bus types.
3944           <informaltable>
3945             <tgroup cols="3">
3946               <thead>
3947                 <row>
3948                   <entry>Key</entry>
3949                   <entry>Possible Values</entry>
3950                   <entry>Description</entry>
3951                 </row>
3952               </thead>
3953               <tbody>
3954                 <row>
3955                   <entry><literal>type</literal></entry>
3956                   <entry>'signal', 'method_call', 'method_return', 'error'</entry>
3957                   <entry>Match on the message type.  An example of a type match is type='signal'</entry>
3958                 </row>
3959                 <row>
3960                   <entry><literal>sender</literal></entry>
3961                   <entry>A bus or unique name (see <xref linkend="term-bus-name"/>
3962                   and <xref linkend="term-unique-name"/> respectively)
3963                   </entry>
3964                   <entry>Match messages sent by a particular sender.  An example of a sender match
3965                   is sender='org.freedesktop.Hal'</entry>
3966                 </row>
3967                 <row>
3968                   <entry><literal>interface</literal></entry>
3969                   <entry>An interface name (see <xref linkend="message-protocol-names-interface"/>)</entry>
3970                   <entry>Match messages sent over or to a particular interface.  An example of an
3971                   interface match is interface='org.freedesktop.Hal.Manager'.
3972                   If a message omits the interface header, it must not match any rule
3973                   that specifies this key.</entry>
3974                 </row>
3975                 <row>
3976                   <entry><literal>member</literal></entry>
3977                   <entry>Any valid method or signal name</entry>
3978                   <entry>Matches messages which have the give method or signal name. An example of
3979                   a member match is member='NameOwnerChanged'</entry>
3980                 </row>
3981                 <row>
3982                   <entry><literal>path</literal></entry>
3983                   <entry>An object path (see <xref linkend="message-protocol-marshaling-object-path"/>)</entry>
3984                   <entry>Matches messages which are sent from or to the given object. An example of a
3985                   path match is path='/org/freedesktop/Hal/Manager'</entry>
3986                 </row>
3987                 <row>
3988                   <entry><literal>path_namespace</literal></entry>
3989                   <entry>An object path</entry>
3990                   <entry>
3991                     <para>
3992                       Matches messages which are sent from or to an
3993                       object for which the object path is either the
3994                       given value, or that value followed by one or
3995                       more path components.
3996                     </para>
3997
3998                     <para>
3999                       For example,
4000                       <literal>path_namespace='/com/example/foo'</literal>
4001                       would match signals sent by
4002                       <literal>/com/example/foo</literal>
4003                       or by
4004                       <literal>/com/example/foo/bar</literal>,
4005                       but not by
4006                       <literal>/com/example/foobar</literal>.
4007                     </para>
4008
4009                     <para>
4010                       Using both <literal>path</literal> and
4011                       <literal>path_namespace</literal> in the same match
4012                       rule is not allowed.
4013                     </para>
4014
4015                     <para>
4016                       <emphasis>
4017                         This match key was added in version 0.16 of the
4018                         D-Bus specification and implemented by the bus
4019                         daemon in dbus 1.5.0 and later.
4020                       </emphasis>
4021                     </para>
4022                 </entry>
4023                 </row>
4024                 <row>
4025                   <entry><literal>destination</literal></entry>
4026                   <entry>A unique name (see <xref linkend="term-unique-name"/>)</entry>
4027                   <entry>Matches messages which are being sent to the given unique name. An
4028                   example of a destination match is destination=':1.0'</entry>
4029                 </row>
4030                 <row>
4031                   <entry><literal>arg[0, 1, 2, 3, ...]</literal></entry>
4032                   <entry>Any string</entry>
4033                   <entry>Arg matches are special and are used for further restricting the
4034                   match based on the arguments in the body of a message. Only arguments of type
4035                   STRING can be matched in this way. An example of an argument match
4036                   would be arg3='Foo'. Only argument indexes from 0 to 63 should be
4037                   accepted.</entry>
4038                 </row>
4039                 <row>
4040                   <entry><literal>arg[0, 1, 2, 3, ...]path</literal></entry>
4041                   <entry>Any string</entry>
4042                   <entry>
4043                     <para>Argument path matches provide a specialised form of wildcard matching for
4044                       path-like namespaces. They can match arguments whose type is either STRING or
4045                       OBJECT_PATH. As with normal argument matches,
4046                       if the argument is exactly equal to the string given in the match
4047                       rule then the rule is satisfied. Additionally, there is also a
4048                       match when either the string given in the match rule or the
4049                       appropriate message argument ends with '/' and is a prefix of the
4050                       other. An example argument path match is arg0path='/aa/bb/'. This
4051                       would match messages with first arguments of '/', '/aa/',
4052                       '/aa/bb/', '/aa/bb/cc/' and '/aa/bb/cc'. It would not match
4053                       messages with first arguments of '/aa/b', '/aa' or even '/aa/bb'.</para>
4054
4055                     <para>This is intended for monitoring “directories” in file system-like
4056                       hierarchies, as used in the <citetitle>dconf</citetitle> configuration
4057                       system. An application interested in all nodes in a particular hierarchy would
4058                       monitor <literal>arg0path='/ca/example/foo/'</literal>. Then the service could
4059                       emit a signal with zeroth argument <literal>"/ca/example/foo/bar"</literal> to
4060                       represent a modification to the “bar” property, or a signal with zeroth
4061                       argument <literal>"/ca/example/"</literal> to represent atomic modification of
4062                       many properties within that directory, and the interested application would be
4063                       notified in both cases.</para>
4064                     <para>
4065                       <emphasis>
4066                         This match key was added in version 0.12 of the
4067                         D-Bus specification, implemented for STRING
4068                         arguments by the bus daemon in dbus 1.2.0 and later,
4069                         and implemented for OBJECT_PATH arguments in dbus 1.5.0
4070                         and later.
4071                       </emphasis>
4072                     </para>
4073                   </entry>
4074                 </row>
4075                 <row>
4076                   <entry><literal>arg0namespace</literal></entry>
4077                   <entry>Like a bus name, except that the string is not
4078                     required to contain a '.' (period)</entry>
4079                   <entry>
4080                     <para>Match messages whose first argument is of type STRING, and is a bus name
4081                       or interface name within the specified namespace. This is primarily intended
4082                       for watching name owner changes for a group of related bus names, rather than
4083                       for a single name or all name changes.</para>
4084
4085                     <para>Because every valid interface name is also a valid
4086                       bus name, this can also be used for messages whose
4087                       first argument is an interface name.</para>
4088
4089                     <para>For example, the match rule
4090                       <literal>member='NameOwnerChanged',arg0namespace='com.example.backend'</literal>
4091                       matches name owner changes for bus names such as
4092                       <literal>com.example.backend.foo</literal>,
4093                       <literal>com.example.backend.foo.bar</literal>, and
4094                       <literal>com.example.backend</literal> itself.</para>
4095
4096                     <para>See also <xref linkend='bus-messages-name-owner-changed'/>.</para>
4097                     <para>
4098                       <emphasis>
4099                         This match key was added in version 0.16 of the
4100                         D-Bus specification and implemented by the bus
4101                         daemon in dbus 1.5.0 and later.
4102                       </emphasis>
4103                     </para>
4104                   </entry>
4105                 </row>
4106                 <row>
4107                   <entry><literal>eavesdrop</literal></entry>
4108                   <entry><literal>'true'</literal>, <literal>'false'</literal></entry>
4109                   <entry>Since D-Bus 1.5.UNRELEASED, match rules do not
4110                     match messages which have a <literal>DESTINATION</literal>
4111                     field unless the match rule specifically
4112                     requests this
4113                     (see <xref linkend="message-bus-routing-eavesdropping"/>)
4114                     by specifying <literal>eavesdrop='true'</literal>
4115                     in the match rule.  <literal>eavesdrop='false'</literal>
4116                     restores the default behaviour. Messages are
4117                     delivered to their <literal>DESTINATION</literal>
4118                     regardless of match rules, so this match does not
4119                     affect normal delivery of unicast messages.
4120                     If the message bus has a security policy which forbids
4121                     eavesdropping, this match may still be used without error,
4122                     but will not have any practical effect.
4123                     In older versions of D-Bus, this match was not allowed
4124                     in match rules, and all match rules behaved as if
4125                     <literal>eavesdrop='true'</literal> had been used.
4126                   </entry>
4127                 </row>
4128               </tbody>
4129             </tgroup>
4130           </informaltable>
4131         </para>
4132       </sect3>
4133     </sect2>
4134     <sect2 id="message-bus-starting-services">
4135       <title>Message Bus Starting Services</title>
4136       <para>
4137         The message bus can start applications on behalf of other applications.
4138         In CORBA terms, this would be called <firstterm>activation</firstterm>.
4139         An application that can be started in this way is called a
4140         <firstterm>service</firstterm>.
4141       </para>
4142       <para>
4143         With D-Bus, starting a service is normally done by name. That is,
4144         applications ask the message bus to start some program that will own a
4145         well-known name, such as <literal>org.freedesktop.TextEditor</literal>.
4146         This implies a contract documented along with the name
4147         <literal>org.freedesktop.TextEditor</literal> for which objects
4148         the owner of that name will provide, and what interfaces those
4149         objects will have.
4150       </para>
4151       <para>
4152         To find an executable corresponding to a particular name, the bus daemon
4153         looks for <firstterm>service description files</firstterm>.  Service
4154         description files define a mapping from names to executables. Different
4155         kinds of message bus will look for these files in different places, see
4156         <xref linkend="message-bus-types"/>.
4157       </para>
4158       <para>
4159         Service description files have the ".service" file
4160         extension. The message bus will only load service description files
4161         ending with .service; all other files will be ignored.  The file format
4162         is similar to that of <ulink
4163         url="http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html">desktop
4164         entries</ulink>. All service description files must be in UTF-8
4165         encoding. To ensure that there will be no name collisions, service files
4166         must be namespaced using the same mechanism as messages and service
4167         names.
4168       </para>
4169
4170       <para>
4171         [FIXME the file format should be much better specified than "similar to
4172         .desktop entries" esp. since desktop entries are already
4173         badly-specified. ;-)]
4174         These sections from the specification apply to service files as well:
4175
4176         <itemizedlist>
4177           <listitem><para>General syntax</para></listitem>
4178           <listitem><para>Comment format</para></listitem>
4179         </itemizedlist>
4180
4181         <figure>
4182           <title>Example service description file</title>
4183           <programlisting>
4184             # Sample service description file
4185             [D-BUS Service]
4186             Names=org.freedesktop.ConfigurationDatabase;org.gnome.GConf;
4187             Exec=/usr/libexec/gconfd-2
4188           </programlisting>
4189         </figure>
4190       </para>
4191       <para>
4192         When an application asks to start a service by name, the bus daemon tries to
4193         find a service that will own that name. It then tries to spawn the
4194         executable associated with it. If this fails, it will report an
4195         error. [FIXME what happens if two .service files offer the same service;
4196         what kind of error is reported, should we have a way for the client to
4197         choose one?]
4198       </para>
4199       <para>
4200         The executable launched will have the environment variable
4201         <literal>DBUS_STARTER_ADDRESS</literal> set to the address of the
4202         message bus so it can connect and request the appropriate names.
4203       </para>
4204       <para>
4205         The executable being launched may want to know whether the message bus
4206         starting it is one of the well-known message buses (see <xref
4207         linkend="message-bus-types"/>). To facilitate this, the bus must also set
4208         the <literal>DBUS_STARTER_BUS_TYPE</literal> environment variable if it is one
4209         of the well-known buses. The currently-defined values for this variable
4210         are <literal>system</literal> for the systemwide message bus,
4211         and <literal>session</literal> for the per-login-session message
4212         bus. The new executable must still connect to the address given
4213         in <literal>DBUS_STARTER_ADDRESS</literal>, but may assume that the
4214         resulting connection is to the well-known bus.
4215       </para>
4216       <para>
4217         [FIXME there should be a timeout somewhere, either specified
4218         in the .service file, by the client, or just a global value
4219         and if the client being activated fails to connect within that
4220         timeout, an error should be sent back.]
4221       </para>
4222
4223       <sect3 id="message-bus-starting-services-scope">
4224         <title>Message Bus Service Scope</title>
4225         <para>
4226           The "scope" of a service is its "per-", such as per-session,
4227           per-machine, per-home-directory, or per-display. The reference
4228           implementation doesn't yet support starting services in a different
4229           scope from the message bus itself. So e.g. if you start a service
4230           on the session bus its scope is per-session.
4231         </para>
4232         <para>
4233           We could add an optional scope to a bus name. For example, for
4234           per-(display,session pair), we could have a unique ID for each display
4235           generated automatically at login and set on screen 0 by executing a
4236           special "set display ID" binary. The ID would be stored in a
4237           <literal>_DBUS_DISPLAY_ID</literal> property and would be a string of
4238           random bytes. This ID would then be used to scope names.
4239           Starting/locating a service could be done by ID-name pair rather than
4240           only by name.
4241         </para>
4242         <para>
4243           Contrast this with a per-display scope. To achieve that, we would
4244           want a single bus spanning all sessions using a given display.
4245           So we might set a <literal>_DBUS_DISPLAY_BUS_ADDRESS</literal>
4246           property on screen 0 of the display, pointing to this bus.
4247         </para>
4248       </sect3>
4249     </sect2>
4250
4251     <sect2 id="message-bus-types">
4252       <title>Well-known Message Bus Instances</title>
4253       <para>
4254         Two standard message bus instances are defined here, along with how
4255         to locate them and where their service files live.
4256       </para>
4257       <sect3 id="message-bus-types-login">
4258         <title>Login session message bus</title>
4259         <para>
4260           Each time a user logs in, a <firstterm>login session message
4261             bus</firstterm> may be started. All applications in the user's login
4262           session may interact with one another using this message bus.
4263         </para>
4264         <para>
4265           The address of the login session message bus is given
4266           in the <literal>DBUS_SESSION_BUS_ADDRESS</literal> environment
4267           variable. If that variable is not set, applications may
4268           also try to read the address from the X Window System root
4269           window property <literal>_DBUS_SESSION_BUS_ADDRESS</literal>.
4270           The root window property must have type <literal>STRING</literal>.
4271           The environment variable should have precedence over the
4272           root window property.
4273         </para>
4274         <para>The address of the login session message bus is given in the
4275         <literal>DBUS_SESSION_BUS_ADDRESS</literal> environment variable. If
4276         DBUS_SESSION_BUS_ADDRESS is not set, or if it's set to the string
4277         "autolaunch:", the system should use platform-specific methods of
4278         locating a running D-Bus session server, or starting one if a running
4279         instance cannot be found. Note that this mechanism is not recommended
4280         for attempting to determine if a daemon is running. It is inherently
4281         racy to attempt to make this determination, since the bus daemon may
4282         be started just before or just after the determination is made.
4283         Therefore, it is recommended that applications do not try to make this
4284         determination for their functionality purposes, and instead they
4285         should attempt to start the server.</para>
4286
4287         <sect4 id="message-bus-types-login-x-windows">
4288           <title>X Windowing System</title>
4289           <para>
4290             For the X Windowing System, the application must locate the
4291             window owner of the selection represented by the atom formed by
4292             concatenating:
4293             <itemizedlist>
4294               <listitem>
4295                 <para>the literal string "_DBUS_SESSION_BUS_SELECTION_"</para>
4296               </listitem>
4297
4298               <listitem>
4299                 <para>the current user's username</para>
4300               </listitem>
4301
4302               <listitem>
4303                 <para>the literal character '_' (underscore)</para>
4304               </listitem>
4305
4306               <listitem>
4307                 <para>the machine's ID</para>
4308               </listitem>
4309             </itemizedlist>
4310           </para>
4311
4312           <para>
4313             The following properties are defined for the window that owns
4314             this X selection:
4315             <informaltable frame="all">
4316               <tgroup cols="2">
4317                 <tbody>
4318                   <row>
4319                     <entry>
4320                       <para>Atom</para>
4321                     </entry>
4322
4323                     <entry>
4324                       <para>meaning</para>
4325                     </entry>
4326                   </row>
4327
4328                   <row>
4329                     <entry>
4330                       <para>_DBUS_SESSION_BUS_ADDRESS</para>
4331                     </entry>
4332
4333                     <entry>
4334                       <para>the actual address of the server socket</para>
4335                     </entry>
4336                   </row>
4337
4338                   <row>
4339                     <entry>
4340                       <para>_DBUS_SESSION_BUS_PID</para>
4341                     </entry>
4342
4343                     <entry>
4344                       <para>the PID of the server process</para>
4345                     </entry>
4346                   </row>
4347                 </tbody>
4348               </tgroup>
4349             </informaltable>
4350           </para>
4351
4352           <para>
4353             At least the _DBUS_SESSION_BUS_ADDRESS property MUST be
4354             present in this window.
4355           </para>
4356
4357           <para>
4358             If the X selection cannot be located or if reading the
4359             properties from the window fails, the implementation MUST conclude
4360             that there is no D-Bus server running and proceed to start a new
4361             server. (See below on concurrency issues)
4362           </para>
4363
4364           <para>
4365             Failure to connect to the D-Bus server address thus obtained
4366             MUST be treated as a fatal connection error and should be reported
4367             to the application.
4368           </para>
4369
4370           <para>
4371             As an alternative, an implementation MAY find the information
4372             in the following file located in the current user's home directory,
4373             in subdirectory .dbus/session-bus/:
4374             <itemizedlist>
4375               <listitem>
4376                 <para>the machine's ID</para>
4377               </listitem>
4378
4379               <listitem>
4380                 <para>the literal character '-' (dash)</para>
4381               </listitem>
4382
4383               <listitem>
4384                 <para>the X display without the screen number, with the
4385                 following prefixes removed, if present: ":", "localhost:"
4386                 ."localhost.localdomain:". That is, a display of
4387                 "localhost:10.0" produces just the number "10"</para>
4388               </listitem>
4389             </itemizedlist>
4390           </para>
4391
4392           <para>
4393             The contents of this file NAME=value assignment pairs and
4394             lines starting with # are comments (no comments are allowed
4395             otherwise). The following variable names are defined:
4396             <informaltable
4397               frame="all">
4398               <tgroup cols="2">
4399                 <tbody>
4400                   <row>
4401                     <entry>
4402                       <para>Variable</para>
4403                     </entry>
4404
4405                     <entry>
4406                       <para>meaning</para>
4407                     </entry>
4408                   </row>
4409
4410                   <row>
4411                     <entry>
4412                       <para>DBUS_SESSION_BUS_ADDRESS</para>
4413                     </entry>
4414
4415                     <entry>
4416                       <para>the actual address of the server socket</para>
4417                     </entry>
4418                   </row>
4419
4420                   <row>
4421                     <entry>
4422                       <para>DBUS_SESSION_BUS_PID</para>
4423                     </entry>
4424
4425                     <entry>
4426                       <para>the PID of the server process</para>
4427                     </entry>
4428                   </row>
4429
4430                   <row>
4431                     <entry>
4432                       <para>DBUS_SESSION_BUS_WINDOWID</para>
4433                     </entry>
4434
4435                     <entry>
4436                       <para>the window ID</para>
4437                     </entry>
4438                   </row>
4439                 </tbody>
4440               </tgroup>
4441             </informaltable>
4442           </para>
4443
4444           <para>
4445             At least the DBUS_SESSION_BUS_ADDRESS variable MUST be present
4446             in this file.
4447           </para>
4448
4449           <para>
4450             Failure to open this file MUST be interpreted as absence of a
4451             running server. Therefore, the implementation MUST proceed to
4452             attempting to launch a new bus server if the file cannot be
4453             opened.
4454           </para>
4455
4456           <para>
4457             However, success in opening this file MUST NOT lead to the
4458             conclusion that the server is running. Thus, a failure to connect to
4459             the bus address obtained by the alternative method MUST NOT be
4460             considered a fatal error. If the connection cannot be established,
4461             the implementation MUST proceed to check the X selection settings or
4462             to start the server on its own.
4463           </para>
4464
4465           <para>
4466             If the implementation concludes that the D-Bus server is not
4467             running it MUST attempt to start a new server and it MUST also
4468             ensure that the daemon started as an effect of the "autolaunch"
4469             mechanism provides the lookup mechanisms described above, so
4470             subsequent calls can locate the newly started server. The
4471             implementation MUST also ensure that if two or more concurrent
4472             initiations happen, only one server remains running and all other
4473             initiations are able to obtain the address of this server and
4474             connect to it. In other words, the implementation MUST ensure that
4475             the X selection is not present when it attempts to set it, without
4476             allowing another process to set the selection between the
4477             verification and the setting (e.g., by using XGrabServer /
4478             XungrabServer).
4479           </para>
4480         </sect4>
4481         <sect4>
4482           <title></title>
4483           <para>
4484             [FIXME specify location of .service files, probably using
4485             DESKTOP_DIRS etc. from basedir specification, though login session
4486             bus is not really desktop-specific]
4487           </para>
4488         </sect4>
4489       </sect3>
4490       <sect3 id="message-bus-types-system">
4491         <title>System message bus</title>
4492         <para>
4493           A computer may have a <firstterm>system message bus</firstterm>,
4494           accessible to all applications on the system. This message bus may be
4495           used to broadcast system events, such as adding new hardware devices,
4496           changes in the printer queue, and so forth.
4497         </para>
4498         <para>
4499           The address of the system message bus is given
4500           in the <literal>DBUS_SYSTEM_BUS_ADDRESS</literal> environment
4501           variable. If that variable is not set, applications should try
4502           to connect to the well-known address
4503           <literal>unix:path=/var/run/dbus/system_bus_socket</literal>.
4504           <footnote>
4505             <para>
4506               The D-Bus reference implementation actually honors the
4507               <literal>$(localstatedir)</literal> configure option
4508               for this address, on both client and server side.
4509             </para>
4510           </footnote>
4511         </para>
4512         <para>
4513           [FIXME specify location of system bus .service files]
4514         </para>
4515       </sect3>
4516     </sect2>
4517
4518     <sect2 id="message-bus-messages">
4519       <title>Message Bus Messages</title>
4520       <para>
4521         The special message bus name <literal>org.freedesktop.DBus</literal>
4522         responds to a number of additional messages.
4523       </para>
4524
4525       <sect3 id="bus-messages-hello">
4526         <title><literal>org.freedesktop.DBus.Hello</literal></title>
4527         <para>
4528           As a method:
4529           <programlisting>
4530             STRING Hello ()
4531           </programlisting>
4532           Reply arguments:
4533           <informaltable>
4534             <tgroup cols="3">
4535               <thead>
4536                 <row>
4537                   <entry>Argument</entry>
4538                   <entry>Type</entry>
4539                   <entry>Description</entry>
4540                 </row>
4541               </thead>
4542               <tbody>
4543                 <row>
4544                   <entry>0</entry>
4545                   <entry>STRING</entry>
4546                   <entry>Unique name assigned to the connection</entry>
4547                 </row>
4548               </tbody>
4549             </tgroup>
4550           </informaltable>
4551         </para>
4552         <para>
4553           Before an application is able to send messages to other applications
4554           it must send the <literal>org.freedesktop.DBus.Hello</literal> message
4555           to the message bus to obtain a unique name. If an application without
4556           a unique name tries to send a message to another application, or a
4557           message to the message bus itself that isn't the
4558           <literal>org.freedesktop.DBus.Hello</literal> message, it will be
4559           disconnected from the bus.
4560         </para>
4561         <para>
4562           There is no corresponding "disconnect" request; if a client wishes to
4563           disconnect from the bus, it simply closes the socket (or other
4564           communication channel).
4565         </para>
4566       </sect3>
4567       <sect3 id="bus-messages-list-names">
4568         <title><literal>org.freedesktop.DBus.ListNames</literal></title>
4569         <para>
4570           As a method:
4571           <programlisting>
4572             ARRAY of STRING ListNames ()
4573           </programlisting>
4574           Reply arguments:
4575           <informaltable>
4576             <tgroup cols="3">
4577               <thead>
4578                 <row>
4579                   <entry>Argument</entry>
4580                   <entry>Type</entry>
4581                   <entry>Description</entry>
4582                 </row>
4583               </thead>
4584               <tbody>
4585                 <row>
4586                   <entry>0</entry>
4587                   <entry>ARRAY of STRING</entry>
4588                   <entry>Array of strings where each string is a bus name</entry>
4589                 </row>
4590               </tbody>
4591             </tgroup>
4592           </informaltable>
4593         </para>
4594         <para>
4595           Returns a list of all currently-owned names on the bus.
4596         </para>
4597       </sect3>
4598       <sect3 id="bus-messages-list-activatable-names">
4599         <title><literal>org.freedesktop.DBus.ListActivatableNames</literal></title>
4600         <para>
4601           As a method:
4602           <programlisting>
4603             ARRAY of STRING ListActivatableNames ()
4604           </programlisting>
4605           Reply arguments:
4606           <informaltable>
4607             <tgroup cols="3">
4608               <thead>
4609                 <row>
4610                   <entry>Argument</entry>
4611                   <entry>Type</entry>
4612                   <entry>Description</entry>
4613                 </row>
4614               </thead>
4615               <tbody>
4616                 <row>
4617                   <entry>0</entry>
4618                   <entry>ARRAY of STRING</entry>
4619                   <entry>Array of strings where each string is a bus name</entry>
4620                 </row>
4621               </tbody>
4622             </tgroup>
4623           </informaltable>
4624         </para>
4625         <para>
4626           Returns a list of all names that can be activated on the bus.
4627         </para>
4628       </sect3>
4629       <sect3 id="bus-messages-name-exists">
4630         <title><literal>org.freedesktop.DBus.NameHasOwner</literal></title>
4631         <para>
4632           As a method:
4633           <programlisting>
4634             BOOLEAN NameHasOwner (in STRING name)
4635           </programlisting>
4636           Message arguments:
4637           <informaltable>
4638             <tgroup cols="3">
4639               <thead>
4640                 <row>
4641                   <entry>Argument</entry>
4642                   <entry>Type</entry>
4643                   <entry>Description</entry>
4644                 </row>
4645               </thead>
4646               <tbody>
4647                 <row>
4648                   <entry>0</entry>
4649                   <entry>STRING</entry>
4650                   <entry>Name to check</entry>
4651                 </row>
4652               </tbody>
4653             </tgroup>
4654           </informaltable>
4655           Reply arguments:
4656           <informaltable>
4657             <tgroup cols="3">
4658               <thead>
4659                 <row>
4660                   <entry>Argument</entry>
4661                   <entry>Type</entry>
4662                   <entry>Description</entry>
4663                 </row>
4664               </thead>
4665               <tbody>
4666                 <row>
4667                   <entry>0</entry>
4668                   <entry>BOOLEAN</entry>
4669                   <entry>Return value, true if the name exists</entry>
4670                 </row>
4671               </tbody>
4672             </tgroup>
4673           </informaltable>
4674         </para>
4675         <para>
4676           Checks if the specified name exists (currently has an owner).
4677         </para>
4678       </sect3>
4679
4680       <sect3 id="bus-messages-name-owner-changed">
4681         <title><literal>org.freedesktop.DBus.NameOwnerChanged</literal></title>
4682         <para>
4683           This is a signal:
4684           <programlisting>
4685             NameOwnerChanged (STRING name, STRING old_owner, STRING new_owner)
4686           </programlisting>
4687           Message arguments:
4688           <informaltable>
4689             <tgroup cols="3">
4690               <thead>
4691                 <row>
4692                   <entry>Argument</entry>
4693                   <entry>Type</entry>
4694                   <entry>Description</entry>
4695                 </row>
4696               </thead>
4697               <tbody>
4698                 <row>
4699                   <entry>0</entry>
4700                   <entry>STRING</entry>
4701                   <entry>Name with a new owner</entry>
4702                 </row>
4703                 <row>
4704                   <entry>1</entry>
4705                   <entry>STRING</entry>
4706                   <entry>Old owner or empty string if none</entry>
4707                 </row>
4708                 <row>
4709                   <entry>2</entry>
4710                   <entry>STRING</entry>
4711                   <entry>New owner or empty string if none</entry>
4712                 </row>
4713               </tbody>
4714             </tgroup>
4715           </informaltable>
4716         </para>
4717         <para>
4718           This signal indicates that the owner of a name has changed.
4719           It's also the signal to use to detect the appearance of
4720           new names on the bus.
4721         </para>
4722       </sect3>
4723       <sect3 id="bus-messages-name-lost">
4724         <title><literal>org.freedesktop.DBus.NameLost</literal></title>
4725         <para>
4726           This is a signal:
4727           <programlisting>
4728             NameLost (STRING name)
4729           </programlisting>
4730           Message arguments:
4731           <informaltable>
4732             <tgroup cols="3">
4733               <thead>
4734                 <row>
4735                   <entry>Argument</entry>
4736                   <entry>Type</entry>
4737                   <entry>Description</entry>
4738                 </row>
4739               </thead>
4740               <tbody>
4741                 <row>
4742                   <entry>0</entry>
4743                   <entry>STRING</entry>
4744                   <entry>Name which was lost</entry>
4745                 </row>
4746               </tbody>
4747             </tgroup>
4748           </informaltable>
4749         </para>
4750         <para>
4751           This signal is sent to a specific application when it loses
4752           ownership of a name.
4753         </para>
4754       </sect3>
4755
4756       <sect3 id="bus-messages-name-acquired">
4757         <title><literal>org.freedesktop.DBus.NameAcquired</literal></title>
4758         <para>
4759           This is a signal:
4760           <programlisting>
4761             NameAcquired (STRING name)
4762           </programlisting>
4763           Message arguments:
4764           <informaltable>
4765             <tgroup cols="3">
4766               <thead>
4767                 <row>
4768                   <entry>Argument</entry>
4769                   <entry>Type</entry>
4770                   <entry>Description</entry>
4771                 </row>
4772               </thead>
4773               <tbody>
4774                 <row>
4775                   <entry>0</entry>
4776                   <entry>STRING</entry>
4777                   <entry>Name which was acquired</entry>
4778                 </row>
4779               </tbody>
4780             </tgroup>
4781           </informaltable>
4782         </para>
4783         <para>
4784           This signal is sent to a specific application when it gains
4785           ownership of a name.
4786         </para>
4787       </sect3>
4788
4789       <sect3 id="bus-messages-start-service-by-name">
4790         <title><literal>org.freedesktop.DBus.StartServiceByName</literal></title>
4791         <para>
4792           As a method:
4793           <programlisting>
4794             UINT32 StartServiceByName (in STRING name, in UINT32 flags)
4795           </programlisting>
4796           Message arguments:
4797           <informaltable>
4798             <tgroup cols="3">
4799               <thead>
4800                 <row>
4801                   <entry>Argument</entry>
4802                   <entry>Type</entry>
4803                   <entry>Description</entry>
4804                 </row>
4805               </thead>
4806               <tbody>
4807                 <row>
4808                   <entry>0</entry>
4809                   <entry>STRING</entry>
4810                   <entry>Name of the service to start</entry>
4811                 </row>
4812                 <row>
4813                   <entry>1</entry>
4814                   <entry>UINT32</entry>
4815                   <entry>Flags (currently not used)</entry>
4816                 </row>
4817               </tbody>
4818             </tgroup>
4819           </informaltable>
4820         Reply arguments:
4821         <informaltable>
4822           <tgroup cols="3">
4823             <thead>
4824               <row>
4825                 <entry>Argument</entry>
4826                 <entry>Type</entry>
4827                 <entry>Description</entry>
4828               </row>
4829             </thead>
4830             <tbody>
4831               <row>
4832                 <entry>0</entry>
4833                 <entry>UINT32</entry>
4834                 <entry>Return value</entry>
4835               </row>
4836             </tbody>
4837           </tgroup>
4838         </informaltable>
4839           Tries to launch the executable associated with a name. For more information, see <xref linkend="message-bus-starting-services"/>.
4840
4841         </para>
4842         <para>
4843           The return value can be one of the following values:
4844           <informaltable>
4845             <tgroup cols="3">
4846               <thead>
4847                 <row>
4848                   <entry>Identifier</entry>
4849                   <entry>Value</entry>
4850                   <entry>Description</entry>
4851                 </row>
4852               </thead>
4853               <tbody>
4854                 <row>
4855                   <entry>DBUS_START_REPLY_SUCCESS</entry>
4856                   <entry>1</entry>
4857                   <entry>The service was successfully started.</entry>
4858                 </row>
4859                 <row>
4860                   <entry>DBUS_START_REPLY_ALREADY_RUNNING</entry>
4861                   <entry>2</entry>
4862                   <entry>A connection already owns the given name.</entry>
4863                 </row>
4864               </tbody>
4865              </tgroup>
4866            </informaltable>
4867         </para>
4868
4869       </sect3>
4870
4871       <sect3 id="bus-messages-update-activation-environment">
4872         <title><literal>org.freedesktop.DBus.UpdateActivationEnvironment</literal></title>
4873         <para>
4874           As a method:
4875           <programlisting>
4876             UpdateActivationEnvironment (in ARRAY of DICT&lt;STRING,STRING&gt; environment)
4877           </programlisting>
4878           Message arguments:
4879           <informaltable>
4880             <tgroup cols="3">
4881               <thead>
4882                 <row>
4883                   <entry>Argument</entry>
4884                   <entry>Type</entry>
4885                   <entry>Description</entry>
4886                 </row>
4887               </thead>
4888               <tbody>
4889                 <row>
4890                   <entry>0</entry>
4891                   <entry>ARRAY of DICT&lt;STRING,STRING&gt;</entry>
4892                   <entry>Environment to add or update</entry>
4893                 </row>
4894               </tbody>
4895             </tgroup>
4896             </informaltable>
4897             Normally, session bus activated services inherit the environment of the bus daemon.  This method adds to or modifies that environment when activating services.
4898         </para>
4899         <para>
4900           Some bus instances, such as the standard system bus, may disable access to this method for some or all callers.
4901         </para>
4902         <para>
4903           Note, both the environment variable names and values must be valid UTF-8.  There's no way to update the activation environment with data that is invalid UTF-8.
4904         </para>
4905
4906       </sect3>
4907
4908       <sect3 id="bus-messages-get-name-owner">
4909         <title><literal>org.freedesktop.DBus.GetNameOwner</literal></title>
4910         <para>
4911           As a method:
4912           <programlisting>
4913             STRING GetNameOwner (in STRING name)
4914           </programlisting>
4915           Message arguments:
4916           <informaltable>
4917             <tgroup cols="3">
4918               <thead>
4919                 <row>
4920                   <entry>Argument</entry>
4921                   <entry>Type</entry>
4922                   <entry>Description</entry>
4923                 </row>
4924               </thead>
4925               <tbody>
4926                 <row>
4927                   <entry>0</entry>
4928                   <entry>STRING</entry>
4929                   <entry>Name to get the owner of</entry>
4930                 </row>
4931               </tbody>
4932             </tgroup>
4933           </informaltable>
4934         Reply arguments:
4935         <informaltable>
4936           <tgroup cols="3">
4937             <thead>
4938               <row>
4939                 <entry>Argument</entry>
4940                 <entry>Type</entry>
4941                 <entry>Description</entry>
4942               </row>
4943             </thead>
4944             <tbody>
4945               <row>
4946                 <entry>0</entry>
4947                 <entry>STRING</entry>
4948                 <entry>Return value, a unique connection name</entry>
4949               </row>
4950             </tbody>
4951           </tgroup>
4952         </informaltable>
4953         Returns the unique connection name of the primary owner of the name
4954         given. If the requested name doesn't have an owner, returns a
4955         <literal>org.freedesktop.DBus.Error.NameHasNoOwner</literal> error.
4956        </para>
4957       </sect3>
4958
4959       <sect3 id="bus-messages-get-connection-unix-user">
4960         <title><literal>org.freedesktop.DBus.GetConnectionUnixUser</literal></title>
4961         <para>
4962           As a method:
4963           <programlisting>
4964             UINT32 GetConnectionUnixUser (in STRING bus_name)
4965           </programlisting>
4966           Message arguments:
4967           <informaltable>
4968             <tgroup cols="3">
4969               <thead>
4970                 <row>
4971                   <entry>Argument</entry>
4972                   <entry>Type</entry>
4973                   <entry>Description</entry>
4974                 </row>
4975               </thead>
4976               <tbody>
4977                 <row>
4978                   <entry>0</entry>
4979                   <entry>STRING</entry>
4980                   <entry>Unique or well-known bus name of the connection to
4981                     query, such as <literal>:12.34</literal> or
4982                     <literal>com.example.tea</literal></entry>
4983                 </row>
4984               </tbody>
4985             </tgroup>
4986           </informaltable>
4987         Reply arguments:
4988         <informaltable>
4989           <tgroup cols="3">
4990             <thead>
4991               <row>
4992                 <entry>Argument</entry>
4993                 <entry>Type</entry>
4994                 <entry>Description</entry>
4995               </row>
4996             </thead>
4997             <tbody>
4998               <row>
4999                 <entry>0</entry>
5000                 <entry>UINT32</entry>
5001                 <entry>Unix user ID</entry>
5002               </row>
5003             </tbody>
5004           </tgroup>
5005         </informaltable>
5006         Returns the Unix user ID of the process connected to the server. If
5007         unable to determine it (for instance, because the process is not on the
5008         same machine as the bus daemon), an error is returned.
5009        </para>
5010       </sect3>
5011
5012       <sect3 id="bus-messages-get-connection-unix-process-id">
5013         <title><literal>org.freedesktop.DBus.GetConnectionUnixProcessID</literal></title>
5014         <para>
5015           As a method:
5016           <programlisting>
5017             UINT32 GetConnectionUnixProcessID (in STRING bus_name)
5018           </programlisting>
5019           Message arguments:
5020           <informaltable>
5021             <tgroup cols="3">
5022               <thead>
5023                 <row>
5024                   <entry>Argument</entry>
5025                   <entry>Type</entry>
5026                   <entry>Description</entry>
5027                 </row>
5028               </thead>
5029               <tbody>
5030                 <row>
5031                   <entry>0</entry>
5032                   <entry>STRING</entry>
5033                   <entry>Unique or well-known bus name of the connection to
5034                     query, such as <literal>:12.34</literal> or
5035                     <literal>com.example.tea</literal></entry>
5036                 </row>
5037               </tbody>
5038             </tgroup>
5039           </informaltable>
5040         Reply arguments:
5041         <informaltable>
5042           <tgroup cols="3">
5043             <thead>
5044               <row>
5045                 <entry>Argument</entry>
5046                 <entry>Type</entry>
5047                 <entry>Description</entry>
5048               </row>
5049             </thead>
5050             <tbody>
5051               <row>
5052                 <entry>0</entry>
5053                 <entry>UINT32</entry>
5054                 <entry>Unix process id</entry>
5055               </row>
5056             </tbody>
5057           </tgroup>
5058         </informaltable>
5059         Returns the Unix process ID of the process connected to the server. If
5060         unable to determine it (for instance, because the process is not on the
5061         same machine as the bus daemon), an error is returned.
5062        </para>
5063       </sect3>
5064
5065       <sect3 id="bus-messages-add-match">
5066         <title><literal>org.freedesktop.DBus.AddMatch</literal></title>
5067         <para>
5068           As a method:
5069           <programlisting>
5070             AddMatch (in STRING rule)
5071           </programlisting>
5072           Message arguments:
5073           <informaltable>
5074             <tgroup cols="3">
5075               <thead>
5076                 <row>
5077                   <entry>Argument</entry>
5078                   <entry>Type</entry>
5079                   <entry>Description</entry>
5080                 </row>
5081               </thead>
5082               <tbody>
5083                 <row>
5084                   <entry>0</entry>
5085                   <entry>STRING</entry>
5086                   <entry>Match rule to add to the connection</entry>
5087                 </row>
5088               </tbody>
5089             </tgroup>
5090           </informaltable>
5091         Adds a match rule to match messages going through the message bus (see <xref linkend='message-bus-routing-match-rules'/>).
5092         If the bus does not have enough resources the <literal>org.freedesktop.DBus.Error.OOM</literal>
5093         error is returned.
5094        </para>
5095       </sect3>
5096       <sect3 id="bus-messages-remove-match">
5097         <title><literal>org.freedesktop.DBus.RemoveMatch</literal></title>
5098         <para>
5099           As a method:
5100           <programlisting>
5101             RemoveMatch (in STRING rule)
5102           </programlisting>
5103           Message arguments:
5104           <informaltable>
5105             <tgroup cols="3">
5106               <thead>
5107                 <row>
5108                   <entry>Argument</entry>
5109                   <entry>Type</entry>
5110                   <entry>Description</entry>
5111                 </row>
5112               </thead>
5113               <tbody>
5114                 <row>
5115                   <entry>0</entry>
5116                   <entry>STRING</entry>
5117                   <entry>Match rule to remove from the connection</entry>
5118                 </row>
5119               </tbody>
5120             </tgroup>
5121           </informaltable>
5122         Removes the first rule that matches (see <xref linkend='message-bus-routing-match-rules'/>).
5123         If the rule is not found the <literal>org.freedesktop.DBus.Error.MatchRuleNotFound</literal>
5124         error is returned.
5125        </para>
5126       </sect3>
5127
5128       <sect3 id="bus-messages-get-id">
5129         <title><literal>org.freedesktop.DBus.GetId</literal></title>
5130         <para>
5131           As a method:
5132           <programlisting>
5133             GetId (out STRING id)
5134           </programlisting>
5135         Reply arguments:
5136         <informaltable>
5137           <tgroup cols="3">
5138             <thead>
5139               <row>
5140                 <entry>Argument</entry>
5141                 <entry>Type</entry>
5142                 <entry>Description</entry>
5143               </row>
5144             </thead>
5145             <tbody>
5146               <row>
5147                 <entry>0</entry>
5148                 <entry>STRING</entry>
5149                 <entry>Unique ID identifying the bus daemon</entry>
5150               </row>
5151             </tbody>
5152           </tgroup>
5153         </informaltable>
5154         Gets the unique ID of the bus. The unique ID here is shared among all addresses the
5155         bus daemon is listening on (TCP, UNIX domain socket, etc.) and its format is described in
5156         <xref linkend="uuids"/>. Each address the bus is listening on also has its own unique
5157         ID, as described in <xref linkend="addresses"/>. The per-bus and per-address IDs are not related.
5158         There is also a per-machine ID, described in <xref linkend="standard-interfaces-peer"/> and returned
5159         by org.freedesktop.DBus.Peer.GetMachineId().
5160         For a desktop session bus, the bus ID can be used as a way to uniquely identify a user's session.
5161         </para>
5162       </sect3>
5163
5164     </sect2>
5165
5166   </sect1>
5167 <!--
5168   <appendix id="implementation-notes">
5169     <title>Implementation notes</title>
5170     <sect1 id="implementation-notes-subsection">
5171       <title></title>
5172       <para>
5173       </para>
5174     </sect1>
5175   </appendix>
5176 -->
5177
5178   <glossary><title>Glossary</title>
5179     <para>
5180       This glossary defines some of the terms used in this specification.
5181     </para>
5182
5183     <glossentry id="term-bus-name"><glossterm>Bus Name</glossterm>
5184       <glossdef>
5185         <para>
5186           The message bus maintains an association between names and
5187           connections. (Normally, there's one connection per application.)  A
5188           bus name is simply an identifier used to locate connections. For
5189           example, the hypothetical <literal>com.yoyodyne.Screensaver</literal>
5190           name might be used to send a message to a screensaver from Yoyodyne
5191           Corporation.  An application is said to <firstterm>own</firstterm> a
5192           name if the message bus has associated the application's connection
5193           with the name.  Names may also have <firstterm>queued
5194           owners</firstterm> (see <xref linkend="term-queued-owner"/>).
5195             The bus assigns a unique name to each connection,
5196             see <xref linkend="term-unique-name"/>. Other names
5197               can be thought of as "well-known names" and are
5198               used to find applications that offer specific functionality.
5199         </para>
5200       </glossdef>
5201     </glossentry>
5202
5203     <glossentry id="term-message"><glossterm>Message</glossterm>
5204       <glossdef>
5205         <para>
5206           A message is the atomic unit of communication via the D-Bus
5207           protocol. It consists of a <firstterm>header</firstterm> and a
5208           <firstterm>body</firstterm>; the body is made up of
5209           <firstterm>arguments</firstterm>.
5210         </para>
5211       </glossdef>
5212     </glossentry>
5213
5214     <glossentry id="term-message-bus"><glossterm>Message Bus</glossterm>
5215       <glossdef>
5216         <para>
5217           The message bus is a special application that forwards
5218           or routes messages between a group of applications
5219           connected to the message bus. It also manages
5220           <firstterm>names</firstterm> used for routing
5221           messages.
5222         </para>
5223       </glossdef>
5224     </glossentry>
5225
5226     <glossentry id="term-name"><glossterm>Name</glossterm>
5227       <glossdef>
5228         <para>
5229           See <xref linkend="term-bus-name"/>. "Name" may
5230             also be used to refer to some of the other names
5231             in D-Bus, such as interface names.
5232         </para>
5233       </glossdef>
5234     </glossentry>
5235
5236     <glossentry id="namespace"><glossterm>Namespace</glossterm>
5237       <glossdef>
5238         <para>
5239           Used to prevent collisions when defining new interfaces or bus
5240           names. The convention used is the same one Java uses for defining
5241           classes: a reversed domain name.
5242         </para>
5243       </glossdef>
5244     </glossentry>
5245
5246     <glossentry id="term-object"><glossterm>Object</glossterm>
5247       <glossdef>
5248         <para>
5249           Each application contains <firstterm>objects</firstterm>, which have
5250           <firstterm>interfaces</firstterm> and
5251           <firstterm>methods</firstterm>. Objects are referred to by a name,
5252           called a <firstterm>path</firstterm>.
5253         </para>
5254       </glossdef>
5255     </glossentry>
5256
5257     <glossentry id="one-to-one"><glossterm>One-to-One</glossterm>
5258       <glossdef>
5259         <para>
5260           An application talking directly to another application, without going
5261           through a message bus. One-to-one connections may be "peer to peer" or
5262           "client to server." The D-Bus protocol has no concept of client
5263           vs. server after a connection has authenticated; the flow of messages
5264           is symmetrical (full duplex).
5265         </para>
5266       </glossdef>
5267     </glossentry>
5268
5269     <glossentry id="term-path"><glossterm>Path</glossterm>
5270       <glossdef>
5271         <para>
5272           Object references (object names) in D-Bus are organized into a
5273           filesystem-style hierarchy, so each object is named by a path. As in
5274           LDAP, there's no difference between "files" and "directories"; a path
5275           can refer to an object, while still having child objects below it.
5276         </para>
5277       </glossdef>
5278     </glossentry>
5279
5280     <glossentry id="term-queued-owner"><glossterm>Queued Name Owner</glossterm>
5281       <glossdef>
5282         <para>
5283           Each bus name has a primary owner; messages sent to the name go to the
5284           primary owner. However, certain names also maintain a queue of
5285           secondary owners "waiting in the wings." If the primary owner releases
5286           the name, then the first secondary owner in the queue automatically
5287           becomes the new owner of the name.
5288         </para>
5289       </glossdef>
5290     </glossentry>
5291
5292     <glossentry id="term-service"><glossterm>Service</glossterm>
5293       <glossdef>
5294         <para>
5295           A service is an executable that can be launched by the bus daemon.
5296           Services normally guarantee some particular features, for example they
5297           may guarantee that they will request a specific name such as
5298           "org.freedesktop.Screensaver", have a singleton object
5299           "/org/freedesktop/Application", and that object will implement the
5300           interface "org.freedesktop.ScreensaverControl".
5301         </para>
5302       </glossdef>
5303     </glossentry>
5304
5305     <glossentry id="term-service-description-files"><glossterm>Service Description Files</glossterm>
5306       <glossdef>
5307         <para>
5308           ".service files" tell the bus about service applications that can be
5309           launched (see <xref linkend="term-service"/>). Most importantly they
5310           provide a mapping from bus names to services that will request those
5311             names when they start up.
5312         </para>
5313       </glossdef>
5314     </glossentry>
5315
5316     <glossentry id="term-unique-name"><glossterm>Unique Connection Name</glossterm>
5317       <glossdef>
5318         <para>
5319           The special name automatically assigned to each connection by the
5320           message bus. This name will never change owner, and will be unique
5321           (never reused during the lifetime of the message bus).
5322           It will begin with a ':' character.
5323         </para>
5324       </glossdef>
5325     </glossentry>
5326
5327   </glossary>
5328 </article>