doc/dbus-specification.sgml

   1 <!doctype article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
   2 ]>
   3 <article id="index">
   4   <artheader>
   5     <title>D-BUS Protocol Specification</title>
   6     <releaseinfo>Version 0.4</releaseinfo>
   7     <date>17 February 2003</date>
   8     <authorgroup>
   9       <author>
  10         <firstname>Havoc</firstname>
  11         <surname>Pennington</surname>
  12         <affiliation>
  13           <address>
  14             <email>hp@pobox.com</email>
  15           </address>
  16         </affiliation>
  17       </author>
  18       <author>
  19         <firstname>Anders</firstname>
  20         <surname>Carlsson</surname>
  21         <affiliation>
  22           <orgname>CodeFactory AB</orgname>
  23           <address>
  24             <email>andersca@codefactory.se</email>
  25           </address>
  26         </affiliation>
  27       </author>
  28     </authorgroup>
  29   </artheader>
  30
  31   <sect1 id="introduction">
  32     <title>Introduction</title>
  33     <para>
  34       D-BUS is a system for low-latency, low-overhead, easy to use
  35       interprocess communication (IPC). In more detail:
  36       <itemizedlist>
  37         <listitem>
  38           <para>
  39             D-BUS is <emphasis>low-latency</emphasis> because it is designed
  40             to avoid round trips and allow asynchronous operation, much like
  41             the X protocol.
  42           </para>
  43         </listitem>
  44         <listitem>
  45           <para>
  46             D-BUS is <emphasis>low-overhead</emphasis> because it uses a
  47             binary protocol, and does not have to convert to and from a text
  48             format such as XML. Because D-BUS is intended for potentially
  49             high-resolution same-machine IPC, not primarily for Internet IPC,
  50             this is an interesting optimization.
  51           </para>
  52         </listitem>
  53         <listitem>
  54           <para>
  55             D-BUS is <emphasis>easy to use</emphasis> because it works in terms
  56             of <firstterm>messages</firstterm> rather than byte streams, and
  57             does not require users to understand any complex concepts such as a
  58             new type system or elaborate APIs. Libraries implementing D-BUS
  59             may choose to abstract messages as "method calls" (see
  60             <xref linkend="message-conventions-method">).
  61           </para>
  62         </listitem>
  63       </itemizedlist>
  64     </para>
  65     <para>
  66       The base D-BUS protocol is a peer-to-peer protocol, specified in <xref
  67       linkend="message-protocol">. That is, it is a system for one application
  68       to talk to a single other application. However, the primary intended
  69       application of D-BUS is the D-BUS <firstterm>message bus</firstterm>,
  70       specified in <xref linkend="message-bus">. The message bus is a special
  71       application that accepts connections from multiple other applications, and
  72       forwards messages among them.
  73     </para>
  74   </sect1>
  75
  76   <sect1 id="message-protocol">
  77     <title>Message Protocol</title>
  78     <para>
  79       A <firstterm>message</firstterm> consists of a
  80       <firstterm>header</firstterm> and a <firstterm>body</firstterm>. If you
  81       think of a message as a package, the header is the address, and the body
  82       contains the package contents. The message delivery system uses the header
  83       information to figure out where to send the message and how to interpret
  84       it; the recipient inteprets the body of the message.
  85     </para>
  86
  87     <para>
  88       The body of the message is made up of zero or more
  89       <firstterm>arguments</firstterm>, which are typed
  90       values, such as an integer or a byte array.
  91     </para>
  92
  93     <sect2 id="message-protocol-header-encoding">
  94       <title>Header Encoding</title>
  95       <para>
  96         Following the mandatory fields, there are zero or more named fields (see
  97         <xref linkend="message-protocol-header-fields">), and then nul bytes
  98         padding the header such that its total length in bytes is a multiple of
  99         8.
 100       </para>
 101       <para>
 102         The header MUST begin with the following mandatory fields in the following
 103         order:
 104         <informaltable>
 105           <tgroup cols=2>
 106             <thead>
 107               <row>
 108                 <entry>Size</entry>
 109                 <entry>Description</entry>
 110               </row>
 111             </thead>
 112             <tbody>
 113               <row>
 114                 <entry>1 byte</entry>
 115                 <entry>Endianness flag; ASCII 'l' for little-endian
 116                   or ASCII 'B' for big-endian.</entry>
 117               </row>
 118               <row>
 119                 <entry>1 byte</entry>
 120                 <entry>Bitwise OR of flags. Unknown flags
 121                   MUST be ignored. Currently-defined flags are described below.
 122                 </entry>
 123               </row>
 124               <row>
 125                 <entry>1 byte</entry>
 126                 <entry>Major protocol version of the sending application.  If
 127                 the major protocol version of the receiving application does not
 128                 match, the applications will not be able to communicate and the
 129                 D-BUS connection MUST be disconnected. The major protocol
 130                 version for this version of the specification is 0.
 131                 </entry>
 132               </row>
 133               <row>
 134                 <entry>1 byte</entry>
 135                 <entry>A nul byte, reserved for future use.
 136                   Any value for this byte MUST be accepted.
 137                 </entry>
 138               </row>
 139               <row>
 140                 <entry>4 bytes</entry>
 141                 <entry>An unsigned 32-bit integer in the
 142                   message's byte order, indicating the total length in bytes of
 143                   the header including named fields and any alignment padding.
 144                   MUST be a multiple of 8.
 145                 </entry>
 146               </row>
 147               <row>
 148                 <entry>4 bytes</entry>
 149                 <entry>An unsigned 32-bit integer in the
 150                   message's byte order, indicating the total length in bytes of
 151                   the message body.
 152                 </entry>
 153               </row>
 154               <row>
 155                 <entry>4 bytes</entry>
 156                 <entry>The message's serial number, a signed 32-bit integer in
 157                   the message's byte order. Applications MUST NOT reuse the same
 158                   serial number for different messages more often than 32-bit
 159                   integer wraparound. Serial numbers must be greater than
 160                   zero.
 161                 </entry>
 162               </row>
 163             </tbody>
 164           </tgroup>
 165         </informaltable>
 166       </para>
 167       <para>
 168         Flags that can appear in the second byte of the header:
 169         <informaltable>
 170           <tgroup cols=2>
 171             <thead>
 172               <row>
 173                 <entry>Hex value</entry>
 174                 <entry>Description</entry>
 175               </row>
 176             </thead>
 177             <tbody>
 178               <row>
 179                 <entry>0x1</entry>
 180                 <entry>This message is an error reply.</entry>
 181               </row>
 182             </tbody>
 183           </tgroup>
 184         </informaltable>
 185       </para>
 186     </sect2>
 187
 188     <sect2 id="message-protocol-header-fields">
 189       <title>Header Fields</title>
 190       <para>
 191         In addition to the required header information mentioned
 192         in <xref linkend="message-protocol-header-encoding">,
 193           the header may contain zero or more named
 194           header fields. These fields are named to allow
 195           future versions of this protocol specification to
 196           add new fields; implementations must ignore fields
 197           they do not understand. Implementations must not
 198           invent their own header fields; only changes to
 199           this specification may introduce new header fields.
 200       </para>
 201
 202       <para>
 203         Header field names MUST consist of 4 non-nul bytes.  The field name is
 204         NOT nul terminated; it occupies exactly 4 bytes. Following the name,
 205         the field MUST have a type code, and then a properly-aligned value
 206         of that type.
 207         See <xref linkend="message-protocol-arguments"> for a description
 208           of how each type is encoded. If an implementation sees a header
 209           field name that it does not understand, it MUST ignore
 210           that field.
 211       </para>
 212
 213       <para>
 214         Here are the currently-defined named header fields:
 215         <informaltable>
 216           <tgroup cols=3>
 217             <thead>
 218               <row>
 219                 <entry>Name</entry>
 220                 <entry>Type</entry>
 221                 <entry>Description</entry>
 222               </row>
 223             </thead>
 224             <tbody>
 225               <row>
 226                 <entry>name</entry>
 227                 <entry>STRING</entry>
 228                 <entry>The name of the message, such as org.freedesktop.Peer.Ping</entry>
 229               </row>
 230               <row>
 231                 <entry>rply</entry>
 232                 <entry>INT32</entry>
 233                 <entry>The serial number of the message this message is a reply
 234                 to. (The serial number is one of the mandatory header fields,
 235                 see <xref linkend="message-protocol-header-encoding">.)</entry>
 236               </row>
 237               <row>
 238                 <entry>srvc</entry>
 239                 <entry>STRING</entry>
 240                 <entry>The name of the service this message should be routed to.
 241                 Only used in combination with the message bus, see
 242                 <xref linkend="message-bus">.</entry>
 243               </row>
 244               <row>
 245                 <entry>sndr</entry>
 246                 <entry>STRING</entry>
 247                 <entry>The name of the base service that sent this message.
 248                 The message bus fills in this field; the field is
 249                 only meaningful in combination with the message bus.</entry>
 250               </row>
 251             </tbody>
 252           </tgroup>
 253         </informaltable>
 254       </para>
 255
 256     </sect2>
 257     <sect2 id="message-protocol-header-padding">
 258       <title>Header Alignment Padding</title>
 259       <para>
 260         To allow implementations to keep the header and the body in a single
 261         buffer while keeping data types aligned, the total length of the header
 262         must be a multiple of 8 bytes.  To achieve this, the header MUST be padded
 263         with nul bytes to align its total length on an 8-byte boundary.
 264         The minimum number of padding bytes MUST be used. Because all possible
 265         named fields use at least 8 bytes, implementations can distinguish
 266         padding (which must be less than 8 bytes) from additional named fields
 267         (which must be at least 8 bytes).
 268       </para>
 269     </sect2>
 270
 271     <sect2 id="message-protocol-arguments">
 272       <title>Message Arguments</title>
 273       <para>
 274         The message body is made up of arguments. Each argument
 275         is a type code, followed by the value of the argument
 276         in a type-dependent format.
 277       </para>
 278       <para>
 279         [FIXME perhaps we should add type BYTE with the primary
 280         advantage being that it occupies 1 byte vs. 7 for UINT32,
 281         or perhaps space savings aren't worth the complexity]
 282         [FIXME perhaps we should add type BOOL with the primary
 283         advantage being better type safety vs. overloading of
 284         UINT32]
 285         The type codes are as follows:
 286         <informaltable>
 287           <tgroup cols=3>
 288             <thead>
 289               <row>
 290                 <entry>Type name</entry>
 291                 <entry>Code</entry>
 292                 <entry>Description</entry>
 293               </row>
 294             </thead>
 295             <tbody>
 296               <row>
 297                 <entry>INVALID</entry>
 298                 <entry>0</entry>
 299                 <entry>Not a valid type code (error if it appears in a message)</entry>
 300               </row><row>
 301                 <entry>NIL</entry>
 302                 <entry>1</entry>
 303                 <entry>Marks an "unset" or "nonexistent" argument</entry>
 304               </row><row>
 305                 <entry>INT32</entry>
 306                 <entry>2</entry>
 307                 <entry>32-bit signed integer</entry>
 308               </row><row>
 309                 <entry>UINT32</entry>
 310                 <entry>3</entry>
 311                 <entry>32-bit unsigned integer</entry>
 312               </row><row>
 313                 <entry>DOUBLE</entry>
 314                 <entry>4</entry>
 315                 <entry>IEEE 754 double</entry>
 316               </row><row>
 317                 <entry>STRING</entry>
 318                 <entry>5</entry>
 319                 <entry>UTF-8 string (<emphasis>must</emphasis> be valid UTF-8)</entry>
 320               </row><row>
 321                 <entry>INT32_ARRAY</entry>
 322                 <entry>6</entry>
 323                 <entry>Array of INT32</entry>
 324               </row><row>
 325                 <entry>UINT32_ARRAY</entry>
 326                 <entry>7</entry>
 327                 <entry>Array of UINT32</entry>
 328               </row><row>
 329                 <entry>DOUBLE_ARRAY</entry>
 330                 <entry>8</entry>
 331                 <entry>Array of DOUBLE</entry>
 332               </row><row>
 333                 <entry>BYTE_ARRAY</entry>
 334                 <entry>9</entry>
 335                 <entry>Array of bytes</entry>
 336               </row><row>
 337                 <entry>STRING_ARRAY</entry>
 338                 <entry>10</entry>
 339                 <entry>Array of STRING</entry>
 340               </row>
 341             </tbody>
 342           </tgroup>
 343         </informaltable>
 344       </para>
 345       <para>
 346         The types are encoded as follows:
 347         <informaltable>
 348           <tgroup cols=2>
 349             <thead>
 350               <row>
 351                 <entry>Type name</entry>
 352                 <entry>Encoding</entry>
 353               </row>
 354             </thead>
 355             <tbody>
 356               <row>
 357                 <entry>INVALID</entry>
 358                 <entry>Not applicable; cannot be encoded.</entry>
 359               </row><row>
 360                 <entry>NIL</entry>
 361                 <entry>No data is encoded; the type code is followed immediately
 362                 by the type code of the next argument.</entry>
 363               </row><row>
 364                 <entry>INT32</entry>
 365                 <entry>32-bit signed integer in the message's byte order, aligned to 4-byte boundary.</entry>
 366               </row><row>
 367                 <entry>UINT32</entry>
 368                 <entry>32-bit unsigned integer in the message's byte order, aligned to 4-byte boundary.</entry>
 369               </row><row>
 370                 <entry>DOUBLE</entry>
 371                 <entry>64-bit IEEE 754 double in the message's byte order, aligned to 8-byte boundary.</entry>
 372               </row><row>
 373                 <entry>STRING</entry>
 374                 <entry>UINT32 aligned to 4-byte boundary indicating the string's
 375                   length in bytes excluding its terminating nul, followed by
 376                   string data of the given length, followed by a terminating nul
 377                   byte.
 378                 </entry>
 379               </row><row>
 380                 <entry>INT32_ARRAY</entry>
 381                 <entry>UINT32 giving the number of values in the array,
 382                   followed by the given number of INT32 values.
 383                 </entry>
 384               </row><row>
 385                 <entry>UINT32_ARRAY</entry>
 386                 <entry>UINT32 giving the number of values in the array,
 387                   followed by the given number of UINT32 values.
 388                 </entry>
 389               </row><row>
 390                 <entry>DOUBLE_ARRAY</entry>
 391                 <entry>UINT32 giving the number of values in the array,
 392                   followed by the given number of DOUBLE values aligned
 393                   to 8-byte boundary.
 394                 </entry>
 395               </row><row>
 396                 <entry>BYTE_ARRAY</entry>
 397                 <entry>UINT32 giving the number of values in the array,
 398                   followed by the given number of one-byte values.
 399                 </entry>
 400               </row><row>
 401                 <entry>STRING_ARRAY</entry>
 402                 <entry>UINT32 giving the number of values in the array,
 403                   followed by the given number of STRING values.
 404                 </entry>
 405               </row>
 406             </tbody>
 407           </tgroup>
 408         </informaltable>
 409       </para>
 410     </sect2>
 411   </sect1>
 412
 413   <sect1 id="auth-protocol">
 414     <title>Authentication Protocol</title>
 415     <para>
 416       Before the flow of messages begins, two applications
 417       must authenticate. A simple text protocol is used
 418       for authentication; this protocol is a SASL profile,
 419       and maps fairly directly from the SASL specification.
 420     </para>
 421     <para>
 422       In examples, "C:" and "S:" indicate lines sent by the client and
 423       server respectively.
 424     </para>
 425     <sect2 id="auth-protocol-overview">
 426       <title>Protocol Overview</title>
 427       <para>
 428         The protocol is a line-based protocol, where each line ends with
 429         \r\n. Each line begins with an all-caps ASCII command name containing
 430         only the character range [A-Z], a space, then any arguments for the
 431         command, then the \r\n ending the line. The protocol is
 432         case-sensitive. All bytes must be in the ASCII character set.
 433
 434         Commands from the client to the server are as follows:
 435
 436         <itemizedlist>
 437           <listitem><para>AUTH [mechanism] [initial-response]</para></listitem>
 438           <listitem><para>CANCEL</para></listitem
 439                                           <listitem><para>BEGIN</para></listitem>
 440                                           <listitem><para>DATA &lt;data in base 64 encoding&gt;</para></listitem>
 441                                           <listitem><para>ERROR [human-readable error explanation]</para></listitem>
 442         </itemizedlist>
 443
 444         From server to client are as follows:
 445
 446         <itemizedlist>
 447           <listitem><para>REJECTED &lt;space-separated list of mechanism names&gt;</para></listitem>
 448           <listitem><para>OK</para></listitem>
 449           <listitem><para>DATA &lt;data in base 64 encoding&gt;</para></listitem>
 450           <listitem><para>ERROR</para></listitem>
 451         </itemizedlist>
 452       </para>
 453     </sect2>
 454     <sect2 id="auth-nul-byte">
 455       <title>Special credentials-passing nul byte</title>
 456       <para>
 457         Immediately after connecting to the server, the client must send a
 458         single nul byte. This byte may be accompanied by credentials
 459         information on some operating systems that use sendmsg() with
 460         SCM_CREDS or SCM_CREDENTIALS to pass credentials over UNIX domain
 461         sockets. However, the nul byte MUST be sent even on other kinds of
 462         socket, and even on operating systems that do not require a byte to be
 463         sent in order to transmit credentials. The text protocol described in
 464         this document begins after the single nul byte. If the first byte
 465         received from the client is not a nul byte, the server may disconnect
 466         that client.
 467       </para>
 468       <para>
 469         A nul byte in any context other than the initial byte is an error;
 470         the protocol is ASCII-only.
 471       </para>
 472       <para>
 473         The credentials sent along with the nul byte may be used with the
 474         SASL mechanism EXTERNAL.
 475
 476       </para>
 477     </sect2>
 478     <sect2 id="auth-command-auth">
 479       <title>AUTH command</title>
 480       <para>
 481         If an AUTH command has no arguments, it is a request to list
 482         available mechanisms. The server SHOULD respond with a REJECTED
 483         command listing the mechanisms it understands.
 484       </para>
 485       <para>
 486         If an AUTH command specifies a mechanism, and the server supports
 487         said mechanism, the server SHOULD begin exchanging SASL
 488         challenge-response data with the client using DATA commands.
 489       </para>
 490       <para>
 491         If the server does not support the mechanism given in the AUTH
 492         command, it SHOULD send a REJECTED command listing the mechanisms
 493         it does support.
 494       </para>
 495       <para>
 496         If the [initial-response] argument is provided, it is intended for
 497         use with mechanisms that have no initial challenge (or an empty
 498         initial challenge), as if it were the argument to an initial DATA
 499         command. If the selected mechanism has an initial challenge, the
 500         server should reject authentication by sending REJECTED.
 501       </para>
 502       <para>
 503         If authentication succeeds after exchanging DATA commands,
 504         an OK command should be sent to the client.
 505       </para>
 506       <para>
 507         The first octet received by the client after the \r\n of the OK
 508         command MUST be the first octet of the authenticated/encrypted
 509         stream of D-BUS messages.
 510       </para>
 511       <para>
 512         The first octet received by the server after the \r\n of the BEGIN
 513         command from the client MUST be the first octet of the
 514         authenticated/encrypted stream of D-BUS messages.
 515       </para>
 516     </sect2>
 517     <sect2 id="auth-command-cancel">
 518       <title>CANCEL Command</title>
 519       <para>
 520         At any time up to sending the BEGIN command, the client may send a
 521         CANCEL command. On receiving the CANCEL command, the server MUST
 522         send a REJECTED command and abort the current authentication
 523         exchange.
 524       </para>
 525     </sect2>
 526     <sect2 id="auth-command-data">
 527       <title>DATA Command</title>
 528       <para>
 529         The DATA command may come from either client or server, and simply
 530         contains a base64-encoded block of data to be interpreted
 531         according to the SASL mechanism in use.
 532       </para>
 533       <para>
 534         Some SASL mechanisms support sending an "empty string";
 535         FIXME we need some way to do this.
 536       </para>
 537     </sect2>
 538     <sect2 id="auth-command-begin">
 539       <title>BEGIN Command</title>
 540       <para>
 541         The BEGIN command acknowledges that the client has received an
 542         OK command from the server, and that the stream of messages
 543         is about to begin.
 544       </para>
 545       <para>
 546         The first octet received by the server after the \r\n of the BEGIN
 547         command from the client MUST be the first octet of the
 548         authenticated/encrypted stream of D-BUS messages.
 549       </para>
 550     </sect2>
 551     <sect2 id="auth-command-rejected">
 552       <title>REJECTED Command</title>
 553       <para>
 554         The REJECTED command indicates that the current authentication
 555         exchange has failed, and further exchange of DATA is inappropriate.
 556         The client would normally try another mechanism, or try providing
 557         different responses to challenges.
 558       </para><para>
 559         Optionally, the REJECTED command has a space-separated list of
 560         available auth mechanisms as arguments. If a server ever provides
 561         a list of supported mechanisms, it MUST provide the same list
 562         each time it sends a REJECTED message. Clients are free to
 563         ignore all lists received after the first.
 564       </para>
 565     </sect2>
 566     <sect2 id="auth-command-ok">
 567       <title>OK Command</title>
 568       <para>
 569         The OK command indicates that the client has been authenticated,
 570         and that further communication will be a stream of D-BUS messages
 571         (optionally encrypted, as negotiated) rather than this protocol.
 572       </para>
 573       <para>
 574         The first octet received by the client after the \r\n of the OK
 575         command MUST be the first octet of the authenticated/encrypted
 576         stream of D-BUS messages.
 577       </para>
 578       <para>
 579         The client MUST respond to the OK command by sending a BEGIN
 580         command, followed by its stream of messages, or by disconnecting.
 581         The server MUST NOT accept additional commands using this protocol
 582         after the OK command has been sent.
 583       </para>
 584     </sect2>
 585     <sect2 id="auth-command-error">
 586       <title>ERROR Command</title>
 587       <para>
 588         The ERROR command indicates that either server or client did not
 589         know a command, does not accept the given command in the current
 590         context, or did not understand the arguments to the command. This
 591         allows the protocol to be extended; a client or server can send a
 592         command present or permitted only in new protocol versions, and if
 593         an ERROR is received instead of an appropriate response, fall back
 594         to using some other technique.
 595       </para><para>
 596         If an ERROR is sent, the server or client MUST continue as if the
 597         command causing the ERROR had never been received.
 598       </para>
 599     </sect2>
 600     <sect2 id="auth-examples">
 601       <title>Authentication examples</title>
 602
 603       <para>
 604         <figure>
 605           <title>Example of successful magic cookie authentication</title>
 606           <programlisting>
 607             (MAGIC_COOKIE is a made up mechanism)
 608
 609             C: AUTH MAGIC_COOKIE BsAY3g4gBNo=
 610             S: OK
 611             C: BEGIN
 612           </programlisting>
 613         </figure>
 614         <figure>
 615           <title>Example of finding out mechanisms then picking one</title>
 616           <programlisting>
 617             C: AUTH
 618             S: REJECTED KERBEROS_V4 SKEY
 619             C: AUTH SKEY bW9yZ2Fu
 620             S: DATA OTUgUWE1ODMwOA==
 621             C: DATA Rk9VUiBNQU5OIFNPT04gRklSIFZBUlkgTUFTSA==
 622             S: OK
 623             C: BEGIN
 624           </programlisting>
 625         </figure>
 626         <figure>
 627           <title>Example of client sends unknown command then falls back to regular auth</title>
 628           <programlisting>
 629             C: FOOBAR
 630             S: ERROR
 631             C: AUTH MAGIC_COOKIE BsAY3g4gBNo=
 632             S: OK
 633             C: BEGIN
 634           </programlisting>
 635         </figure>
 636         <figure>
 637           <title>Example of server doesn't support initial auth mechanism</title>
 638           <programlisting>
 639             C: AUTH MAGIC_COOKIE BsAY3g4gBNo=
 640             S: REJECTED KERBEROS_V4 SKEY
 641             C: AUTH SKEY bW9yZ2Fu
 642             S: DATA OTUgUWE1ODMwOA==
 643             C: DATA Rk9VUiBNQU5OIFNPT04gRklSIFZBUlkgTUFTSA==
 644             S: OK
 645             C: BEGIN
 646           </programlisting>
 647         </figure>
 648         <figure>
 649           <title>Example of wrong password or the like followed by successful retry</title>
 650           <programlisting>
 651             C: AUTH MAGIC_COOKIE BsAY3g4gBNo=
 652             S: REJECTED KERBEROS_V4 SKEY
 653             C: AUTH SKEY bW9yZ2Fu
 654             S: DATA OTUgUWE1ODMwOA==
 655             C: DATA Rk9VUiBNQU5OIFNPT04gRklSIFZBUlkgTUFTSA==
 656             S: REJECTED
 657             C: AUTH SKEY bW9yZ2Fu
 658             S: DATA OTUgUWE1ODMwOA==
 659             C: DATA Rk9VUiBNQU5OIFNPT04gRklSIFZBUlkgTUFTSA==
 660             S: OK
 661             C: BEGIN
 662           </programlisting>
 663         </figure>
 664         <figure>
 665           <title>Example of skey cancelled and restarted</title>
 666           <programlisting>
 667             C: AUTH MAGIC_COOKIE BsAY3g4gBNo=
 668             S: REJECTED KERBEROS_V4 SKEY
 669             C: AUTH SKEY bW9yZ2Fu
 670             S: DATA OTUgUWE1ODMwOA==
 671             C: CANCEL
 672             S: REJECTED
 673             C: AUTH SKEY bW9yZ2Fu
 674             S: DATA OTUgUWE1ODMwOA==
 675             C: DATA Rk9VUiBNQU5OIFNPT04gRklSIFZBUlkgTUFTSA==
 676             S: OK
 677             C: BEGIN
 678           </programlisting>
 679         </figure>
 680       </para>
 681     </sect2>
 682   </sect1>
 683   <sect1 id="addresses">
 684     <title>Server Addresses</title>
 685     <para>
 686       Server addresses consist of a transport name followed by a colon, and
 687       then an optional, comma-separated list of keys and values in the form key=value.
 688       [FIXME how do you escape colon, comma, and semicolon in the values of the key=value pairs?]
 689     </para>
 690     <para>
 691       For example:
 692       <programlisting>unix:path=/tmp/dbus-test</programlisting>
 693       Which is the address to a unix socket with the path /tmp/dbus-test.
 694     </para>
 695     <para>
 696       [FIXME clarify if attempting to connect to each is a requirement
 697       or just a suggestion]
 698       When connecting to a server, multiple server addresses can be
 699       separated by a semi-colon. The library will then try to connect
 700       to the first address and if that fails, it'll try to connect to
 701       the next one specified, and so forth. For example
 702       <programlisting>unix:path=/tmp/dbus-test;unix:path=/tmp/dbus-test2</programlisting>
 703     </para>
 704     <para>
 705       [FIXME we need to specify in detail each transport and its possible arguments]
 706       Currently, a transport over local UNIX sockets exists, a debug
 707       transport that only works in-process and therefore can be used
 708       for for unit testing also exists. It is possible that other
 709       transports are added, such as a TCP/IP transport, and a
 710       transport that works over X11.
 711     </para>
 712   </sect1>
 713
 714   <sect1 id="message-conventions">
 715     <title>Message Conventions</title>
 716     <para>
 717       This section documents conventions that are not essential to D-BUS
 718       functionality, but should generally be followed in order to simplify
 719       programmer's lives.
 720     </para>
 721     <sect2 id="message-conventions-naming">
 722       <title>Message Naming</title>
 723       <para>
 724         Messages are normally named in the form
 725         "org.freedesktop.Peer.Ping", which has three
 726         distinct components:
 727         <variablelist>
 728           <varlistentry>
 729             <term>Namespace e.g. <literal>org.freedesktop</literal></term>
 730             <listitem>
 731               <para>
 732                 Message names have a Java-style namespace: a reversed domain
 733                 name. The components of the domain are normally lowercase.
 734               </para>
 735             </listitem>
 736           </varlistentry>
 737           <varlistentry>
 738             <term>Package or object e.g. <literal>Peer</literal></term>
 739             <listitem>
 740               <para>
 741                 The next part of the message name can be thought of as the name
 742                 of a singleton object, or as the name of a package of related
 743                 messages.  More than one dot-separated component might be used
 744                 here. (Note that D-BUS does not define any idea of object
 745                 instances or object references.)  The package or object name is
 746                 capitalized LikeThis.
 747               </para>
 748             </listitem>
 749           </varlistentry>
 750           <varlistentry>
 751             <term>Method or operation e.g. <literal>Ping</literal></term>
 752             <listitem>
 753               <para>
 754                 The final part of the message name is the most specific, and
 755                 should be a verb indicating an operation to be performed on the
 756                 object.  The method or operation name is capitalized LikeThis.
 757               </para>
 758             </listitem>
 759           </varlistentry>
 760         </variablelist>
 761       </para>
 762       <para>
 763         A reply to a message conventionally has the same name as the message
 764         being replied to. When following method call conventions (see <xref
 765                                                                          linkend="message-conventions-method">), this convention is mandatory,
 766           because a message with multiple possible replies can't be mapped
 767           to method call semantics without special-case code.
 768       </para>
 769     </sect2>
 770     <sect2 id="message-conventions-method">
 771       <title>Method Call Mapping</title>
 772       <para>
 773         Some implementations of D-BUS may present an API that translates object
 774         method calls into D-BUS messages. This document does not specify in
 775         detail how such an API should look or work. However, it does specify how
 776         message-based protocols should be designed to be friendly to such an
 777         API.
 778       </para>
 779       <para>
 780         Remember that D-BUS does not have object references or object instances.
 781         So when one application sends the message
 782         <literal>org.freedesktop.Peer.Ping</literal>, it sends it to another
 783         application, not to any kind of sub-portion of that application.
 784         However, a convenience API used within the recipient application may
 785         route all messages that start with
 786         <literal>org.freedesktop.Peer</literal> to a particular object instance,
 787         and may invoke the <literal>Ping()</literal> method on said instance in
 788         order to handle the message. This is a convenience API based on
 789         method calls.
 790       </para>
 791       <para>
 792         A "method call" consists of a message and, optionally, a reply to that
 793         message. The name of the "method" is the last component of the message,
 794         for example, <literal>org.freedesktop.Peer.Ping</literal> would map to
 795         the method <literal>Ping()</literal> on some object.
 796       </para>
 797       <para>
 798         Arguments to a method may be considered "in" (processed by the
 799         recipient of the message), or "out" (returned to the sender of the
 800         message in the reply). "inout" arguments are both sent and received,
 801         i.e. the caller passes in a value which is modified. An "inout" argument
 802         is equivalent to an "in" argument, followed by an "out" argument.
 803       </para>
 804       <para>
 805         Given a method with zero or one return values, followed by zero or more
 806         arguments, where each argument may be "in", "out", or "inout", the
 807         caller constructs a message by appending each "in" or "inout" argument,
 808         in order. "out" arguments are not represented in the caller's message.
 809       </para>
 810       <para>
 811         The recipient constructs a reply by appending first the return value
 812         if any, then each "out" or "inout" argument, in order.
 813         "in" arguments are not represented in the reply message.
 814       </para>
 815       <para>
 816         The standard reply message MUST have the same name as the message being
 817         replied to, and MUST set the "rply" header field to the serial
 818         number of the message being replied to.
 819       </para>
 820       <para>
 821         If an error occurs, an error reply may be sent in place of the
 822         standard reply. Error replies can be identified by a special
 823         header flag, see <xref linkend="message-protocol-header-encoding">.
 824           Error replies have a name which reflects the type of
 825           error that occurred. Error replies would generally
 826           be mapped to exceptions in a programming language.
 827       </para>
 828       <para>
 829         [FIXME discuss mapping of broadcast messages + matching rules
 830         to signals and slots]
 831       </para>
 832     </sect2>
 833   </sect1>
 834
 835   <sect1 id="standard-messages">
 836     <title>Standard Peer-to-Peer Messages</title>
 837     <para>
 838       In the following message definitions, "method call notation" is presented
 839       in addition to simply listing the message names and arguments. The special
 840       type name ANY means any type other than NIL, and the special type name
 841       ANY_OR_NIL means any valid type.
 842       [FIXME the messages here are just made up to illustrate the
 843       format for defining them]
 844     </para>
 845     <sect2 id="standard-messages-ping">
 846       <title><literal>org.freedesktop.Peer.Ping</literal></title>
 847       <para>
 848         As a method:
 849         <programlisting>
 850           void Ping ()
 851         </programlisting>
 852       </para>
 853       <para>
 854         On receipt of the message <literal>org.freedesktop.Peer.Ping</literal>,
 855         an application should reply with
 856         <literal>org.freedesktop.Peer.Ping</literal>. Neither the
 857         message nor its reply have any arguments.
 858         [FIXME the messages here are just made up to illustrate the
 859         format for defining them]
 860       </para>
 861     </sect2>
 862     <sect2 id="standard-messages-get-props">
 863       <title><literal>org.freedesktop.Props.Get</literal></title>
 864       <para>
 865         As a method:
 866         <programlisting>
 867           ANY_OR_NIL Get (in STRING property_name)
 868         </programlisting>
 869         Message arguments:
 870         <informaltable>
 871           <tgroup cols=3>
 872             <thead>
 873               <row>
 874                 <entry>Argument</entry>
 875                 <entry>Type</entry>
 876                 <entry>Description</entry>
 877               </row>
 878             </thead>
 879             <tbody>
 880               <row>
 881                 <entry>0</entry>
 882                 <entry>STRING</entry>
 883                 <entry>Name of the property to get</entry>
 884               </row>
 885             </tbody>
 886           </tgroup>
 887         </informaltable>
 888         Reply arguments:
 889         <informaltable>
 890           <tgroup cols=3>
 891             <thead>
 892               <row>
 893                 <entry>Argument</entry>
 894                 <entry>Type</entry>
 895                 <entry>Description</entry>
 896               </row>
 897             </thead>
 898             <tbody>
 899               <row>
 900                 <entry>0</entry>
 901                 <entry>ANY_OR_NIL</entry>
 902                 <entry>The value of the property. The type depends on the property.</entry>
 903               </row>
 904             </tbody>
 905           </tgroup>
 906         </informaltable>
 907       </para>
 908       <para>
 909
 910         [FIXME the messages here are just made up to illustrate the
 911         format for defining them]
 912       </para>
 913     </sect2>
 914   </sect1>
 915
 916   <sect1 id="message-bus">
 917     <title>Message Bus Specification</title>
 918     <sect2 id="message-bus-overview">
 919       <title>Message Bus Overview</title>
 920       <para>
 921         The message bus accepts connections from one or more applications.
 922         Once connected, applications can send and receive messages from
 923         the message bus, as in the peer-to-peer case.
 924       </para>
 925       <para>
 926         The message bus keeps track of a set of
 927         <firstterm>services</firstterm>. A service is simply a name, such
 928         as <literal>com.yoyodyne.Screensaver</literal>, which can be
 929         <firstterm>owned</firstterm> by one of the connected applications.
 930         The message bus itself always owns the special service
 931         <literal>org.freedesktop.DBus</literal>.
 932       </para>
 933       <para>
 934         Messages may have a <literal>srvc</literal> field (see <xref
 935                                                                   linkend="message-protocol-header-fields">).  When the message bus
 936           receives a message, if the <literal>srvc</literal> field is absent, the
 937           message is taken to be a standard peer-to-peer message and interpreted
 938           by the message bus itself. For example, sending
 939           an <literal>org.freedesktop.Peer.Ping</literal> message with no
 940           <literal>srvc</literal> will cause the message bus itself to reply
 941           to the ping immediately; the message bus would never make
 942           this message visible to other applications.
 943       </para>
 944       <para>
 945         If the <literal>srvc</literal> field is present, then it indicates a
 946         request for the message bus to route the message. In the usual case,
 947         messages are routed to the owner of the named service.
 948         Messages may also be <firstterm>broadcast</firstterm>
 949         by sending them to the special service
 950         <literal>org.freedesktop.Broadcast</literal>. Broadcast messages are
 951         sent to all applications with <firstterm>message matching
 952           rules</firstterm> that match the message.
 953       </para>
 954       <para>
 955         Continuing the <literal>org.freedesktop.Peer.Ping</literal> example, if
 956         the ping message were sent with a <literal>srvc</literal> name of
 957         <literal>com.yoyodyne.Screensaver</literal>, then the ping would be
 958         forwarded, and the Yoyodyne Corporation screensaver application would be
 959         expected to reply to the ping. If
 960         <literal>org.freedesktop.Peer.Ping</literal> were sent to
 961         <literal>org.freedesktop.Broadcast</literal>, then multiple applications
 962         might receive the ping, and all would normally reply to it.
 963       </para>
 964     </sect2>
 965
 966     <sect2 id="message-bus-services">
 967       <title>Message Bus Services</title>
 968       <para>
 969         A service is a name that identifies a certain application. Each
 970         application connected to the message bus has at least one service name
 971         assigned at connection time and returned in response to the
 972         <literal>org.freedesktop.DBus.Hello</literal> message.
 973         This automatically-assigned service name is called
 974         the application's <firstterm>base service</firstterm>.
 975         Base service names are unique and MUST never be reused for two different
 976         applications.
 977       </para>
 978       <para>
 979         [FIXME I think we should define the format of the base service name,
 980         and specify that a regular service name can never be in that
 981         format; this allows us to categorically prevent "spoofing" - for
 982         example perhaps the base service name starts with a certain
 983         character that no real service name can start with]
 984       </para>
 985       <para>
 986         An application can request additional service names to be associated
 987         with it using the
 988         <literal>org.freedesktop.DBus.AcquireService</literal>
 989         message. [FIXME what service names are allowed; ASCII or unicode;
 990         length limit; etc.]
 991       </para>
 992       <para>
 993         [FIXME this needs more detail, and should move the service-related message
 994         descriptions up into this section perhaps]
 995         Service ownership handling can be specified in the flags part
 996         of the <literal>org.freedesktop.DBus.AcquireService</literal>
 997         message. If an application specifies the
 998         DBUS_SERVICE_FLAGS_PROHIBIT_REPLACEMENT flag, then all applications
 999         trying to acquire the service will be put in a queue. When the
1000         primary owner disconnects from the bus or removes ownership
1001         from the service, the next application in the queue will be the
1002         primary owner. If the DBUS_SERVICE_FLAGS_PROHIBIT_REPLACEMENT
1003         flag is not specified, then the primary owner will lose
1004         ownership whenever another application requests ownership of the
1005         service.
1006       </para>
1007     </sect2>
1008     <sect2 id="message-bus-routing">
1009       <title>Message Bus Message Routing</title>
1010       <para>
1011         When a message is received by the message bus, the message's
1012         <literal>sndr</literal> header field MUST be set to the base service of
1013         the application which sent the message.  If the service already has
1014         a <literal>sndr</literal> field, the pre-existing field is replaced.
1015         This rule means that a replies are always sent to the base service name,
1016         i.e. to the same application that sent the message being replied to.
1017       </para>
1018       <para>
1019         [FIXME go into detail about broadcast, multicast, unicast, etc.]
1020       </para>
1021     </sect2>
1022     <sect2 id="message-bus-activation">
1023       <title>Message Bus Service Activation</title>
1024       <para>
1025         <firstterm>Activation</firstterm> means to locate a service
1026         owner for a service that is currently unowned. For now, it
1027         means to launch an executable that will take ownership of
1028         a particular service.
1029       </para>
1030       <para>
1031         To find an executable corresponding to a particular service, the bus
1032         daemon looks for <firstterm>service description files</firstterm>.
1033         Service description files define a mapping from service names to
1034         executables. Different kinds of message bus will look for these files
1035         in different places, see <xref linkend="message-bus-types">.
1036       </para>
1037       <para>
1038         [FIXME the file format should be much better specified than
1039         "similar to .desktop entries" esp. since desktop entries
1040         are already badly-specified. ;-)]
1041         Service description files have the ".service" file
1042         extension. The message bus will only load service description
1043         files ending with .service; all other files will be ignored.
1044         The file format is similar to that of <ulink
1045                                                  url="http://www.freedesktop.org/standards/desktop-entry-spec/desktop-entry-spec.html">desktop
1046           entries</ulink>. All service description files must be in
1047         UTF-8 encoding.
1048
1049         <figure>
1050           <title>Example service description file</title>
1051           <programlisting>
1052             # Sample service description file
1053             [D-BUS Service]
1054             Name=org.gnome.ConfigurationDatabase
1055             Exec=gconfd-2
1056           </programlisting>
1057         </figure>
1058       </para>
1059       <para>
1060         When an application requests a service to be activated, the bus
1061         daemon tries to find it in the list of activation entries. It
1062         then tries to spawn the executable associated with it. If this
1063         fails, it will report an error. [FIXME what happens if two
1064         .service files offer the same service; what kind of error is reported]
1065       </para>
1066       <para>
1067         The executable launched will have the environment variable
1068         <literal>DBUS_BUS_ADDRESS</literal> set to the address of the
1069         message bus so it can connect and register the appropriate services.
1070       </para>
1071     </sect2>
1072
1073     <sect2 id="message-bus-types">
1074       <title>Standard Message Bus Instances</title>
1075       <para>
1076         Two standard message bus instances are defined here, along with how
1077         to locate them and where their service files live.
1078       </para>
1079       <sect3 id="message-bus-types-login">
1080         <title>Login session message bus</title>
1081         <para>
1082           Each time a user logs in, a <firstterm>login session message
1083             bus</firstterm> may be started. All applications in the user's login
1084           session may interact with one another using this message bus.  [specify
1085           how to find the address of the login session message bus via
1086           environment variable and/or X property]
1087         </para>
1088         <para>
1089           [FIXME specify location of .service files, probably using
1090           DESKTOP_DIRS etc. from basedir specification, though login session
1091           bus is not really desktop-specific]
1092         </para>
1093       </sect3>
1094       <sect3 id="message-bus-types-system">
1095         <title>System message bus</title>
1096         <para>
1097           A computer may have a <firstterm>system message bus</firstterm>,
1098           accessible to all applications on the system. This message bus may be
1099           used to broadcast system events, such as adding new hardware devices.
1100           [specify how to find the address of the system message bus]
1101         </para>
1102         <para>
1103           [FIXME specify location of system bus .service files]
1104         </para>
1105       </sect3>
1106     </sect2>
1107
1108     <sect2 id="message-bus-messages">
1109       <title>Message Bus Messages</title>
1110       <para>
1111         The special message bus service <literal>org.freedesktop.DBus</literal>
1112         responds to a number of messages, allowing applications to
1113         interact with the message bus.
1114       </para>
1115
1116       <sect3 id="bus-messages-hello">
1117         <title><literal>org.freedesktop.DBus.Hello</literal></title>
1118         <para>
1119           As a method:
1120           <programlisting>
1121             STRING Hello ()
1122           </programlisting>
1123           Reply arguments:
1124           <informaltable>
1125             <tgroup cols=3>
1126               <thead>
1127                 <row>
1128                   <entry>Argument</entry>
1129                   <entry>Type</entry>
1130                   <entry>Description</entry>
1131                 </row>
1132               </thead>
1133               <tbody>
1134                 <row>
1135                   <entry>0</entry>
1136                   <entry>STRING</entry>
1137                   <entry>Name of the service assigned to the application</entry>
1138                 </row>
1139               </tbody>
1140             </tgroup>
1141           </informaltable>
1142         </para>
1143         <para>
1144           Before an application is able to send messages to other applications it
1145           must send the <literal>org.freedesktop.DBus.Hello</literal>
1146           message to the message bus service. If an application tries to send
1147           a message to another application, or a message to the message bus
1148           service that isn't the
1149           <literal>org.freedesktop.DBus.Hello</literal> message, it will
1150           be disconnected from the bus.
1151         </para>
1152         <para>
1153           The reply message contains the name of the application's base service.
1154         </para>
1155       </sect3>
1156       <sect3 id="bus-messages-list-services">
1157         <title><literal>org.freedesktop.DBus.ListServices</literal></title>
1158         <para>
1159           As a method:
1160           <programlisting>
1161             STRING_ARRAY ListServices ()
1162           </programlisting>
1163           Reply arguments:
1164           <informaltable>
1165             <tgroup cols=3>
1166               <thead>
1167                 <row>
1168                   <entry>Argument</entry>
1169                   <entry>Type</entry>
1170                   <entry>Description</entry>
1171                 </row>
1172               </thead>
1173               <tbody>
1174                 <row>
1175                   <entry>0</entry>
1176                   <entry>STRING_ARRAY</entry>
1177                   <entry>Array of strings where each string is the name of a service</entry>
1178                 </row>
1179               </tbody>
1180             </tgroup>
1181           </informaltable>
1182         </para>
1183         <para>
1184           Returns a list of all existing services registered with the message bus.
1185         </para>
1186       </sect3>
1187       <sect3 id="bus-messages-service-exists">
1188         <title><literal>org.freedesktop.DBus.ServiceExists</literal></title>
1189         <para>
1190           As a method:
1191           <programlisting>
1192             UINT32 ServiceExists (in STRING service_name)
1193           </programlisting>
1194           Message arguments:
1195           <informaltable>
1196             <tgroup cols=3>
1197               <thead>
1198                 <row>
1199                   <entry>Argument</entry>
1200                   <entry>Type</entry>
1201                   <entry>Description</entry>
1202                 </row>
1203               </thead>
1204               <tbody>
1205                 <row>
1206                   <entry>0</entry>
1207                   <entry>STRING</entry>
1208                   <entry>Name of the service</entry>
1209                 </row>
1210               </tbody>
1211             </tgroup>
1212           </informaltable>
1213           Reply arguments:
1214           <informaltable>
1215             <tgroup cols=3>
1216               <thead>
1217                 <row>
1218                   <entry>Argument</entry>
1219                   <entry>Type</entry>
1220                   <entry>Description</entry>
1221                 </row>
1222               </thead>
1223               <tbody>
1224                 <row>
1225                   <entry>0</entry>
1226                   <entry>UINT32</entry>
1227                   <entry>Return value, 1 if the service exists and 0 otherwise</entry>
1228                 </row>
1229               </tbody>
1230             </tgroup>
1231           </informaltable>
1232         </para>
1233         <para>
1234           Checks if a service with a specified name exists.
1235         </para>
1236       </sect3>
1237
1238       <sect3 id="bus-messages-acquire-service">
1239         <title><literal>org.freedesktop.DBus.AcquireService</literal></title>
1240         <para>
1241           As a method:
1242           <programlisting>
1243             UINT32 AcquireService (in STRING service_name)
1244           </programlisting>
1245           Message arguments:
1246           <informaltable>
1247             <tgroup cols=3>
1248               <thead>
1249                 <row>
1250                   <entry>Argument</entry>
1251                   <entry>Type</entry>
1252                   <entry>Description</entry>
1253                 </row>
1254               </thead>
1255               <tbody>
1256                 <row>
1257                   <entry>0</entry>
1258                   <entry>STRING</entry>
1259                   <entry>Name of the service</entry>
1260                 </row>
1261                 <row>
1262                   <entry>1</entry>
1263                   <entry>UINT32</entry>
1264                   <entry>Flags</entry>
1265                 </row>
1266               </tbody>
1267             </tgroup>
1268           </informaltable>
1269           Reply arguments:
1270           <informaltable>
1271             <tgroup cols=3>
1272               <thead>
1273                 <row>
1274                   <entry>Argument</entry>
1275                   <entry>Type</entry>
1276                   <entry>Description</entry>
1277                 </row>
1278               </thead>
1279               <tbody>
1280                 <row>
1281                   <entry>0</entry>
1282                   <entry>UINT32</entry>
1283                   <entry>Return value</entry>
1284                 </row>
1285               </tbody>
1286             </tgroup>
1287           </informaltable>
1288         </para>
1289         <para>
1290           Tries to become owner of a specific service. The flags
1291           specified can be the following values logically ORed together:
1292
1293           <informaltable>
1294             <tgroup cols=3>
1295               <thead>
1296                 <row>
1297                   <entry>Identifier</entry>
1298                   <entry>Value</entry>
1299                   <entry>Description</entry>
1300                 </row>
1301               </thead>
1302               <tbody>
1303                 <row>
1304                   <entry>DBUS_SERVICE_FLAGS_PROHIBIT_REPLACEMENT</entry>
1305                   <entry>0x1</entry>
1306                   <entry>
1307                     If the application succeeds in being the owner of the specified service,
1308                     then ownership of the service can't be transferred until the service
1309                     disconnects. If this flag is not set, then any application trying to become
1310                     the owner of the service will succeed and the previous owner will be
1311                     sent a <literal>org.freedesktop.DBus.ServiceLost</literal> message.
1312                   </entry>
1313                 </row>
1314                 <row>
1315                   <entry>DBUS_SERVICE_FLAGS_REPLACE_EXISTING</entry>
1316                   <entry>0x2</entry>
1317                   <entry>Only become the owner of the service if there is no current owner.</entry>
1318                 </row>
1319               </tbody>
1320             </tgroup>
1321           </informaltable>
1322
1323           [FIXME if it's one of the following values, why are the values
1324           done as flags instead of just 0, 1, 2, 3, 4]
1325           The return value can be one of the following values:
1326
1327           <informaltable>
1328             <tgroup cols=3>
1329               <thead>
1330                 <row>
1331                   <entry>Identifier</entry>
1332                   <entry>Value</entry>
1333                   <entry>Description</entry>
1334                 </row>
1335               </thead>
1336               <tbody>
1337                 <row>
1338                   <entry>DBUS_SERVICE_REPLY_PRIMARY_OWNER</entry>
1339                   <entry>0x1</entry>
1340                   <entry>The application is now the primary owner of the service.</entry>
1341                 </row>
1342                 <row>
1343                   <entry>DBUS_SERVICE_REPLY_IN_QUEUE</entry>
1344                   <entry>0x2</entry>
1345                   <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>
1346                 </row>
1347                 <row>
1348                   <entry>DBUS_SERVICE_REPLY_SERVICE_EXISTS</entry>
1349                   <entry>0x4</entry>
1350                   <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>
1351                 </row>
1352                 <row>
1353                   <entry>DBUS_SERVICE_REPLY_ALREADY_OWNER</entry>
1354                   <entry>0x8</entry>
1355                   <entry>The application trying to request ownership of the service is already the owner of it.</entry>
1356                 </row>
1357               </tbody>
1358             </tgroup>
1359           </informaltable>
1360         </para>
1361       </sect3>
1362       <sect3 id="bus-messages-service-acquired">
1363         <title><literal>org.freedesktop.DBus.ServiceAcquired</literal></title>
1364         <para>
1365           As a method:
1366           <programlisting>
1367             ServiceAcquired (in STRING service_name)
1368           </programlisting>
1369           Message arguments:
1370           <informaltable>
1371             <tgroup cols=3>
1372               <thead>
1373                 <row>
1374                   <entry>Argument</entry>
1375                   <entry>Type</entry>
1376                   <entry>Description</entry>
1377                 </row>
1378               </thead>
1379               <tbody>
1380                 <row>
1381                   <entry>0</entry>
1382                   <entry>STRING</entry>
1383                   <entry>Name of the service</entry>
1384                 </row>
1385                 <row>
1386                   <entry>1</entry>
1387                   <entry>UINT32</entry>
1388                   <entry>Flags</entry>
1389                 </row>
1390               </tbody>
1391             </tgroup>
1392           </informaltable>
1393         </para>
1394         <para>
1395           This message is sent to a specific application when it becomes the
1396           primary owner of a service.
1397         </para>
1398       </sect3>
1399       <sect3 id="bus-messages-service-lost">
1400         <title><literal>org.freedesktop.DBus.ServiceLost</literal></title>
1401         <para>
1402           As a method:
1403           <programlisting>
1404             ServiceLost (in STRING service_name)
1405           </programlisting>
1406           Message arguments:
1407           <informaltable>
1408             <tgroup cols=3>
1409               <thead>
1410                 <row>
1411                   <entry>Argument</entry>
1412                   <entry>Type</entry>
1413                   <entry>Description</entry>
1414                 </row>
1415               </thead>
1416               <tbody>
1417                 <row>
1418                   <entry>0</entry>
1419                   <entry>STRING</entry>
1420                   <entry>Name of the service</entry>
1421                 </row>
1422                 <row>
1423                   <entry>1</entry>
1424                   <entry>UINT32</entry>
1425                   <entry>Flags</entry>
1426                 </row>
1427               </tbody>
1428             </tgroup>
1429           </informaltable>
1430         </para>
1431         <para>
1432           This message is sent to a specific application when it loses primary
1433           ownership of a service.
1434
1435           [FIXME instead of ServiceLost/ServiceCreated going only to
1436           a specific app, why not just OwnerChanged that covers both
1437           lost and created and changed owner and deleted]
1438         </para>
1439       </sect3>
1440
1441       <sect3 id="bus-messages-service-created">
1442         <title><literal>org.freedesktop.DBus.ServiceCreated</literal></title>
1443         <para>
1444           As a method:
1445           <programlisting>
1446             ServiceCreated (in STRING service_name)
1447           </programlisting>
1448           Message arguments:
1449           <informaltable>
1450             <tgroup cols=3>
1451               <thead>
1452                 <row>
1453                   <entry>Argument</entry>
1454                   <entry>Type</entry>
1455                   <entry>Description</entry>
1456                 </row>
1457               </thead>
1458               <tbody>
1459                 <row>
1460                   <entry>0</entry>
1461                   <entry>STRING</entry>
1462                   <entry>Name of the service</entry>
1463                 </row>
1464                 <row>
1465                   <entry>1</entry>
1466                   <entry>UINT32</entry>
1467                   <entry>Flags</entry>
1468                 </row>
1469               </tbody>
1470             </tgroup>
1471           </informaltable>
1472         </para>
1473         <para>
1474           This message is broadcast to all applications when a service has been
1475           successfully registered on the message bus.
1476         </para>
1477       </sect3>
1478
1479       <sect3 id="bus-messages-service-deleted">
1480         <title><literal>org.freedesktop.DBus.ServiceDeleted</literal></title>
1481         <para>
1482           As a method:
1483           <programlisting>
1484             ServiceDeleted (in STRING service_name)
1485           </programlisting>
1486           Message arguments:
1487           <informaltable>
1488             <tgroup cols=3>
1489               <thead>
1490                 <row>
1491                   <entry>Argument</entry>
1492                   <entry>Type</entry>
1493                   <entry>Description</entry>
1494                 </row>
1495               </thead>
1496               <tbody>
1497                 <row>
1498                   <entry>0</entry>
1499                   <entry>STRING</entry>
1500                   <entry>Name of the service</entry>
1501                 </row>
1502                 <row>
1503                   <entry>1</entry>
1504                   <entry>UINT32</entry>
1505                   <entry>Flags</entry>
1506                 </row>
1507               </tbody>
1508             </tgroup>
1509           </informaltable>
1510         </para>
1511         <para>
1512           This message is broadcast to all applications when a service has been
1513           deleted from the message bus.
1514         </para>
1515       </sect3>
1516
1517       <sect3 id="bus-messages-activate-service">
1518         <title><literal>org.freedesktop.DBus.ActivateService</literal></title>
1519         <para>
1520           As a method:
1521           <programlisting>
1522             void ActivateService (in STRING service_name, in UINT32 flags)
1523           </programlisting>
1524           Message arguments:
1525           <informaltable>
1526             <tgroup cols=3>
1527               <thead>
1528                 <row>
1529                   <entry>Argument</entry>
1530                   <entry>Type</entry>
1531                   <entry>Description</entry>
1532                 </row>
1533               </thead>
1534               <tbody>
1535                 <row>
1536                   <entry>0</entry>
1537                   <entry>STRING</entry>
1538                   <entry>Name of the service to activate</entry>
1539                 </row>
1540                 <row>
1541                   <entry>1</entry>
1542                   <entry>UINT32</entry>
1543                   <entry>Flags (currently not used)</entry>
1544                 </row>
1545               </tbody>
1546             </tgroup>
1547           </informaltable>
1548         </para>
1549         <para>
1550           Tries to launch the executable associated with a service. For more information, see <xref linkend="message-bus-activation">.
1551
1552             [FIXME need semantics in much more detail here; for example,
1553             if I activate a service then send it a message, is the message
1554             queued for the new service or is there a race]
1555         </para>
1556       </sect3>
1557     </sect2>
1558
1559   </sect1>
1560 <!--
1561   <appendix id="implementation-notes">
1562     <title>Implementation notes</title>
1563     <sect1 id="implementation-notes-subsection">
1564       <title></title>
1565       <para>
1566       </para>
1567     </sect1>
1568   </appendix>
1569 -->
1570
1571   <glossary><title>Glossary</title>
1572     <para>
1573       This glossary defines some of the terms used in this specification.
1574     </para>
1575
1576     <glossentry id="term-activation"><glossterm>Activation</glossterm>
1577       <glossdef>
1578         <para>
1579           The process of creating an owner for a particular service,
1580           typically by launching an executable.
1581         </para>
1582       </glossdef>
1583     </glossentry>
1584
1585     <glossentry id="term-base-service"><glossterm>Base Service</glossterm>
1586       <glossdef>
1587         <para>
1588           The special service automatically assigned to an application by the
1589           message bus. This service may never change owner, and the service
1590           name will be unique (never reused during the lifetime of the
1591           message bus).
1592         </para>
1593       </glossdef>
1594     </glossentry>
1595
1596     <glossentry id="term-broadcast"><glossterm>Broadcast</glossterm>
1597       <glossdef>
1598         <para>
1599           A message sent to the special <literal>org.freedesktop.Broadcast</literal>
1600           service; the message bus will forward the broadcast message
1601           to all applications that have expressed interest in it.
1602         </para>
1603       </glossdef>
1604     </glossentry>
1605
1606     <glossentry id="term-message"><glossterm>Message</glossterm>
1607       <glossdef>
1608         <para>
1609           A message is the atomic unit of communication via the D-BUS
1610           protocol. It consists of a <firstterm>header</firstterm> and a
1611           <firstterm>body</firstterm>; the body is made up of
1612           <firstterm>arguments</firstterm>.
1613         </para>
1614       </glossdef>
1615     </glossentry>
1616
1617     <glossentry id="term-message-bus"><glossterm>Message Bus</glossterm>
1618       <glossdef>
1619         <para>
1620           The message bus is a special application that forwards
1621           or broadcasts messages between a group of applications
1622           connected to the message bus. It also manages
1623           <firstterm>services</firstterm>.
1624         </para>
1625       </glossdef>
1626     </glossentry>
1627
1628     <glossentry id="term-service"><glossterm>Service</glossterm>
1629       <glossdef>
1630         <para>
1631           A service is simply a named application that other
1632           applications can refer to. For example, the
1633           hypothetical <literal>com.yoyodyne.Screensaver</literal>
1634           service might accept messages that affect
1635           a screensaver from Yoyodyne Corporation.
1636           An application is said to <firstterm>own</firstterm>
1637           a service if the message bus has associated the
1638           application with the service name.
1639         </para>
1640       </glossdef>
1641     </glossentry>
1642
1643     <glossentry id="term-service-description-files"><glossterm>Service Description Files</glossterm>
1644       <glossdef>
1645         <para>
1646           ".service files" tell the bus how to activate a particular service.
1647           See <xref linkend="term-activation">
1648         </para>
1649       </glossdef>
1650     </glossentry>
1651
1652   </glossary>
1653 </article>
1654