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