dbus/dbus/doc

johnp freedesktop-cvs-commits at pdx.freedesktop.org
Tue May 11 11:31:34 PDT 2004


CVS commit by johnp: 

* updated the invalid test cases to include the 
  missing PATH header field which is required
* updated the spec documentation to indicate that 
  INTERFACE, MEMBER, and PATH are all required fields


  M +12 -2     dbus/dbus/doc/dbus-specification.xml   1.8


--- dbus/dbus/doc/dbus-specification.xml  #1.7:1.8
@@ -267,5 +267,6 @@
         In addition to the required header information mentioned 
         in <xref linkend="message-protocol-header-encoding"/>, 
-          the header may contain zero or more named 
+          the header must contain the required named header
+          fields and zero or more of the optional named 
           header fields. Future versions of this protocol
           specification may add new fields. Implementations must
@@ -288,5 +289,5 @@
         Here are the currently-defined named header fields:
         <informaltable>
-          <tgroup cols="3">
+          <tgroup cols="5">
             <thead>
               <row>
@@ -294,4 +295,5 @@
                 <entry>Decimal Value</entry>
                 <entry>Type</entry>
+                <entry>Required</entry>
                 <entry>Description</entry>
               </row>
@@ -302,4 +304,5 @@
                 <entry>0</entry>
                 <entry>INVALID</entry>
+                <entry>no</entry>
                 <entry>Not a valid field name (error if it appears in a message)</entry>
               </row>
@@ -308,4 +311,5 @@
                 <entry>1</entry>
                 <entry>OBJECT_PATH</entry>
+                <entry>yes</entry>
                 <entry>The object to send the message to; objects are identified by 
                 a path, "/foo/bar"</entry>
@@ -315,4 +319,5 @@
                 <entry>2</entry>
                 <entry>STRING</entry>
+                <entry>yes</entry>
                 <entry>The interface to invoke a method call on, or 
                 that a signal is emitted from. e.g. "org.freedesktop.Introspectable"</entry>
@@ -322,4 +327,5 @@
                 <entry>3</entry>
                 <entry>STRING</entry>
+                <entry>yes</entry>
                 <entry>The member, either the method name or signal name. 
                 e.g. "Frobate"</entry>
@@ -329,4 +335,5 @@
                 <entry>4</entry>
                 <entry>STRING</entry>
+                <entry>no</entry>
                 <entry>The name of the error that occurred, for errors</entry>
               </row>
@@ -335,4 +342,5 @@
                 <entry>5</entry>
                 <entry>UINT32</entry>
+                <entry>no</entry>
                 <entry>The serial number of the message this message is a reply
                 to. (The serial number is one of the mandatory header fields,
@@ -343,4 +351,5 @@
                 <entry>6</entry>
                 <entry>STRING</entry>
+                <entry>no</entry>
                 <entry>The name of the service this message should be routed to. 
                 Only used in combination with the message bus, see 
@@ -351,4 +360,5 @@
                 <entry>7</entry>
                 <entry>STRING</entry>
+                <entry>no</entry>
                 <entry>Sender service. The name of the base service that sent
                 this message.  The message bus fills in this field; the field is





More information about the dbus-commit mailing list