doc/dbus-specification.xml

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