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