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.8</releaseinfo>
  11     <date>06 September 2003</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     <para>
  81       The base D-BUS protocol is a peer-to-peer protocol, specified in <xref
  82       linkend="message-protocol"/>. That is, it is a system for one application
  83       to talk to a single other application. However, the primary intended
  84       application of D-BUS is the D-BUS <firstterm>message bus</firstterm>,
  85       specified in <xref linkend="message-bus"/>. The message bus is a special
  86       application that accepts connections from multiple other applications, and
  87       forwards messages among them.
  88     </para>
  89     <para>
  90       Uses of D-BUS include notification of system changes (notification of when
  91       a camera is plugged in to a computer, or a new version of some software
  92       has been installed), or desktop interoperablity, for example a file
  93       monitoring service or a configuration service.
  94     </para>
  95   </sect1>
  96
  97   <sect1 id="message-protocol">
  98     <title>Message Protocol</title>
  99     <para>
 100       A <firstterm>message</firstterm> consists of a
 101       <firstterm>header</firstterm> and a <firstterm>body</firstterm>. If you
 102       think of a message as a package, the header is the address, and the body
 103       contains the package contents. The message delivery system uses the header
 104       information to figure out where to send the message and how to interpret
 105       it; the recipient inteprets the body of the message.
 106     </para>
 107
 108     <para>
 109       The body of the message is made up of zero or more
 110       <firstterm>arguments</firstterm>, which are typed
 111       values, such as an integer or a byte array.
 112     </para>
 113
 114     <sect2 id="message-protocol-header-encoding">
 115       <title>Header Encoding</title>
 116       <para>
 117         Following the mandatory fields, there are zero or more named fields (see
 118         <xref linkend="message-protocol-header-fields"/>), and then nul bytes
 119         padding the header such that its total length in bytes is a multiple of
 120         8.
 121       </para>
 122       <para>
 123         The header MUST begin with the following mandatory fields in the following
 124         order:
 125         <informaltable>
 126           <tgroup cols="2">
 127             <thead>
 128               <row>
 129                 <entry>Size</entry>
 130                 <entry>Description</entry>
 131               </row>
 132             </thead>
 133             <tbody>
 134               <row>
 135                 <entry>1 byte</entry>
 136                 <entry>Endianness flag; ASCII 'l' for little-endian
 137                   or ASCII 'B' for big-endian.</entry>
 138               </row>
 139               <row>
 140                 <entry>1 byte</entry>
 141                 <entry>Type of message. Unknown types MUST be ignored.
 142                   Currently-defined types are described below.
 143                 </entry>
 144               </row>
 145               <row>
 146                 <entry>1 byte</entry>
 147                 <entry>Bitwise OR of flags. Unknown flags
 148                   MUST be ignored. Currently-defined flags are described below.
 149                 </entry>
 150               </row>
 151               <row>
 152                 <entry>1 byte</entry>
 153                 <entry>Major protocol version of the sending application.  If
 154                 the major protocol version of the receiving application does not
 155                 match, the applications will not be able to communicate and the
 156                 D-BUS connection MUST be disconnected. The major protocol
 157                 version for this version of the specification is 0.
 158                 </entry>
 159               </row>
 160               <row>
 161                 <entry>4 bytes</entry>
 162                 <entry>An unsigned 32-bit integer in the
 163                   message's byte order, indicating the total length in bytes of
 164                   the header including named fields and any alignment padding.
 165                   MUST be a multiple of 8.
 166                 </entry>
 167               </row>
 168               <row>
 169                 <entry>4 bytes</entry>
 170                 <entry>An unsigned 32-bit integer in the
 171                   message's byte order, indicating the total length in bytes of
 172                   the message body.
 173                 </entry>
 174               </row>
 175               <row>
 176                 <entry>4 bytes</entry>
 177                 <entry>The message's serial number, an unsigned 32-bit integer in
 178                   the message's byte order. The serial number is a cookie used to
 179                   identify message replies; thus all outstanding unreplied-to messages
 180                   from the same connection MUST have a different serial number.
 181                   Zero is not a valid serial number, but all other numbers are
 182                   allowed.
 183                 </entry>
 184               </row>
 185             </tbody>
 186           </tgroup>
 187         </informaltable>
 188       </para>
 189       <para>
 190         Types that can appear in the second byte of the header:
 191         <informaltable>
 192           <tgroup cols="3">
 193             <thead>
 194               <row>
 195                 <entry>Conventional name</entry>
 196                 <entry>Decimal value</entry>
 197                 <entry>Description</entry>
 198               </row>
 199             </thead>
 200             <tbody>
 201               <row>
 202                 <entry>INVALID</entry>
 203                 <entry>0</entry>
 204                 <entry>This is an invalid type, if seen in a message
 205                   the connection should be dropped immediately.</entry>
 206               </row>
 207               <row>
 208                 <entry>METHOD_CALL</entry>
 209                 <entry>1</entry>
 210                 <entry>Method call.</entry>
 211               </row>
 212               <row>
 213                 <entry>METHOD_RETURN</entry>
 214                 <entry>2</entry>
 215                 <entry>Method reply with returned data.</entry>
 216               </row>
 217               <row>
 218                 <entry>ERROR</entry>
 219                 <entry>3</entry>
 220                 <entry>Error reply. If the first argument exists and is a
 221                 string, it is an error message.</entry>
 222               </row>
 223               <row>
 224                 <entry>SIGNAL</entry>
 225                 <entry>4</entry>
 226                 <entry>Signal emission.</entry>
 227               </row>
 228             </tbody>
 229           </tgroup>
 230         </informaltable>
 231       </para>
 232       <para>
 233         Flags that can appear in the third byte of the header:
 234         <informaltable>
 235           <tgroup cols="3">
 236             <thead>
 237               <row>
 238                 <entry>Conventional name</entry>
 239                 <entry>Hex value</entry>
 240                 <entry>Description</entry>
 241               </row>
 242             </thead>
 243             <tbody>
 244               <row>
 245                 <entry>NO_REPLY_EXPECTED</entry>
 246                 <entry>0x1</entry>
 247                 <entry>This message does not expect method return replies or
 248                 error replies; the reply can be omitted as an
 249                 optimization. However, it is compliant with this specification
 250                 to return the reply despite this flag.</entry>
 251               </row>
 252               <row>
 253                 <entry>AUTO_ACTIVATION</entry>
 254                 <entry>0x2</entry>
 255                 <entry>This message automatically activates the
 256                 addressed service before the message is delivered.</entry>
 257               </row>
 258             </tbody>
 259           </tgroup>
 260         </informaltable>
 261       </para>
 262     </sect2>
 263
 264     <sect2 id="message-protocol-header-fields">
 265       <title>Header Fields</title>
 266       <para>
 267         In addition to the required header information mentioned
 268         in <xref linkend="message-protocol-header-encoding"/>,
 269           the header must contain the required named header
 270           fields and zero or more of the optional named
 271           header fields. Future versions of this protocol
 272           specification may add new fields. Implementations must
 273           ignore fields they do not understand. Implementations
 274           must not invent their own header fields; only changes to
 275           this specification may introduce new header fields.
 276       </para>
 277
 278       <para>
 279         Header field names MUST consist of a single byte, possible values
 280         of which are defined below. Following the name, the field MUST have
 281         a type code represented as a single unsigned byte, and then a
 282         properly-aligned value of that type.  See <xref
 283         linkend="message-protocol-arguments"/> for a description of how each
 284         type is encoded. If an implementation sees a header field name that
 285         it does not understand, it MUST ignore that field.
 286       </para>
 287
 288       <para>
 289         Here are the currently-defined named header fields:
 290         <informaltable>
 291           <tgroup cols="5">
 292             <thead>
 293               <row>
 294                 <entry>Conventional Name</entry>
 295                 <entry>Decimal Value</entry>
 296                 <entry>Type</entry>
 297                 <entry>Required</entry>
 298                 <entry>Description</entry>
 299               </row>
 300             </thead>
 301             <tbody>
 302               <row>
 303                 <entry>INVALID</entry>
 304                 <entry>0</entry>
 305                 <entry>INVALID</entry>
 306                 <entry>no</entry>
 307                 <entry>Not a valid field name (error if it appears in a message)</entry>
 308               </row>
 309               <row>
 310                 <entry>PATH</entry>
 311                 <entry>1</entry>
 312                 <entry>OBJECT_PATH</entry>
 313                 <entry>yes</entry>
 314                 <entry>The object to send the message to; objects are identified by
 315                 a path, "/foo/bar"</entry>
 316               </row>
 317               <row>
 318                 <entry>INTERFACE</entry>
 319                 <entry>2</entry>
 320                 <entry>STRING</entry>
 321                 <entry>yes</entry>
 322                 <entry>The interface to invoke a method call on, or
 323                 that a signal is emitted from. e.g. "org.freedesktop.Introspectable"</entry>
 324               </row>
 325               <row>
 326                 <entry>MEMBER</entry>
 327                 <entry>3</entry>
 328                 <entry>STRING</entry>
 329                 <entry>yes</entry>
 330                 <entry>The member, either the method name or signal name.
 331                 e.g. "Frobate"</entry>
 332               </row>
 333               <row>
 334                 <entry>ERROR_NAME</entry>
 335                 <entry>4</entry>
 336                 <entry>STRING</entry>
 337                 <entry>no</entry>
 338                 <entry>The name of the error that occurred, for errors</entry>
 339               </row>
 340               <row>
 341                 <entry>REPLY_SERIAL</entry>
 342                 <entry>5</entry>
 343                 <entry>UINT32</entry>
 344                 <entry>no</entry>
 345                 <entry>The serial number of the message this message is a reply
 346                 to. (The serial number is one of the mandatory header fields,
 347                 see <xref linkend="message-protocol-header-encoding"/>.)</entry>
 348               </row>
 349               <row>
 350                 <entry>DESTINATION</entry>
 351                 <entry>6</entry>
 352                 <entry>STRING</entry>
 353                 <entry>no</entry>
 354                 <entry>The name of the service this message should be routed to.
 355                 Only used in combination with the message bus, see
 356                 <xref linkend="message-bus"/>.</entry>
 357               </row>
 358               <row>
 359                 <entry>SENDER</entry>
 360                 <entry>7</entry>
 361                 <entry>STRING</entry>
 362                 <entry>no</entry>
 363                 <entry>Sender service. The name of the base service that sent
 364                 this message.  The message bus fills in this field; the field is
 365                 only meaningful in combination with the message bus.</entry>
 366               </row>
 367             </tbody>
 368           </tgroup>
 369         </informaltable>
 370       </para>
 371
 372     </sect2>
 373     <sect2 id="message-protocol-header-padding">
 374       <title>Header Alignment Padding</title>
 375       <para>
 376         To allow implementations to keep the header and the body in a single
 377         buffer while keeping data types aligned, the total length of the header
 378         must be a multiple of 8 bytes.  To achieve this, the header MUST be padded
 379         with nul bytes to align its total length on an 8-byte boundary.
 380         The minimum number of padding bytes MUST be used. Because zero is an
 381         invalid field name, implementations can distinguish padding (which must be
 382         zero initialized) from additional named fields.
 383       </para>
 384     </sect2>
 385
 386     <sect2 id="message-protocol-arguments">
 387       <title>Message Arguments</title>
 388       <para>
 389         The message body is made up of arguments. Each argument is a type code,
 390         represented by a single unsigned byte, followed by the aligned value of
 391         the argument in a type-dependent format. Alignment padding between the
 392         typecode and the value is initialized to zero.
 393       </para>
 394       <para>
 395         <informaltable>
 396           <tgroup cols="3">
 397             <thead>
 398               <row>
 399                 <entry>Type name</entry>
 400                 <entry>Code</entry>
 401                 <entry>Description</entry>
 402               </row>
 403             </thead>
 404             <tbody>
 405               <row>
 406                 <entry>INVALID</entry>
 407                 <entry>0 (ASCII NUL)</entry>
 408                 <entry>Not a valid type code (error if it appears in a message)</entry>
 409               </row><row>
 410                 <entry>NIL</entry>
 411                 <entry>118 (ASCII 'v') </entry>
 412                 <entry>Marks a "void"/"unset"/"nonexistent"/"null" argument</entry>
 413               </row><row>
 414                 <entry>BYTE</entry>
 415                 <entry>121 (ASCII 'y')</entry>
 416                 <entry>8-bit unsigned integer</entry>
 417               </row><row>
 418                 <entry>BOOLEAN</entry>
 419                 <entry>98 (ASCII 'b')</entry>
 420                 <entry>Boolean value, 0 is FALSE and 1 is TRUE. Everything else is invalid.</entry>
 421               </row><row>
 422                 <entry>INT32</entry>
 423                 <entry>105 (ASCII 'i')</entry>
 424                 <entry>32-bit signed integer</entry>
 425               </row><row>
 426                 <entry>UINT32</entry>
 427                 <entry>117 (ASCII 'u')</entry>
 428                 <entry>32-bit unsigned integer</entry>
 429               </row><row>
 430                 <entry>INT64</entry>
 431                 <entry>120 (ASCII 'x')</entry>
 432                 <entry>64-bit signed integer</entry>
 433               </row><row>
 434                 <entry>UINT64</entry>
 435                 <entry>116 (ASCII 't')</entry>
 436                 <entry>64-bit unsigned integer</entry>
 437               </row><row>
 438                 <entry>DOUBLE</entry>
 439                 <entry>100 (ASCII 'd')</entry>
 440                 <entry>IEEE 754 double</entry>
 441               </row><row>
 442                 <entry>STRING</entry>
 443                 <entry>115 (ASCII 's')</entry>
 444                 <entry>UTF-8 string (<emphasis>must</emphasis> be valid UTF-8). Must be zero terminated. </entry>
 445               </row><row>
 446                 <entry>CUSTOM</entry>
 447                 <entry>99 (ASCII 'c')</entry>
 448                 <entry>A named byte array, used for custom types</entry>
 449               </row><row>
 450                 <entry>ARRAY</entry>
 451                 <entry>97 (ASCII 'a')</entry>
 452                 <entry>Array</entry>
 453               </row><row>
 454                 <entry>DICT</entry>
 455                 <entry>109 (ASCII 'm')</entry>
 456                 <entry>A dictionary of key/value pairs</entry>
 457               </row><row>
 458                 <entry>OBJECT_PATH</entry>
 459                 <entry>111 (ASCII 'o')</entry>
 460                 <entry>Name of an object</entry>
 461               </row>
 462             </tbody>
 463           </tgroup>
 464         </informaltable>
 465       </para>
 466       <para>
 467         The types are encoded as follows:
 468         <informaltable>
 469           <tgroup cols="2">
 470             <thead>
 471               <row>
 472                 <entry>Type name</entry>
 473                 <entry>Encoding</entry>
 474               </row>
 475             </thead>
 476             <tbody>
 477               <row>
 478                 <entry>INVALID</entry>
 479                 <entry>Not applicable; cannot be encoded.</entry>
 480               </row><row>
 481                 <entry>NIL</entry>
 482                 <entry>No data is encoded; the type code is followed immediately
 483                 by the type code of the next argument.</entry>
 484               </row><row>
 485                 <entry>BYTE</entry>
 486                 <entry>A byte.</entry>
 487               </row><row>
 488                 <entry>BOOLEAN</entry>
 489                 <entry>A byte, with valid values 0 and 1.</entry>
 490               </row><row>
 491                 <entry>INT32</entry>
 492                 <entry>32-bit signed integer in the message's byte order, aligned to 4-byte boundary.</entry>
 493               </row><row>
 494                 <entry>UINT32</entry>
 495                 <entry>32-bit unsigned integer in the message's byte order, aligned to 4-byte boundary.</entry>
 496               </row><row>
 497                 <entry>INT64</entry>
 498                 <entry>64-bit signed integer in the message's byte order, aligned to 8-byte boundary.</entry>
 499               </row><row>
 500                 <entry>UINT64</entry>
 501                 <entry>64-bit unsigned integer in the message's byte order, aligned to 8-byte boundary.</entry>
 502               </row><row>
 503                 <entry>DOUBLE</entry>
 504                 <entry>64-bit IEEE 754 double in the message's byte order, aligned to 8-byte boundary.</entry>
 505               </row><row>
 506                 <entry>STRING</entry>
 507                 <entry>UINT32 aligned to 4-byte boundary indicating the string's
 508                   length in bytes excluding its terminating nul, followed by
 509                   string data of the given length, followed by a terminating nul
 510                   byte.
 511                 </entry>
 512               </row><row>
 513                 <entry>CUSTOM</entry>
 514                 <entry>A string (encoded as the STRING type above) giving the
 515                   name of the type followed by an UINT32 aligned to 4-byte boundary
 516                   indicating the data length in bytes, followed by the data.
 517                   The string has some restrictions on its content, see
 518                   <xref linkend="message-protocol-names"/>.
 519                 </entry>
 520               </row><row>
 521                 <entry>ARRAY</entry>
 522                 <entry>A sequence of bytes giving the element type of the array, terminated
 523                 by a type different from ARRAY (just one byte for one-dimensional arrays, but
 524                 larger for multi-dimensional arrays), followed by an UINT32 (aligned to 4 bytes)
 525                 giving the length of the array data in bytes. This is followed by each array entry
 526                 encoded the way it would normally be encoded, except arrays, which are encoded
 527                 without the type information, since that is already declared above. Arrays containing
 528                 NIL are not allowed.
 529                 </entry>
 530               </row><row>
 531                 <entry>DICT</entry>
 532                 <entry>UINT32 giving the length of the dictionary data in bytes.
 533                 This is followed by a number of keyname/value pairs, where the
 534                 keyname is encoded as a STRING above, and the value is encoded
 535                 as a byte with typecode and how that type normally would be encoded
 536                 alone.
 537                 </entry>
 538               </row><row>
 539                 <entry>OBJECT_PATH</entry>
 540                 <entry>Encoded as if it were a STRING.
 541                 </entry>
 542               </row>
 543             </tbody>
 544           </tgroup>
 545         </informaltable>
 546       </para>
 547     </sect2>
 548
 549     <sect2 id="message-protocol-names">
 550       <title>Valid names</title>
 551       <para>
 552         The various names in D-BUS messages have some restrictions.
 553       </para>
 554       <sect3 id="message-protocol-names-interface">
 555         <title>Interface names</title>
 556         <para>
 557           Interfaces have names with type STRING, meaning that
 558           they must be valid UTF-8. However, there are also some
 559           additional restrictions that apply to interface names
 560           specifically:
 561           <itemizedlist>
 562             <listitem><para>They are composed of 1 or more elements separated by
 563                 a period ('.') character. All elements must contain at least
 564                 one character.
 565                 </para>
 566             </listitem>
 567             <listitem><para>Each element must only contain the ASCII characters
 568                 "[A-Z][a-z][0-9]_" and must not begin with a digit.
 569                 </para>
 570             </listitem>
 571
 572             <listitem><para>They must contain at least one '.' (period)
 573               character (and thus at least two elements).
 574               </para></listitem>
 575
 576             <listitem><para>They must not begin with a '.' (period) character.</para></listitem>
 577             <listitem><para>They must not exceed 256 bytes in length.</para></listitem>
 578             <listitem><para>They must be at least 1 byte in length.</para></listitem>
 579           </itemizedlist>
 580         </para>
 581       </sect3>
 582       <sect3 id="message-protocol-names-service">
 583         <title>Service names</title>
 584         <para>
 585           Service names have the same restrictions as interface names, with a
 586           special exception for base services. A base service name's first
 587           element must start with a colon (':') character. After the colon, any
 588           characters in the range "[A-Z][a-z][0-9]_" may appear. Elements after
 589           the first must follow the usual rules, except that they may start with
 590           a digit. Service names not starting with a colon have none of these
 591           exceptions and follow the same rules as interface names.
 592         </para>
 593       </sect3>
 594       <sect3 id="message-protocol-names-method">
 595         <title>Method names</title>
 596         <para>
 597           Method names:
 598           <itemizedlist>
 599             <listitem><para>Must only contain the ASCII characters
 600                 "[A-Z][a-z][0-9]_" and may not begin with a
 601                 digit.</para></listitem>
 602             <listitem><para>Must not contain the '.' (period) character</para></listitem>
 603             <listitem><para>Must not exceed 256 bytes in length</para></listitem>
 604             <listitem><para>Must be at least 1 byte in length</para></listitem>
 605           </itemizedlist>
 606         </para>
 607       </sect3>
 608       <sect3 id="message-protocol-names-path">
 609         <title>Path names</title>
 610         <para>
 611           A path (type OBJECT_PATH) must begin with an ASCII '/' (slash)
 612           character. Paths may not end with a slash character unless the path is
 613           the one-byte string "/". Two slash characters may not appear adjacent
 614           to one another (the empty string is not a valid "subdirectory"). Paths
 615           may not exceed 256 bytes in length.
 616         </para>
 617       </sect3>
 618       <sect3 id="message-protocol-names-error">
 619         <title>Error names</title>
 620         <para>
 621           Error names have the same restrictions as interface names.
 622         </para>
 623       </sect3>
 624       <sect3 id="message-protocol-names-custom">
 625         <title>Custom types</title>
 626         <para>
 627           Custom type names for values of type CUSTOM follow the same
 628           restrictions as interface names.
 629         </para>
 630       </sect3>
 631     </sect2>
 632
 633     <sect2 id="message-protocol-types">
 634       <title>Message types</title>
 635       <para>
 636         Each of the message types (METHOD_CALL, METHOD_RETURN, ERROR, and
 637         SIGNAL) has its own expected usage conventions and header fields.
 638       </para>
 639       <sect3 id="message-protocol-types-method">
 640         <title>Method Calls, Returns, and Errors</title>
 641         <para>
 642           Some messages invoke an operation on a remote object.  These are
 643           called method call messages and have the type tag METHOD_CALL. Such
 644           messages map naturally to methods on objects in a typical program.
 645         </para>
 646         <para>
 647           A method call message is expected to have a MEMBER header field
 648           indicating the name of the method. Optionally, the message has an
 649           INTERFACE field giving the interface the method is a part of. In the
 650           absence of an INTERFACE field, if two interfaces on the same object have
 651           a method with the same name, it is undefined which of the two methods
 652           will be invoked. Implementations may also choose to return an error in
 653           this ambiguous case. However, if a method name is unique
 654           implementations should not require an interface field.
 655         </para>
 656         <para>
 657           Method call messages also include a PATH field indicating the
 658           object to invoke the method on. If the call is passing through
 659           a message bus, the message will also have a SERVICE field giving
 660           the service to receive the message.
 661         </para>
 662         <para>
 663           When an application handles a method call message, it is expected to
 664           return a reply. The reply is identified by a REPLY_SERIAL header field
 665           indicating the serial number of the METHOD_CALL being replied to. The
 666           reply can have one of two types; either METHOD_RETURN or ERROR.
 667         </para>
 668         <para>
 669           If the reply has type METHOD_RETURN, the arguments to the reply message
 670           are the return value(s) or "out parameters" of the method call.
 671           If the reply has type ERROR, then an "exception" has been thrown,
 672           and the call fails; no return value will be provided. It makes
 673           no sense to send multiple replies to the same method call.
 674         </para>
 675         <para>
 676           Even if a method call has no return values, a METHOD_RETURN
 677           reply is expected, so the caller will know the method
 678           was successfully processed.
 679         </para>
 680         <para>
 681           The METHOD_RETURN or ERROR reply message MUST have the REPLY_SERIAL
 682           header field. If this field is missing, it should be treated as
 683           a corrupt message.
 684         </para>
 685         <para>
 686           If a METHOD_CALL message has the flag NO_REPLY_EXPECTED,
 687           then as an optimization the application receiving the method
 688           call may choose to omit the reply message (regardless of
 689           whether the reply would have been METHOD_RETURN or ERROR).
 690           However, it is also acceptable to ignore the NO_REPLY_EXPECTED
 691           flag and reply anyway.
 692         </para>
 693         <para>
 694           If a message has the flag AUTO_ACTIVATION, then the addressed
 695           service will be activated before the message is delivered, if
 696           not already active. The message will be held until the service
 697           is successfully activated or has failed to activate; in case
 698           of failure, an activation error will be returned.
 699         </para>
 700         <sect4 id="message-protocol-types-method-apis">
 701           <title>Mapping method calls to native APIs</title>
 702           <para>
 703             APIs for D-BUS may map method calls to a method call in a specific
 704             programming language, such as C++, or may map a method call written
 705             in an IDL to a D-BUS message.
 706           </para>
 707           <para>
 708             In APIs of this nature, arguments to a method are often termed "in"
 709             (which implies sent in the METHOD_CALL), or "out" (which implies
 710             returned in the METHOD_RETURN). Some APIs such as CORBA also have
 711             "inout" arguments, which are both sent and received, i.e. the caller
 712             passes in a value which is modified. Mapped to D-BUS, an "inout"
 713             argument is equivalent to an "in" argument, followed by an "out"
 714             argument. You can't pass things "by reference" over the wire, so
 715             "inout" is purely an illusion of the in-process API.
 716           </para>
 717           <para>
 718             Given a method with zero or one return values, followed by zero or more
 719             arguments, where each argument may be "in", "out", or "inout", the
 720             caller constructs a message by appending each "in" or "inout" argument,
 721             in order. "out" arguments are not represented in the caller's message.
 722           </para>
 723           <para>
 724             The recipient constructs a reply by appending first the return value
 725             if any, then each "out" or "inout" argument, in order.
 726             "in" arguments are not represented in the reply message.
 727           </para>
 728         </sect4>
 729
 730       </sect3>
 731
 732       <sect3 id="message-protocol-types-signal">
 733         <title>Signal Emission</title>
 734         <para>
 735           Unlike method calls, signal emissions have no replies.
 736           A signal emission is simply a single message of type SIGNAL.
 737           It must have three header fields: PATH giving the object
 738           the signal was emitted from, plus INTERFACE and MEMBER giving
 739           the fully-qualified name of the signal.
 740         </para>
 741       </sect3>
 742
 743       <sect3 id="message-protocol-types-notation">
 744         <title>Notation in this document</title>
 745         <para>
 746           This document uses a simple pseudo-IDL to describe particular method
 747           calls and signals. Here is an example of a method call:
 748           <programlisting>
 749             org.freedesktop.DBus.ActivateService (in STRING service_name, in UINT32 flags,
 750                                                   out UINT32 resultcode)
 751           </programlisting>
 752           This means INTERFACE = org.freedesktop.DBus, MEMBER = ActivateService,
 753           METHOD_CALL arguments are STRING and UINT32, METHOD_RETURN argument
 754           is UINT32. Remember that the MEMBER field can't contain any '.' (period)
 755           characters so it's known that the last part of the name in
 756           the "IDL" is the member name.
 757         </para>
 758         <para>
 759           In C++ that might end up looking like this:
 760           <programlisting>
 761             unsigned int org::freedesktop::DBus::ActivateService (const char  *service_name,
 762                                                                   unsigned int flags);
 763           </programlisting>
 764           or equally valid, the return value could be done as an argument:
 765           <programlisting>
 766             void org::freedesktop::DBus::ActivateService (const char   *service_name,
 767                                                           unsigned int  flags,
 768                                                           unsigned int *resultcode);
 769           </programlisting>
 770           It's really up to the API designer how they want to make
 771           this look. You could design an API where the namespace wasn't used
 772           in C++, using STL or Qt, using varargs, or whatever you wanted.
 773         </para>
 774         <para>
 775           Signals are written as follows:
 776           <programlisting>
 777             org.freedesktop.DBus.ServiceLost (STRING service_name)
 778           </programlisting>
 779           Signals don't specify "in" vs. "out" because only
 780           a single direction is possible.
 781         </para>
 782         <para>
 783           In this ad hoc notation, the special type name ANY means any type
 784           other than NIL, and the special type name ANY_OR_NIL means any valid
 785           type.
 786         </para>
 787         <para>
 788           It isn't especially encouraged to use this lame pseudo-IDL in actual
 789           API implementations; you might use the native notation for the
 790           language you're using, or you might use COM or CORBA IDL, for example.
 791         </para>
 792       </sect3>
 793     </sect2>
 794
 795   </sect1>
 796
 797   <sect1 id="auth-protocol">
 798     <title>Authentication Protocol</title>
 799     <para>
 800       Before the flow of messages begins, two applications must
 801       authenticate. A simple plain-text protocol is used for
 802       authentication; this protocol is a SASL profile, and maps fairly
 803       directly from the SASL specification. The message encoding is
 804       NOT used here, only plain text messages.
 805     </para>
 806     <para>
 807       In examples, "C:" and "S:" indicate lines sent by the client and
 808       server respectively.
 809     </para>
 810     <sect2 id="auth-protocol-overview">
 811       <title>Protocol Overview</title>
 812       <para>
 813         The protocol is a line-based protocol, where each line ends with
 814         \r\n. Each line begins with an all-caps ASCII command name containing
 815         only the character range [A-Z], a space, then any arguments for the
 816         command, then the \r\n ending the line. The protocol is
 817         case-sensitive. All bytes must be in the ASCII character set.
 818
 819         Commands from the client to the server are as follows:
 820
 821         <itemizedlist>
 822           <listitem><para>AUTH [mechanism] [initial-response]</para></listitem>
 823           <listitem><para>CANCEL</para></listitem>
 824           <listitem><para>BEGIN</para></listitem>
 825           <listitem><para>DATA &lt;data in base 64 encoding&gt;</para></listitem>
 826           <listitem><para>ERROR [human-readable error explanation]</para></listitem>
 827         </itemizedlist>
 828
 829         From server to client are as follows:
 830
 831         <itemizedlist>
 832           <listitem><para>REJECTED &lt;space-separated list of mechanism names&gt;</para></listitem>
 833           <listitem><para>OK</para></listitem>
 834           <listitem><para>DATA &lt;data in base 64 encoding&gt;</para></listitem>
 835           <listitem><para>ERROR</para></listitem>
 836         </itemizedlist>
 837       </para>
 838     </sect2>
 839     <sect2 id="auth-nul-byte">
 840       <title>Special credentials-passing nul byte</title>
 841       <para>
 842         Immediately after connecting to the server, the client must send a
 843         single nul byte. This byte may be accompanied by credentials
 844         information on some operating systems that use sendmsg() with
 845         SCM_CREDS or SCM_CREDENTIALS to pass credentials over UNIX domain
 846         sockets. However, the nul byte MUST be sent even on other kinds of
 847         socket, and even on operating systems that do not require a byte to be
 848         sent in order to transmit credentials. The text protocol described in
 849         this document begins after the single nul byte. If the first byte
 850         received from the client is not a nul byte, the server may disconnect
 851         that client.
 852       </para>
 853       <para>
 854         A nul byte in any context other than the initial byte is an error;
 855         the protocol is ASCII-only.
 856       </para>
 857       <para>
 858         The credentials sent along with the nul byte may be used with the
 859         SASL mechanism EXTERNAL.
 860       </para>
 861     </sect2>
 862     <sect2 id="auth-command-auth">
 863       <title>AUTH command</title>
 864       <para>
 865         If an AUTH command has no arguments, it is a request to list
 866         available mechanisms. The server SHOULD respond with a REJECTED
 867         command listing the mechanisms it understands.
 868       </para>
 869       <para>
 870         If an AUTH command specifies a mechanism, and the server supports
 871         said mechanism, the server SHOULD begin exchanging SASL
 872         challenge-response data with the client using DATA commands.
 873       </para>
 874       <para>
 875         If the server does not support the mechanism given in the AUTH
 876         command, it SHOULD send a REJECTED command listing the mechanisms
 877         it does support.
 878       </para>
 879       <para>
 880         If the [initial-response] argument is provided, it is intended for
 881         use with mechanisms that have no initial challenge (or an empty
 882         initial challenge), as if it were the argument to an initial DATA
 883         command. If the selected mechanism has an initial challenge, the
 884         server should reject authentication by sending REJECTED.
 885       </para>
 886       <para>
 887         If authentication succeeds after exchanging DATA commands,
 888         an OK command should be sent to the client.
 889       </para>
 890       <para>
 891         The first octet received by the client after the \r\n of the OK
 892         command MUST be the first octet of the authenticated/encrypted
 893         stream of D-BUS messages.
 894       </para>
 895       <para>
 896         The first octet received by the server after the \r\n of the BEGIN
 897         command from the client MUST be the first octet of the
 898         authenticated/encrypted stream of D-BUS messages.
 899       </para>
 900     </sect2>
 901     <sect2 id="auth-command-cancel">
 902       <title>CANCEL Command</title>
 903       <para>
 904         At any time up to sending the BEGIN command, the client may send a
 905         CANCEL command. On receiving the CANCEL command, the server MUST
 906         send a REJECTED command and abort the current authentication
 907         exchange.
 908       </para>
 909     </sect2>
 910     <sect2 id="auth-command-data">
 911       <title>DATA Command</title>
 912       <para>
 913         The DATA command may come from either client or server, and simply
 914         contains a base64-encoded block of data to be interpreted
 915         according to the SASL mechanism in use.
 916       </para>
 917       <para>
 918         Some SASL mechanisms support sending an "empty string";
 919         FIXME we need some way to do this.
 920       </para>
 921     </sect2>
 922     <sect2 id="auth-command-begin">
 923       <title>BEGIN Command</title>
 924       <para>
 925         The BEGIN command acknowledges that the client has received an
 926         OK command from the server, and that the stream of messages
 927         is about to begin.
 928       </para>
 929       <para>
 930         The first octet received by the server after the \r\n of the BEGIN
 931         command from the client MUST be the first octet of the
 932         authenticated/encrypted stream of D-BUS messages.
 933       </para>
 934     </sect2>
 935     <sect2 id="auth-command-rejected">
 936       <title>REJECTED Command</title>
 937       <para>
 938         The REJECTED command indicates that the current authentication
 939         exchange has failed, and further exchange of DATA is inappropriate.
 940         The client would normally try another mechanism, or try providing
 941         different responses to challenges.
 942       </para><para>
 943         Optionally, the REJECTED command has a space-separated list of
 944         available auth mechanisms as arguments. If a server ever provides
 945         a list of supported mechanisms, it MUST provide the same list
 946         each time it sends a REJECTED message. Clients are free to
 947         ignore all lists received after the first.
 948       </para>
 949     </sect2>
 950     <sect2 id="auth-command-ok">
 951       <title>OK Command</title>
 952       <para>
 953         The OK command indicates that the client has been authenticated,
 954         and that further communication will be a stream of D-BUS messages
 955         (optionally encrypted, as negotiated) rather than this protocol.
 956       </para>
 957       <para>
 958         The first octet received by the client after the \r\n of the OK
 959         command MUST be the first octet of the authenticated/encrypted
 960         stream of D-BUS messages.
 961       </para>
 962       <para>
 963         The client MUST respond to the OK command by sending a BEGIN
 964         command, followed by its stream of messages, or by disconnecting.
 965         The server MUST NOT accept additional commands using this protocol
 966         after the OK command has been sent.
 967       </para>
 968     </sect2>
 969     <sect2 id="auth-command-error">
 970       <title>ERROR Command</title>
 971       <para>
 972         The ERROR command indicates that either server or client did not
 973         know a command, does not accept the given command in the current
 974         context, or did not understand the arguments to the command. This
 975         allows the protocol to be extended; a client or server can send a
 976         command present or permitted only in new protocol versions, and if
 977         an ERROR is received instead of an appropriate response, fall back
 978         to using some other technique.
 979       </para>
 980       <para>
 981         If an ERROR is sent, the server or client that sent the
 982         error MUST continue as if the command causing the ERROR had never been
 983         received. However, the the server or client receiving the error
 984         should try something other than whatever caused the error;
 985         if only canceling/rejecting the authentication.
 986       </para>
 987     </sect2>
 988     <sect2 id="auth-examples">
 989       <title>Authentication examples</title>
 990
 991       <para>
 992         <figure>
 993           <title>Example of successful magic cookie authentication</title>
 994           <programlisting>
 995             (MAGIC_COOKIE is a made up mechanism)
 996
 997             C: AUTH MAGIC_COOKIE BsAY3g4gBNo=
 998             S: OK
 999             C: BEGIN
1000           </programlisting>
1001         </figure>
1002         <figure>
1003           <title>Example of finding out mechanisms then picking one</title>
1004           <programlisting>
1005             C: AUTH
1006             S: REJECTED KERBEROS_V4 SKEY
1007             C: AUTH SKEY bW9yZ2Fu
1008             S: DATA OTUgUWE1ODMwOA==
1009             C: DATA Rk9VUiBNQU5OIFNPT04gRklSIFZBUlkgTUFTSA==
1010             S: OK
1011             C: BEGIN
1012           </programlisting>
1013         </figure>
1014         <figure>
1015           <title>Example of client sends unknown command then falls back to regular auth</title>
1016           <programlisting>
1017             C: FOOBAR
1018             S: ERROR
1019             C: AUTH MAGIC_COOKIE BsAY3g4gBNo=
1020             S: OK
1021             C: BEGIN
1022           </programlisting>
1023         </figure>
1024         <figure>
1025           <title>Example of server doesn't support initial auth mechanism</title>
1026           <programlisting>
1027             C: AUTH MAGIC_COOKIE BsAY3g4gBNo=
1028             S: REJECTED KERBEROS_V4 SKEY
1029             C: AUTH SKEY bW9yZ2Fu
1030             S: DATA OTUgUWE1ODMwOA==
1031             C: DATA Rk9VUiBNQU5OIFNPT04gRklSIFZBUlkgTUFTSA==
1032             S: OK
1033             C: BEGIN
1034           </programlisting>
1035         </figure>
1036         <figure>
1037           <title>Example of wrong password or the like followed by successful retry</title>
1038           <programlisting>
1039             C: AUTH MAGIC_COOKIE BsAY3g4gBNo=
1040             S: REJECTED KERBEROS_V4 SKEY
1041             C: AUTH SKEY bW9yZ2Fu
1042             S: DATA OTUgUWE1ODMwOA==
1043             C: DATA Rk9VUiBNQU5OIFNPT04gRklSIFZBUlkgTUFTSA==
1044             S: REJECTED
1045             C: AUTH SKEY bW9yZ2Fu
1046             S: DATA OTUgUWE1ODMwOA==
1047             C: DATA Rk9VUiBNQU5OIFNPT04gRklSIFZBUlkgTUFTSA==
1048             S: OK
1049             C: BEGIN
1050           </programlisting>
1051         </figure>
1052         <figure>
1053           <title>Example of skey cancelled and restarted</title>
1054           <programlisting>
1055             C: AUTH MAGIC_COOKIE BsAY3g4gBNo=
1056             S: REJECTED KERBEROS_V4 SKEY
1057             C: AUTH SKEY bW9yZ2Fu
1058             S: DATA OTUgUWE1ODMwOA==
1059             C: CANCEL
1060             S: REJECTED
1061             C: AUTH SKEY bW9yZ2Fu
1062             S: DATA OTUgUWE1ODMwOA==
1063             C: DATA Rk9VUiBNQU5OIFNPT04gRklSIFZBUlkgTUFTSA==
1064             S: OK
1065             C: BEGIN
1066           </programlisting>
1067         </figure>
1068       </para>
1069     </sect2>
1070     <sect2 id="auth-states">
1071       <title>Authentication state diagrams</title>
1072
1073       <para>
1074         This section documents the auth protocol in terms of
1075         a state machine for the client and the server. This is
1076         probably the most robust way to implement the protocol.
1077       </para>
1078
1079       <sect3 id="auth-states-client">
1080         <title>Client states</title>
1081
1082         <formalpara>
1083           <title><emphasis>Start</emphasis></title>
1084           <para>
1085             <itemizedlist>
1086               <listitem><para>send AUTH with initial data -&gt; <emphasis>WaitingForData</emphasis></para></listitem>
1087               <listitem><para>send AUTH with no initial data -&gt; <emphasis>WaitingForData</emphasis> or <emphasis>NeedSendData</emphasis> (depends on mechanism)</para></listitem>
1088             </itemizedlist>
1089             The <emphasis>Start</emphasis> state is stateful (it has a list of
1090             available mechanisms and those it has already attempted). This list
1091             is used to decide which AUTH command to send. When the list is
1092             exhausted, the client should give up and close the connection.
1093           </para>
1094         </formalpara>
1095
1096         <formalpara>
1097           <title><emphasis>WaitingForData</emphasis></title>
1098           <para>
1099
1100             <itemizedlist>
1101               <listitem><para>receive OK -&gt; <emphasis>NeedSendBegin</emphasis></para></listitem>
1102               <listitem><para>receive REJECTED -&gt; <emphasis>Start</emphasis></para></listitem>
1103               <listitem><para>receive ERROR -&gt; <emphasis>Start</emphasis></para></listitem>
1104               <listitem><para>receive DATA -&gt; <emphasis>NeedSendData</emphasis></para></listitem>
1105               <listitem><para>receive anything else -&gt; <emphasis>NeedSendError</emphasis></para></listitem>
1106             </itemizedlist>
1107             When going back to <emphasis>Start</emphasis>, the mechanism in
1108             progress should be marked as failed and not retried (at least not
1109             with the same parameters). When receiving REJECTED with a list of
1110             mechanisms, the list should be recorded and used to select
1111             a mechanism.
1112           </para>
1113         </formalpara>
1114
1115         <formalpara>
1116           <title><emphasis>NeedSendData</emphasis></title>
1117           <para>
1118             <itemizedlist>
1119               <listitem><para>send DATA -&gt; <emphasis>WaitingForData</emphasis></para></listitem>
1120               <listitem><para>send CANCEL -&gt; <emphasis>Start</emphasis></para></listitem>
1121             </itemizedlist>
1122           </para>
1123         </formalpara>
1124
1125         <formalpara>
1126           <title><emphasis>NeedSendError</emphasis></title>
1127           <para>
1128
1129             <itemizedlist>
1130               <listitem><para>send ERROR -&gt; return to previous state</para></listitem>
1131             </itemizedlist>
1132           </para>
1133         </formalpara>
1134
1135         <formalpara>
1136           <title><emphasis>NeedSendBegin</emphasis></title>
1137           <para>
1138
1139             <itemizedlist>
1140               <listitem><para>send BEGIN -&gt; Authorized</para></listitem>
1141             </itemizedlist>
1142           </para>
1143         </formalpara>
1144
1145         <formalpara>
1146           <title><emphasis>Authorized</emphasis></title>
1147           <para>
1148             This is the end state, flow of messages begins.
1149           </para>
1150         </formalpara>
1151
1152       </sect3>
1153
1154       <sect3 id="auth-states-server">
1155         <title>Server states</title>
1156
1157         <formalpara>
1158           <title><emphasis>WaitingForAuth</emphasis></title>
1159           <para>
1160             <itemizedlist>
1161               <listitem><para>receive AUTH with initial response -&gt; <emphasis>NeedSendData</emphasis></para></listitem>
1162               <listitem><para>receive AUTH without initial response -&gt; <emphasis>NeedSendData</emphasis> or <emphasis>WaitingForData</emphasis> depending on mechanism</para></listitem>
1163             </itemizedlist>
1164           </para>
1165         </formalpara>
1166
1167         <formalpara>
1168           <title><emphasis>NeedSendData</emphasis></title>
1169           <para>
1170             <itemizedlist>
1171               <listitem><para>send DATA -&gt; <emphasis>WaitingForData</emphasis></para></listitem>
1172               <listitem><para>send ERROR -&gt; <emphasis>WaitingForData</emphasis></para></listitem>
1173               <listitem><para>send REJECTED -&gt; <emphasis>WaitingForAuth</emphasis></para></listitem>
1174               <listitem><para>send OK -&gt; <emphasis>WaitingForBegin</emphasis></para></listitem>
1175             </itemizedlist>
1176           </para>
1177         </formalpara>
1178
1179         <formalpara>
1180           <title><emphasis>WaitingForData</emphasis></title>
1181           <para>
1182             <itemizedlist>
1183               <listitem><para>receive DATA -&gt; <emphasis>NeedSendData</emphasis></para></listitem>
1184               <listitem><para>receive CANCEL -&gt; <emphasis>NeedSendRejected</emphasis></para></listitem>
1185               <listitem><para>receive ERROR -&gt; <emphasis>NeedSendRejected</emphasis></para></listitem>
1186               <listitem><para>receive anything else -&gt; <emphasis>NeedSendError</emphasis></para></listitem>
1187             </itemizedlist>
1188           </para>
1189         </formalpara>
1190
1191         <formalpara>
1192           <title><emphasis>NeedSendError</emphasis></title>
1193           <para>
1194
1195             <itemizedlist>
1196               <listitem><para>send ERROR -&gt; return to previous state</para></listitem>
1197             </itemizedlist>
1198           </para>
1199         </formalpara>
1200
1201         <formalpara>
1202           <title><emphasis>NeedSendRejected</emphasis></title>
1203           <para>
1204
1205             <itemizedlist>
1206               <listitem><para>send REJECTED -&gt; <emphasis>WaitingForAuth</emphasis></para></listitem>
1207             </itemizedlist>
1208           </para>
1209         </formalpara>
1210
1211         <formalpara>
1212           <title><emphasis>WaitingForBegin</emphasis></title>
1213           <para>
1214
1215             <itemizedlist>
1216               <listitem><para>receive BEGIN -&gt; <emphasis>Authorized</emphasis></para></listitem>
1217               <listitem><para>receive anything else -&gt; <emphasis>NeedSendError</emphasis></para></listitem>
1218             </itemizedlist>
1219           </para>
1220         </formalpara>
1221
1222         <formalpara>
1223           <title><emphasis>Authorized</emphasis></title>
1224           <para>
1225             This is the end state, flow of messages begins.
1226           </para>
1227         </formalpara>
1228
1229       </sect3>
1230
1231     </sect2>
1232     <sect2 id="auth-mechanisms">
1233       <title>Authentication mechanisms</title>
1234       <para>
1235         This section describes some new authentication mechanisms.
1236         D-BUS also allows any standard SASL mechanism of course.
1237       </para>
1238       <sect3 id="auth-mechanisms-sha">
1239         <title>DBUS_COOKIE_SHA1</title>
1240         <para>
1241           The DBUS_COOKIE_SHA1 mechanism is designed to establish that a client
1242           has the ability to read a private file owned by the user being
1243           authenticated. If the client can prove that it has access to a secret
1244           cookie stored in this file, then the client is authenticated.
1245           Thus the security of DBUS_COOKIE_SHA1 depends on a secure home
1246           directory.
1247         </para>
1248         <para>
1249           Authentication proceeds as follows:
1250           <itemizedlist>
1251             <listitem>
1252               <para>
1253                 The client sends the username it would like to authenticate
1254                 as.
1255               </para>
1256             </listitem>
1257             <listitem>
1258               <para>
1259                 The server sends the name of its "cookie context" (see below); a
1260                 space character; the integer ID of the secret cookie the client
1261                 must demonstrate knowledge of; a space character; then a
1262                 hex-encoded randomly-generated challenge string.
1263               </para>
1264             </listitem>
1265             <listitem>
1266               <para>
1267                 The client locates the cookie, and generates its own hex-encoded
1268                 randomly-generated challenge string.  The client then
1269                 concatentates the server's hex-encoded challenge, a ":"
1270                 character, its own hex-encoded challenge, another ":" character,
1271                 and the hex-encoded cookie.  It computes the SHA-1 hash of this
1272                 composite string.  It sends back to the server the client's
1273                 hex-encoded challenge string, a space character, and the SHA-1
1274                 hash.
1275               </para>
1276             </listitem>
1277             <listitem>
1278               <para>
1279                 The server generates the same concatenated string used by the
1280                 client and computes its SHA-1 hash. It compares the hash with
1281                 the hash received from the client; if the two hashes match, the
1282                 client is authenticated.
1283               </para>
1284             </listitem>
1285           </itemizedlist>
1286         </para>
1287         <para>
1288           Each server has a "cookie context," which is a name that identifies a
1289           set of cookies that apply to that server. A sample context might be
1290           "org_freedesktop_session_bus". Context names must be valid ASCII,
1291           nonzero length, and may not contain the characters slash ("/"),
1292           backslash ("\"), space (" "), newline ("\n"), carriage return ("\r"),
1293           tab ("\t"), or period ("."). There is a default context,
1294           "org_freedesktop_global" that's used by servers that do not specify
1295           otherwise.
1296         </para>
1297         <para>
1298           Cookies are stored in a user's home directory, in the directory
1299           <filename>~/.dbus-keyrings/</filename>. This directory must
1300           not be readable or writable by other users. If it is,
1301           clients and servers must ignore it. The directory
1302           contains cookie files named after the cookie context.
1303         </para>
1304         <para>
1305           A cookie file contains one cookie per line. Each line
1306           has three space-separated fields:
1307           <itemizedlist>
1308             <listitem>
1309               <para>
1310                 The cookie ID number, which must be a non-negative integer and
1311                 may not be used twice in the same file.
1312               </para>
1313             </listitem>
1314             <listitem>
1315               <para>
1316                 The cookie's creation time, in UNIX seconds-since-the-epoch
1317                 format.
1318               </para>
1319             </listitem>
1320             <listitem>
1321               <para>
1322                 The cookie itself, a hex-encoded random block of bytes.
1323               </para>
1324             </listitem>
1325           </itemizedlist>
1326         </para>
1327         <para>
1328           Only server processes modify the cookie file.
1329           They must do so with this procedure:
1330           <itemizedlist>
1331             <listitem>
1332               <para>
1333                 Create a lockfile name by appending ".lock" to the name of the
1334                 cookie file.  The server should attempt to create this file
1335                 using <literal>O_CREAT | O_EXCL</literal>.  If file creation
1336                 fails, the lock fails. Servers should retry for a reasonable
1337                 period of time, then they may choose to delete an existing lock
1338                 to keep users from having to manually delete a stale
1339                 lock. <footnote><para>Lockfiles are used instead of real file
1340                 locking <literal>fcntl()</literal> because real locking
1341                 implementations are still flaky on network
1342                 filesystems.</para></footnote>
1343               </para>
1344             </listitem>
1345             <listitem>
1346               <para>
1347                 Once the lockfile has been created, the server loads the cookie
1348                 file. It should then delete any cookies that are old (the
1349                 timeout can be fairly short), or more than a reasonable
1350                 time in the future (so that cookies never accidentally
1351                 become permanent, if the clock was set far into the future
1352                 at some point). If no recent keys remain, the
1353                 server may generate a new key.
1354               </para>
1355             </listitem>
1356             <listitem>
1357               <para>
1358                 The pruned and possibly added-to cookie file
1359                 must be resaved atomically (using a temporary
1360                 file which is rename()'d).
1361               </para>
1362             </listitem>
1363             <listitem>
1364               <para>
1365                 The lock must be dropped by deleting the lockfile.
1366               </para>
1367             </listitem>
1368           </itemizedlist>
1369         </para>
1370         <para>
1371           Clients need not lock the file in order to load it,
1372           because servers are required to save the file atomically.
1373         </para>
1374       </sect3>
1375     </sect2>
1376   </sect1>
1377   <sect1 id="addresses">
1378     <title>Server Addresses</title>
1379     <para>
1380       Server addresses consist of a transport name followed by a colon, and
1381       then an optional, comma-separated list of keys and values in the form key=value.
1382       [FIXME how do you escape colon, comma, and semicolon in the values of the key=value pairs?]
1383     </para>
1384     <para>
1385       For example:
1386       <programlisting>unix:path=/tmp/dbus-test</programlisting>
1387       Which is the address to a unix socket with the path /tmp/dbus-test.
1388     </para>
1389     <para>
1390       [FIXME clarify if attempting to connect to each is a requirement
1391       or just a suggestion]
1392       When connecting to a server, multiple server addresses can be
1393       separated by a semi-colon. The library will then try to connect
1394       to the first address and if that fails, it'll try to connect to
1395       the next one specified, and so forth. For example
1396       <programlisting>unix:path=/tmp/dbus-test;unix:path=/tmp/dbus-test2</programlisting>
1397     </para>
1398     <para>
1399       [FIXME we need to specify in detail each transport and its possible arguments]
1400       Current transports include: unix domain sockets (including
1401       abstract namespace on linux), TCP/IP, and a debug/testing transport using
1402       in-process pipes. Future possible transports include one that
1403       tunnels over X11 protocol.
1404     </para>
1405   </sect1>
1406
1407   <sect1 id="standard-messages">
1408     <title>Standard Peer-to-Peer Messages</title>
1409     <para>
1410       See <xref linkend="message-protocol-types-notation"/> for details on
1411        the notation used in this section.
1412     </para>
1413     <sect2 id="standard-messages-ping">
1414       <title><literal>org.freedesktop.Peer.Ping</literal></title>
1415       <para>
1416         <programlisting>
1417           org.freedesktop.Peer.Ping ()
1418         </programlisting>
1419       </para>
1420       <para>
1421         On receipt of the METHOD_CALL
1422         message <literal>org.freedesktop.Peer.Ping</literal>, an application
1423         should do nothing other than reply with a METHOD_RETURN as usual.
1424       </para>
1425     </sect2>
1426
1427     <sect2 id="standard-messages-get-props">
1428       <title><literal>org.freedesktop.Props.Get</literal></title>
1429       <para>
1430         [FIXME this is just a bogus made-up method that isn't implemented
1431         or thought through, to save an example of table formatting for the
1432         argument descriptions]
1433         <programlisting>
1434           org.freedesktop.Props.Get (in STRING property_name,
1435                                      out ANY_OR_NIL property_value)
1436         </programlisting>
1437         Message arguments:
1438         <informaltable>
1439           <tgroup cols="3">
1440             <thead>
1441               <row>
1442                 <entry>Argument</entry>
1443                 <entry>Type</entry>
1444                 <entry>Description</entry>
1445               </row>
1446             </thead>
1447             <tbody>
1448               <row>
1449                 <entry>0</entry>
1450                 <entry>in STRING</entry>
1451                 <entry>Name of the property to get</entry>
1452               </row>
1453               <row>
1454                 <entry>1</entry>
1455                 <entry>out ANY_OR_NIL</entry>
1456                 <entry>The value of the property. The type depends on the property.</entry>
1457               </row>
1458             </tbody>
1459           </tgroup>
1460         </informaltable>
1461       </para>
1462     </sect2>
1463   </sect1>
1464
1465   <sect1 id="message-bus">
1466     <title>Message Bus Specification</title>
1467     <sect2 id="message-bus-overview">
1468       <title>Message Bus Overview</title>
1469       <para>
1470         The message bus accepts connections from one or more applications.
1471         Once connected, applications can send and receive messages from
1472         the message bus, as in the peer-to-peer case.
1473       </para>
1474       <para>
1475         The message bus keeps track of a set of
1476         <firstterm>services</firstterm>. A service is simply a name, such as
1477         <literal>com.yoyodyne.Screensaver</literal>, which can be
1478         <firstterm>owned</firstterm> by one or more of the connected
1479         applications.  The message bus itself always owns the special service
1480         <literal>org.freedesktop.DBus</literal>.
1481       </para>
1482       <para>
1483         Services may have <firstterm>secondary owners</firstterm>. Secondary owners
1484         of a service are kept in a queue; if the primary owner of a service
1485         disconnects, or releases the service, the next secondary owner becomes
1486         the new owner of the service.
1487       </para>
1488       <para>
1489         Messages may have a <literal>SERVICE</literal> field (see <xref
1490                                                                   linkend="message-protocol-header-fields"/>).  When the message bus
1491           receives a message, if the <literal>SERVICE</literal> field is absent, the
1492           message is taken to be a standard peer-to-peer message and interpreted
1493           by the message bus itself. For example, sending
1494           an <literal>org.freedesktop.Peer.Ping</literal> message with no
1495           <literal>SERVICE</literal> will cause the message bus itself to reply
1496           to the ping immediately; the message bus would never make
1497           this message visible to other applications.
1498       </para>
1499       <para>
1500         If the <literal>SERVICE</literal> field is present, then it indicates a
1501         request for the message bus to route the message. In the usual case,
1502         messages are routed to the owner of the named service.
1503         Messages may also be <firstterm>broadcast</firstterm>
1504         by sending them to the special service
1505         <literal>org.freedesktop.DBus.Broadcast</literal>. Broadcast messages are
1506         sent to all applications with <firstterm>message matching
1507           rules</firstterm> that match the message.
1508       </para>
1509       <para>
1510         Continuing the <literal>org.freedesktop.Peer.Ping</literal> example, if
1511         the ping message were sent with a <literal>SERVICE</literal> name of
1512         <literal>com.yoyodyne.Screensaver</literal>, then the ping would be
1513         forwarded, and the Yoyodyne Corporation screensaver application would be
1514         expected to reply to the ping. If
1515         <literal>org.freedesktop.Peer.Ping</literal> were sent to
1516         <literal>org.freedesktop.DBus.Broadcast</literal>, then multiple applications
1517         might receive the ping, and all would normally reply to it.
1518       </para>
1519     </sect2>
1520
1521     <sect2 id="message-bus-services">
1522       <title>Message Bus Services</title>
1523       <para>
1524         A service is a name that identifies a certain application. Each
1525         application connected to the message bus has at least one service name
1526         assigned at connection time and returned in response to the
1527         <literal>org.freedesktop.DBus.Hello</literal> message.
1528         This automatically-assigned service name is called
1529         the application's <firstterm>base service</firstterm>.
1530         Base service names are unique and MUST never be reused for two different
1531         applications.
1532       </para>
1533       <para>
1534         Ownership of the base service is a prerequisite for interaction with
1535         the message bus. It logically follows that the base service is always
1536         the first service that an application comes to own, and the last
1537         service that it loses ownership of.
1538       </para>
1539       <para>
1540         Base service names must begin with the character ':' (ASCII colon
1541         character); service names that are not base service names must not begin
1542         with this character. (The bus must reject any attempt by an application
1543         to manually create a service name beginning with ':'.) This restriction
1544         categorically prevents "spoofing"; messages sent to a base service name
1545         will always go to a single application instance and that instance only.
1546       </para>
1547       <para>
1548         An application can request additional service names to be associated
1549         with it using the
1550         <literal>org.freedesktop.DBus.AcquireService</literal>
1551         message. [FIXME what service names are allowed; ASCII or unicode;
1552         length limit; etc.]
1553       </para>
1554       <para>
1555         [FIXME this needs more detail, and should move the service-related message
1556         descriptions up into this section perhaps]
1557         Service ownership handling can be specified in the flags part
1558         of the <literal>org.freedesktop.DBus.AcquireService</literal>
1559         message. If an application specifies the
1560         DBUS_SERVICE_FLAGS_PROHIBIT_REPLACEMENT flag, then all applications
1561         trying to acquire the service will be put in a queue. When the
1562         primary owner disconnects from the bus or removes ownership
1563         from the service, the next application in the queue will be the
1564         primary owner. If the DBUS_SERVICE_FLAGS_PROHIBIT_REPLACEMENT
1565         flag is not specified, then the primary owner will lose
1566         ownership whenever another application requests ownership of the
1567         service.
1568       </para>
1569       <para>
1570         When a client disconnects from the bus, all the services that
1571         the clients own are deleted, or in the case of a service that
1572         prohibits replacement, ownership is transferred to the next
1573         client in the queue, if any.
1574       </para>
1575     </sect2>
1576     <sect2 id="message-bus-routing">
1577       <title>Message Bus Message Routing</title>
1578       <para>
1579         When a message is received by the message bus, the message's
1580         <literal>sndr</literal> header field MUST be set to the base service of
1581         the application which sent the message.  If the service already has
1582         a <literal>sndr</literal> field, the pre-existing field is replaced.
1583         This rule means that a replies are always sent to the base service name,
1584         i.e. to the same application that sent the message being replied to.
1585       </para>
1586       <para>
1587         [FIXME go into detail about broadcast, multicast, unicast, etc.]
1588       </para>
1589     </sect2>
1590     <sect2 id="message-bus-activation">
1591       <title>Message Bus Service Activation</title>
1592       <para>
1593         <firstterm>Activation</firstterm> means to locate a service
1594         owner for a service that is currently unowned. For now, it
1595         means to launch an executable that will take ownership of
1596         a particular service.
1597       </para>
1598       <para>
1599         To find an executable corresponding to a particular service, the bus
1600         daemon looks for <firstterm>service description files</firstterm>.
1601         Service description files define a mapping from service names to
1602         executables. Different kinds of message bus will look for these files
1603         in different places, see <xref linkend="message-bus-types"/>.
1604       </para>
1605       <para>
1606         [FIXME the file format should be much better specified than
1607         "similar to .desktop entries" esp. since desktop entries are
1608         already badly-specified. ;-)] Service description files have
1609         the ".service" file extension. The message bus will only load
1610         service description files ending with .service; all other
1611         files will be ignored.  The file format is similar to that of
1612         <ulink
1613         url="http://www.freedesktop.org/standards/desktop-entry-spec/desktop-entry-spec.html">desktop
1614         entries</ulink>. All service description files must be in
1615         UTF-8 encoding. To ensure that there will be no name
1616         collisions, service files must be namespaced using the same
1617         mechanism as messages and service names.
1618
1619         <figure>
1620           <title>Example service description file</title>
1621           <programlisting>
1622             # Sample service description file
1623             [D-BUS Service]
1624             Name=org.gnome.ConfigurationDatabase
1625             Exec=/usr/libexec/gconfd-2
1626           </programlisting>
1627         </figure>
1628       </para>
1629       <para>
1630         When an application requests a service to be activated, the
1631         bus daemon tries to find it in the list of activation
1632         entries. It then tries to spawn the executable associated with
1633         it. If this fails, it will report an error. [FIXME what
1634         happens if two .service files offer the same service; what
1635         kind of error is reported, should we have a way for the client
1636         to choose one?]
1637       </para>
1638       <para>
1639         The executable launched will have the environment variable
1640         <literal>DBUS_ACTIVATION_ADDRESS</literal> set to the address of the
1641         message bus so it can connect and register the appropriate services.
1642       </para>
1643       <para>
1644         The executable being launched may want to know whether the message bus
1645         activating it is one of the well-known message buses (see <xref
1646         linkend="message-bus-types"/>). To facilitate this, the bus MUST also set
1647         the <literal>DBUS_ACTIVATION_BUS_TYPE</literal> environment variable if it is one
1648         of the well-known buses. The currently-defined values for this variable
1649         are <literal>system</literal> for the systemwide message bus,
1650         and <literal>session</literal> for the per-login-session message
1651         bus. The activated executable must still connect to the address given
1652         in <literal>DBUS_ACTIVATION_ADDRESS</literal>, but may assume that the
1653         resulting connection is to the well-known bus.
1654       </para>
1655       <para>
1656         [FIXME there should be a timeout somewhere, either specified
1657         in the .service file, by the client, or just a global value
1658         and if the client being activated fails to connect within that
1659         timeout, an error should be sent back.]
1660       </para>
1661     </sect2>
1662
1663     <sect2 id="message-bus-types">
1664       <title>Well-known Message Bus Instances</title>
1665       <para>
1666         Two standard message bus instances are defined here, along with how
1667         to locate them and where their service files live.
1668       </para>
1669       <sect3 id="message-bus-types-login">
1670         <title>Login session message bus</title>
1671         <para>
1672           Each time a user logs in, a <firstterm>login session message
1673             bus</firstterm> may be started. All applications in the user's login
1674           session may interact with one another using this message bus.
1675         </para>
1676         <para>
1677           The address of the login session message bus is given
1678           in the <literal>DBUS_SESSION_BUS_ADDRESS</literal> environment
1679           variable. If that variable is not set, applications may
1680           also try to read the address from the X Window System root
1681           window property <literal>_DBUS_SESSION_BUS_ADDRESS</literal>.
1682           The root window property must have type <literal>STRING</literal>.
1683           The environment variable should have precedence over the
1684           root window property.
1685         </para>
1686         <para>
1687           [FIXME specify location of .service files, probably using
1688           DESKTOP_DIRS etc. from basedir specification, though login session
1689           bus is not really desktop-specific]
1690         </para>
1691       </sect3>
1692       <sect3 id="message-bus-types-system">
1693         <title>System message bus</title>
1694         <para>
1695           A computer may have a <firstterm>system message bus</firstterm>,
1696           accessible to all applications on the system. This message bus may be
1697           used to broadcast system events, such as adding new hardware devices,
1698           changes in the printer queue, and so forth.
1699         </para>
1700         <para>
1701           The address of the login session message bus is given
1702           in the <literal>DBUS_SYSTEM_BUS_ADDRESS</literal> environment
1703           variable. If that variable is not set, applications should try
1704           to connect to the well-known address
1705           <literal>unix:path=/var/run/dbus/system_bus_socket</literal>.
1706           <footnote>
1707             <para>
1708               The D-BUS reference implementation actually honors the
1709               <literal>$(localstatedir)</literal> configure option
1710               for this address, on both client and server side.
1711             </para>
1712           </footnote>
1713         </para>
1714         <para>
1715           [FIXME specify location of system bus .service files]
1716         </para>
1717       </sect3>
1718     </sect2>
1719
1720     <sect2 id="message-bus-messages">
1721       <title>Message Bus Messages</title>
1722       <para>
1723         The special message bus service <literal>org.freedesktop.DBus</literal>
1724         responds to a number of messages, allowing applications to
1725         interact with the message bus.
1726       </para>
1727
1728       <sect3 id="bus-messages-hello">
1729         <title><literal>org.freedesktop.DBus.Hello</literal></title>
1730         <para>
1731           As a method:
1732           <programlisting>
1733             STRING Hello ()
1734           </programlisting>
1735           Reply arguments:
1736           <informaltable>
1737             <tgroup cols="3">
1738               <thead>
1739                 <row>
1740                   <entry>Argument</entry>
1741                   <entry>Type</entry>
1742                   <entry>Description</entry>
1743                 </row>
1744               </thead>
1745               <tbody>
1746                 <row>
1747                   <entry>0</entry>
1748                   <entry>STRING</entry>
1749                   <entry>Name of the service assigned to the application</entry>
1750                 </row>
1751               </tbody>
1752             </tgroup>
1753           </informaltable>
1754         </para>
1755         <para>
1756           Before an application is able to send messages to other
1757           applications it must send the
1758           <literal>org.freedesktop.DBus.Hello</literal> message to the
1759           message bus service. If an application tries to send a
1760           message to another application, or a message to the message
1761           bus service that isn't the
1762           <literal>org.freedesktop.DBus.Hello</literal> message, it
1763           will be disconnected from the bus. If a client wishes to
1764           disconnect from the bus, it just has to disconnect from the
1765           transport used. No de-registration message is necessary.
1766         </para>
1767         <para>
1768           The reply message contains the name of the application's base service.
1769         </para>
1770       </sect3>
1771       <sect3 id="bus-messages-list-services">
1772         <title><literal>org.freedesktop.DBus.ListServices</literal></title>
1773         <para>
1774           As a method:
1775           <programlisting>
1776             STRING_ARRAY ListServices ()
1777           </programlisting>
1778           Reply arguments:
1779           <informaltable>
1780             <tgroup cols="3">
1781               <thead>
1782                 <row>
1783                   <entry>Argument</entry>
1784                   <entry>Type</entry>
1785                   <entry>Description</entry>
1786                 </row>
1787               </thead>
1788               <tbody>
1789                 <row>
1790                   <entry>0</entry>
1791                   <entry>STRING_ARRAY</entry>
1792                   <entry>Array of strings where each string is the name of a service</entry>
1793                 </row>
1794               </tbody>
1795             </tgroup>
1796           </informaltable>
1797         </para>
1798         <para>
1799           Returns a list of all existing services registered with the message bus.
1800         </para>
1801       </sect3>
1802       <sect3 id="bus-messages-service-exists">
1803         <title><literal>org.freedesktop.DBus.ServiceExists</literal></title>
1804         <para>
1805           As a method:
1806           <programlisting>
1807             BOOLEAN ServiceExists (in STRING service_name)
1808           </programlisting>
1809           Message arguments:
1810           <informaltable>
1811             <tgroup cols="3">
1812               <thead>
1813                 <row>
1814                   <entry>Argument</entry>
1815                   <entry>Type</entry>
1816                   <entry>Description</entry>
1817                 </row>
1818               </thead>
1819               <tbody>
1820                 <row>
1821                   <entry>0</entry>
1822                   <entry>STRING</entry>
1823                   <entry>Name of the service</entry>
1824                 </row>
1825               </tbody>
1826             </tgroup>
1827           </informaltable>
1828           Reply arguments:
1829           <informaltable>
1830             <tgroup cols="3">
1831               <thead>
1832                 <row>
1833                   <entry>Argument</entry>
1834                   <entry>Type</entry>
1835                   <entry>Description</entry>
1836                 </row>
1837               </thead>
1838               <tbody>
1839                 <row>
1840                   <entry>0</entry>
1841                   <entry>BOOLEAN</entry>
1842                   <entry>Return value, true if the service exists</entry>
1843                 </row>
1844               </tbody>
1845             </tgroup>
1846           </informaltable>
1847         </para>
1848         <para>
1849           Checks if a service with a specified name exists.
1850         </para>
1851       </sect3>
1852
1853       <sect3 id="bus-messages-acquire-service">
1854         <title><literal>org.freedesktop.DBus.AcquireService</literal></title>
1855         <para>
1856           As a method:
1857           <programlisting>
1858             UINT32 AcquireService (in STRING service_name)
1859           </programlisting>
1860           Message arguments:
1861           <informaltable>
1862             <tgroup cols="3">
1863               <thead>
1864                 <row>
1865                   <entry>Argument</entry>
1866                   <entry>Type</entry>
1867                   <entry>Description</entry>
1868                 </row>
1869               </thead>
1870               <tbody>
1871                 <row>
1872                   <entry>0</entry>
1873                   <entry>STRING</entry>
1874                   <entry>Name of the service</entry>
1875                 </row>
1876                 <row>
1877                   <entry>1</entry>
1878                   <entry>UINT32</entry>
1879                   <entry>Flags</entry>
1880                 </row>
1881               </tbody>
1882             </tgroup>
1883           </informaltable>
1884           Reply arguments:
1885           <informaltable>
1886             <tgroup cols="3">
1887               <thead>
1888                 <row>
1889                   <entry>Argument</entry>
1890                   <entry>Type</entry>
1891                   <entry>Description</entry>
1892                 </row>
1893               </thead>
1894               <tbody>
1895                 <row>
1896                   <entry>0</entry>
1897                   <entry>UINT32</entry>
1898                   <entry>Return value</entry>
1899                 </row>
1900               </tbody>
1901             </tgroup>
1902           </informaltable>
1903         </para>
1904         <para>
1905           Tries to become owner of a specific service. The flags
1906           specified can be the following values logically ORed together:
1907
1908           <informaltable>
1909             <tgroup cols="3">
1910               <thead>
1911                 <row>
1912                   <entry>Identifier</entry>
1913                   <entry>Value</entry>
1914                   <entry>Description</entry>
1915                 </row>
1916               </thead>
1917               <tbody>
1918                 <row>
1919                   <entry>DBUS_SERVICE_FLAGS_PROHIBIT_REPLACEMENT</entry>
1920                   <entry>0x1</entry>
1921                   <entry>
1922                     If the application succeeds in being the owner of the specified service,
1923                     then ownership of the service can't be transferred until the service
1924                     disconnects. If this flag is not set, then any application trying to become
1925                     the owner of the service will succeed and the previous owner will be
1926                     sent a <literal>org.freedesktop.DBus.ServiceLost</literal> message.
1927                   </entry>
1928                 </row>
1929                 <row>
1930                   <entry>DBUS_SERVICE_FLAGS_REPLACE_EXISTING</entry>
1931                   <entry>0x2</entry>
1932                   <entry>Try to replace the current owner if there is one. If this flag
1933                   is not set the application will only become the owner of the service if
1934                   there is no current owner.</entry>
1935                 </row>
1936               </tbody>
1937             </tgroup>
1938           </informaltable>
1939
1940           [FIXME if it's one of the following values, why are the values
1941           done as flags instead of just 0, 1, 2, 3, 4]
1942           The return value can be one of the following values:
1943
1944           <informaltable>
1945             <tgroup cols="3">
1946               <thead>
1947                 <row>
1948                   <entry>Identifier</entry>
1949                   <entry>Value</entry>
1950                   <entry>Description</entry>
1951                 </row>
1952               </thead>
1953               <tbody>
1954                 <row>
1955                   <entry>DBUS_SERVICE_REPLY_PRIMARY_OWNER</entry>
1956                   <entry>0x1</entry>
1957                   <entry>The application is now the primary owner of the service.</entry>
1958                 </row>
1959                 <row>
1960                   <entry>DBUS_SERVICE_REPLY_IN_QUEUE</entry>
1961                   <entry>0x2</entry>
1962                   <entry>The service already has an owner which do not want to give up ownership and therefore the application has been put in a queue.</entry>
1963                 </row>
1964                 <row>
1965                   <entry>DBUS_SERVICE_REPLY_SERVICE_EXISTS</entry>
1966                   <entry>0x4</entry>
1967                   <entry>The service does already have a primary owner, and DBUS_SERVICE_FLAG_REPLACE_EXISTING was not specified when trying to acquire the service.</entry>
1968                 </row>
1969                 <row>
1970                   <entry>DBUS_SERVICE_REPLY_ALREADY_OWNER</entry>
1971                   <entry>0x8</entry>
1972                   <entry>The application trying to request ownership of the service is already the owner of it.</entry>
1973                 </row>
1974               </tbody>
1975             </tgroup>
1976           </informaltable>
1977         </para>
1978       </sect3>
1979       <sect3 id="bus-messages-service-acquired">
1980         <title><literal>org.freedesktop.DBus.ServiceAcquired</literal></title>
1981         <para>
1982           As a method:
1983           <programlisting>
1984             ServiceAcquired (in STRING service_name)
1985           </programlisting>
1986           Message arguments:
1987           <informaltable>
1988             <tgroup cols="3">
1989               <thead>
1990                 <row>
1991                   <entry>Argument</entry>
1992                   <entry>Type</entry>
1993                   <entry>Description</entry>
1994                 </row>
1995               </thead>
1996               <tbody>
1997                 <row>
1998                   <entry>0</entry>
1999                   <entry>STRING</entry>
2000                   <entry>Name of the service</entry>
2001                 </row>
2002                 <row>
2003                   <entry>1</entry>
2004                   <entry>UINT32</entry>
2005                   <entry>Flags</entry>
2006                 </row>
2007               </tbody>
2008             </tgroup>
2009           </informaltable>
2010         </para>
2011         <para>
2012           This message is sent to a specific application when it becomes the
2013           primary owner of a service.
2014         </para>
2015       </sect3>
2016       <sect3 id="bus-messages-service-lost">
2017         <title><literal>org.freedesktop.DBus.ServiceLost</literal></title>
2018         <para>
2019           As a method:
2020           <programlisting>
2021             ServiceLost (in STRING service_name)
2022           </programlisting>
2023           Message arguments:
2024           <informaltable>
2025             <tgroup cols="3">
2026               <thead>
2027                 <row>
2028                   <entry>Argument</entry>
2029                   <entry>Type</entry>
2030                   <entry>Description</entry>
2031                 </row>
2032               </thead>
2033               <tbody>
2034                 <row>
2035                   <entry>0</entry>
2036                   <entry>STRING</entry>
2037                   <entry>Name of the service</entry>
2038                 </row>
2039                 <row>
2040                   <entry>1</entry>
2041                   <entry>UINT32</entry>
2042                   <entry>Flags</entry>
2043                 </row>
2044               </tbody>
2045             </tgroup>
2046           </informaltable>
2047         </para>
2048         <para>
2049           This message is sent to a specific application when it loses primary
2050           ownership of a service.
2051
2052           [FIXME instead of ServiceLost/ServiceCreated going only to
2053           a specific app, why not just OwnerChanged that covers both
2054           lost and created and changed owner and deleted]
2055         </para>
2056       </sect3>
2057
2058       <sect3 id="bus-messages-service-created">
2059         <title><literal>org.freedesktop.DBus.ServiceCreated</literal></title>
2060         <para>
2061           As a method:
2062           <programlisting>
2063             ServiceCreated (in STRING service_name)
2064           </programlisting>
2065           Message arguments:
2066           <informaltable>
2067             <tgroup cols="3">
2068               <thead>
2069                 <row>
2070                   <entry>Argument</entry>
2071                   <entry>Type</entry>
2072                   <entry>Description</entry>
2073                 </row>
2074               </thead>
2075               <tbody>
2076                 <row>
2077                   <entry>0</entry>
2078                   <entry>STRING</entry>
2079                   <entry>Name of the service</entry>
2080                 </row>
2081                 <row>
2082                   <entry>1</entry>
2083                   <entry>UINT32</entry>
2084                   <entry>Flags</entry>
2085                 </row>
2086               </tbody>
2087             </tgroup>
2088           </informaltable>
2089         </para>
2090         <para>
2091           This message is broadcast to all applications when a service has been
2092           successfully registered on the message bus.
2093         </para>
2094       </sect3>
2095
2096       <sect3 id="bus-messages-service-deleted">
2097         <title><literal>org.freedesktop.DBus.ServiceDeleted</literal></title>
2098         <para>
2099           As a method:
2100           <programlisting>
2101             ServiceDeleted (in STRING service_name)
2102           </programlisting>
2103           Message arguments:
2104           <informaltable>
2105             <tgroup cols="3">
2106               <thead>
2107                 <row>
2108                   <entry>Argument</entry>
2109                   <entry>Type</entry>
2110                   <entry>Description</entry>
2111                 </row>
2112               </thead>
2113               <tbody>
2114                 <row>
2115                   <entry>0</entry>
2116                   <entry>STRING</entry>
2117                   <entry>Name of the service</entry>
2118                 </row>
2119                 <row>
2120                   <entry>1</entry>
2121                   <entry>UINT32</entry>
2122                   <entry>Flags</entry>
2123                 </row>
2124               </tbody>
2125             </tgroup>
2126           </informaltable>
2127         </para>
2128         <para>
2129           This message is broadcast to all applications when a service has been
2130           deleted from the message bus.
2131         </para>
2132       </sect3>
2133
2134       <sect3 id="bus-messages-activate-service">
2135         <title><literal>org.freedesktop.DBus.ActivateService</literal></title>
2136         <para>
2137           As a method:
2138           <programlisting>
2139             UINT32 ActivateService (in STRING service_name, in UINT32 flags)
2140           </programlisting>
2141           Message arguments:
2142           <informaltable>
2143             <tgroup cols="3">
2144               <thead>
2145                 <row>
2146                   <entry>Argument</entry>
2147                   <entry>Type</entry>
2148                   <entry>Description</entry>
2149                 </row>
2150               </thead>
2151               <tbody>
2152                 <row>
2153                   <entry>0</entry>
2154                   <entry>STRING</entry>
2155                   <entry>Name of the service to activate</entry>
2156                 </row>
2157                 <row>
2158                   <entry>1</entry>
2159                   <entry>UINT32</entry>
2160                   <entry>Flags (currently not used)</entry>
2161                 </row>
2162               </tbody>
2163             </tgroup>
2164           </informaltable>
2165         Reply arguments:
2166         <informaltable>
2167           <tgroup cols="3">
2168             <thead>
2169               <row>
2170                 <entry>Argument</entry>
2171                 <entry>Type</entry>
2172                 <entry>Description</entry>
2173               </row>
2174             </thead>
2175             <tbody>
2176               <row>
2177                 <entry>0</entry>
2178                 <entry>UINT32</entry>
2179                 <entry>Return value</entry>
2180               </row>
2181             </tbody>
2182           </tgroup>
2183         </informaltable>
2184           Tries to launch the executable associated with a service. For more information, see <xref linkend="message-bus-activation"/>.
2185
2186             [FIXME need semantics in much more detail here; for example,
2187             if I activate a service then send it a message, is the message
2188             queued for the new service or is there a race]
2189         </para>
2190         <para>
2191           The return value can be one of the following values:
2192     <informaltable>
2193             <tgroup cols="3">
2194               <thead>
2195                 <row>
2196                   <entry>Identifier</entry>
2197                   <entry>Value</entry>
2198                   <entry>Description</entry>
2199                 </row>
2200               </thead>
2201               <tbody>
2202                 <row>
2203                   <entry>DBUS_ACTIVATION_REPLY_ACTIVATED</entry>
2204                   <entry>0x0</entry>
2205                   <entry>The service was activated successfully.</entry>
2206                 </row>
2207                 <row>
2208                   <entry>DBUS_ACTIVATION_REPLY_ALREADY_ACTIVE</entry>
2209                   <entry>0x1</entry>
2210                   <entry>The service is already active.</entry>
2211                 </row>
2212               </tbody>
2213              </tgroup>
2214            </informaltable>
2215         </para>
2216
2217       </sect3>
2218
2219       <sect3 id="bus-messages-get-service-owner">
2220         <title><literal>org.freedesktop.DBus.GetServiceOwner</literal></title>
2221         <para>
2222           As a method:
2223           <programlisting>
2224             STRING GetServiceOwner (in STRING service_name)
2225           </programlisting>
2226           Message arguments:
2227           <informaltable>
2228             <tgroup cols="3">
2229               <thead>
2230                 <row>
2231                   <entry>Argument</entry>
2232                   <entry>Type</entry>
2233                   <entry>Description</entry>
2234                 </row>
2235               </thead>
2236               <tbody>
2237                 <row>
2238                   <entry>0</entry>
2239                   <entry>STRING</entry>
2240                   <entry>Name of the service to query</entry>
2241                 </row>
2242               </tbody>
2243             </tgroup>
2244           </informaltable>
2245         Reply arguments:
2246         <informaltable>
2247           <tgroup cols="3">
2248             <thead>
2249               <row>
2250                 <entry>Argument</entry>
2251                 <entry>Type</entry>
2252                 <entry>Description</entry>
2253               </row>
2254             </thead>
2255             <tbody>
2256               <row>
2257                 <entry>0</entry>
2258                 <entry>STRING</entry>
2259                 <entry>Return value, a base service name</entry>
2260               </row>
2261             </tbody>
2262           </tgroup>
2263         </informaltable>
2264         Returns the base service name of the primary owner of the
2265         service in argument. If the requested service isn't active,
2266         returns a
2267         <literal>org.freedesktop.DBus.Error.ServiceHasNoOwner</literal> error.
2268        </para>
2269       </sect3>
2270
2271       <sect3 id="bus-messages-out-of-memory">
2272         <title><literal>org.freedesktop.DBus.Error.NoMemory</literal></title>
2273         <para>
2274           As a method:
2275           <programlisting>
2276             void NoMemory ()
2277           </programlisting>
2278         </para>
2279         <para>
2280           Sent by the message bus when it can't process a message due to an out of memory failure.
2281         </para>
2282       </sect3>
2283
2284       <sect3 id="bus-messages-service-does-not-exist">
2285         <title><literal>org.freedesktop.DBus.Error.ServiceDoesNotExist</literal></title>
2286         <para>
2287           As a method:
2288           <programlisting>
2289             void ServiceDoesNotExist (in STRING error)
2290           </programlisting>
2291         </para>
2292         <para>
2293           Sent by the message bus as a reply to a client that tried to send a message to a service that doesn't exist.
2294         </para>
2295       </sect3>
2296     </sect2>
2297
2298   </sect1>
2299 <!--
2300   <appendix id="implementation-notes">
2301     <title>Implementation notes</title>
2302     <sect1 id="implementation-notes-subsection">
2303       <title></title>
2304       <para>
2305       </para>
2306     </sect1>
2307   </appendix>
2308 -->
2309
2310   <glossary><title>Glossary</title>
2311     <para>
2312       This glossary defines some of the terms used in this specification.
2313     </para>
2314
2315     <glossentry id="term-activation"><glossterm>Activation</glossterm>
2316       <glossdef>
2317         <para>
2318           The process of creating an owner for a particular service,
2319           typically by launching an executable.
2320         </para>
2321       </glossdef>
2322     </glossentry>
2323
2324     <glossentry id="term-base-service"><glossterm>Base Service</glossterm>
2325       <glossdef>
2326         <para>
2327           The special service automatically assigned to an application by the
2328           message bus. This service may never change owner, and the service
2329           name will be unique (never reused during the lifetime of the
2330           message bus).
2331         </para>
2332       </glossdef>
2333     </glossentry>
2334
2335     <glossentry id="term-broadcast"><glossterm>Broadcast</glossterm>
2336       <glossdef>
2337         <para>
2338           A message sent to the special <literal>org.freedesktop.DBus.Broadcast</literal>
2339           service; the message bus will forward the broadcast message
2340           to all applications that have expressed interest in it.
2341         </para>
2342       </glossdef>
2343     </glossentry>
2344
2345     <glossentry id="term-message"><glossterm>Message</glossterm>
2346       <glossdef>
2347         <para>
2348           A message is the atomic unit of communication via the D-BUS
2349           protocol. It consists of a <firstterm>header</firstterm> and a
2350           <firstterm>body</firstterm>; the body is made up of
2351           <firstterm>arguments</firstterm>.
2352         </para>
2353       </glossdef>
2354     </glossentry>
2355
2356     <glossentry id="term-message-bus"><glossterm>Message Bus</glossterm>
2357       <glossdef>
2358         <para>
2359           The message bus is a special application that forwards
2360           or broadcasts messages between a group of applications
2361           connected to the message bus. It also manages
2362           <firstterm>services</firstterm>.
2363         </para>
2364       </glossdef>
2365     </glossentry>
2366
2367     <glossentry id="namespace"><glossterm>Namespace</glossterm>
2368       <glossdef>
2369         <para>
2370           Used to prevent collisions when defining message and service
2371           names. The convention used is the same as Java uses for
2372           defining classes: a reversed domain name.
2373         </para>
2374       </glossdef>
2375     </glossentry>
2376
2377     <glossentry id="term-object"><glossterm>Object</glossterm>
2378       <glossdef>
2379         <para>
2380           Each application contains <firstterm>objects</firstterm>,
2381           which have <firstterm>interfaces</firstterm> and
2382           <firstterm>methods</firstterm>. Objects are referred to
2383           by a name, called a <firstterm>path</firstterm> or
2384           <firstterm>object reference</firstterm>.
2385         </para>
2386       </glossdef>
2387     </glossentry>
2388
2389     <glossentry id="term-path"><glossterm>Path</glossterm>
2390       <glossdef>
2391         <para>
2392           Object references (object names) in D-BUS are
2393           organized into a filesystem-style hierarchy, so
2394           each object is named by a path. As in LDAP,
2395           there's no difference between "files" and "directories";
2396           a path can refer to an object, while still having
2397           child objects below it.
2398         </para>
2399       </glossdef>
2400     </glossentry>
2401
2402     <glossentry id="peer-to-peer"><glossterm>Peer-to-peer</glossterm>
2403       <glossdef>
2404         <para>
2405           An application talking directly to another application, without going through a message bus.
2406         </para>
2407       </glossdef>
2408     </glossentry>
2409     <glossentry id="term-secondary-owner"><glossterm>Secondary service owner</glossterm>
2410       <glossdef>
2411         <para>
2412           Each service has a primary owner; messages sent to the service name
2413           go to the primary owner. However, certain services also maintain
2414           a queue of secondary owners "waiting in the wings." If
2415           the primary owner releases the service, then the first secondary
2416           owner in the queue automatically becomes the primary owner.
2417         </para>
2418       </glossdef>
2419     </glossentry>
2420     <glossentry id="term-service"><glossterm>Service</glossterm>
2421       <glossdef>
2422         <para>
2423           A service is simply a named list of applications. For example, the
2424           hypothetical <literal>com.yoyodyne.Screensaver</literal> service might
2425           accept messages that affect a screensaver from Yoyodyne Corporation.
2426           An application is said to <firstterm>own</firstterm> a service if the
2427           message bus has associated the application with the service name.
2428           Services may also have <firstterm>secondary owners</firstterm> (see
2429           <xref linkend="term-secondary-owner"/>).
2430         </para>
2431       </glossdef>
2432     </glossentry>
2433     <glossentry id="term-service-name"><glossterm>Service name</glossterm>
2434       <glossdef>
2435         <para>
2436           The name used when referring to a service. If the service is
2437           a base service it has a unique service name, for example
2438           ":1-20", and otherwise it should be namespaced.
2439         </para>
2440       </glossdef>
2441     </glossentry>
2442     <glossentry id="term-service-description-files"><glossterm>Service Description Files</glossterm>
2443       <glossdef>
2444         <para>
2445           ".service files" tell the bus how to activate a particular service.
2446           See <xref linkend="term-activation"/>
2447         </para>
2448       </glossdef>
2449     </glossentry>
2450
2451   </glossary>
2452 </article>
2453