Commit 11b49131 authored by John Palmieri's avatar John Palmieri

* 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
parent c718526c
2004-05-11 John (J5) Palmieri <johnp@redhat.com>:
* doc/dbus-specification.xml: Added a "Required" column to the
header fields table and changed the "zero or more" verbage in
the above paragraph to read "The header must contain the required
named header fields and zero or more of the optional named header
fields".
* test/data/invalid-messages/*.message: Added the required PATH
named header field to the tests so that they don't fail on
'Missing path field'
2004-05-07 John (J5) Palmieri <johnp@redhat.com>
* python/dbus-bindings.pyx.in: Stopped the bindings from trashing
......
......@@ -266,7 +266,8 @@
<para>
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
ignore fields they do not understand. Implementations
......@@ -287,12 +288,13 @@
<para>
Here are the currently-defined named header fields:
<informaltable>
<tgroup cols="3">
<tgroup cols="5">
<thead>
<row>
<entry>Conventional Name</entry>
<entry>Decimal Value</entry>
<entry>Type</entry>
<entry>Required</entry>
<entry>Description</entry>
</row>
</thead>
......@@ -301,12 +303,14 @@
<entry>INVALID</entry>
<entry>0</entry>
<entry>INVALID</entry>
<entry>no</entry>
<entry>Not a valid field name (error if it appears in a message)</entry>
</row>
<row>
<entry>PATH</entry>
<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>
</row>
......@@ -314,6 +318,7 @@
<entry>INTERFACE</entry>
<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>
</row>
......@@ -321,6 +326,7 @@
<entry>MEMBER</entry>
<entry>3</entry>
<entry>STRING</entry>
<entry>yes</entry>
<entry>The member, either the method name or signal name.
e.g. "Frobate"</entry>
</row>
......@@ -328,12 +334,14 @@
<entry>ERROR_NAME</entry>
<entry>4</entry>
<entry>STRING</entry>
<entry>no</entry>
<entry>The name of the error that occurred, for errors</entry>
</row>
<row>
<entry>REPLY_SERIAL</entry>
<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,
see <xref linkend="message-protocol-header-encoding"/>.)</entry>
......@@ -342,6 +350,7 @@
<entry>DESTINATION</entry>
<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
<xref linkend="message-bus"/>.</entry>
......@@ -350,6 +359,7 @@
<entry>SENDER</entry>
<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
only meaningful in combination with the message bus.</entry>
......
......@@ -8,6 +8,9 @@ STRING 'org.freedesktop.Foo'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
ALIGN 8
END_LENGTH Header
......
......@@ -9,6 +9,9 @@ STRING 'org.freedesktop.Foo'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
ALIGN 8
END_LENGTH Header
......
......@@ -9,6 +9,9 @@ STRING 'org.freedesktop.Foo'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
ALIGN 8
END_LENGTH Header
......
......@@ -9,6 +9,9 @@ STRING 'org.freedesktop.Foo'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
ALIGN 8
END_LENGTH Header
......
......@@ -14,6 +14,9 @@ STRING 'org.freedesktop.Foo'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
ALIGN 8
END_LENGTH Header
......
......@@ -11,6 +11,10 @@ HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
HEADER_FIELD UNKNOWN
TYPE STRING
STRING 'a'
......
......@@ -10,6 +10,9 @@ STRING 'org.freedesktop.Local'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Disconnected'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
ALIGN 8
END_LENGTH Header
......
......@@ -9,6 +9,9 @@ STRING 'NoDotInHere'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
ALIGN 8
END_LENGTH Header
......
......@@ -9,6 +9,9 @@ STRING 'org.freedesktop.Foo'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
HEADER_FIELD UNKNOWN
TYPE STRING
......
......@@ -10,6 +10,10 @@ HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
ALIGN 8
END_LENGTH Header
START_LENGTH Body
......
......@@ -9,6 +9,9 @@ STRING 'org.freedesktop.Foo'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
HEADER_FIELD UNKNOWN
TYPE STRING
......
......@@ -9,6 +9,9 @@ STRING 'org.freedesktop.Foo'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
HEADER_FIELD UNKNOWN
TYPE STRING
......
......@@ -9,6 +9,9 @@ STRING 'org.freedesktop.Foo'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
HEADER_FIELD UNKNOWN
TYPE STRING
......
......@@ -8,6 +8,9 @@ STRING 'org.freedesktop.Foo'
HEADER_FIELD MEMBER
TYPE STRING
STRING 'Bar'
HEADER_FIELD PATH
TYPE OBJECT_PATH
OBJECT_PATH '/foo'
ALIGN 8
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment