summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAlexander Larsson <alexl@redhat.com>2003-04-10 11:04:24 +0000
committerAlexander Larsson <alexl@redhat.com>2003-04-10 11:04:24 +0000
commite84c3a03b3be9cfc351ca8e0b9b935cca455e672 (patch)
tree55faf4c7cdead5cb59e8c36c3e8fe136673b89cf /doc
parent51781f541094a4936d47119cd62682e0431c41e9 (diff)
2003-04-10 Alexander Larsson <alexl@redhat.com>
* dbus/dbus-marshal.[ch]: Add array_type_pos argument to _dbus_marshal_validate_arg. Let you pass a NULL end_pos to _dbus_marshal_validate_type. * dbus/dbus-message.[ch]: Multi-dimensional arrays have full type specification in the outermost array. Iter code re-arranged to handle this. Added some more iter tests. * doc/dbus-specification.sgml: Add me to authors. Remove old FIXME. Update new array encoding description. Correct DBUS_SERVICE_FLAGS_REPLACE_EXISTING description. * test/data/invalid-messages/array-with-mixed-types.message: * test/data/valid-messages/array-of-array-of-uint32.message: Change to the new array format. * test/data/invalid-messages/too-short-dict.message: Fix bug in test. * test/data/valid-messages/recursive-types.message: Fix up and extend test.
Diffstat (limited to 'doc')
-rw-r--r--doc/dbus-specification.sgml36
1 files changed, 24 insertions, 12 deletions
diff --git a/doc/dbus-specification.sgml b/doc/dbus-specification.sgml
index 5a7a80fa..0bbc3cda 100644
--- a/doc/dbus-specification.sgml
+++ b/doc/dbus-specification.sgml
@@ -10,6 +10,7 @@
<firstname>Havoc</firstname>
<surname>Pennington</surname>
<affiliation>
+ <orgname>Red Hat, Inc</orgname>
<address>
<email>hp@pobox.com</email>
</address>
@@ -25,6 +26,16 @@
</address>
</affiliation>
</author>
+ <author>
+ <firstname>Alexander</firstname>
+ <surname>Larsson</surname>
+ <affiliation>
+ <orgname>Red Hat, Inc</orgname>
+ <address>
+ <email>alexl@redhat.com</email>
+ </address>
+ </affiliation>
+ </author>
</authorgroup>
</artheader>
@@ -283,9 +294,6 @@
in a type-dependent format.
</para>
<para>
- [FIXME perhaps we should add type BYTE with the primary
- advantage being that it occupies 1 byte vs. 7 for UINT32,
- or perhaps space savings aren't worth the complexity]
<informaltable>
<tgroup cols=3>
<thead>
@@ -307,7 +315,7 @@
</row><row>
<entry>BYTE</entry>
<entry>2</entry>
- <entry>8-bit unsigned integer.</entry>
+ <entry>8-bit unsigned integer</entry>
</row><row>
<entry>BOOLEAN</entry>
<entry>3</entry>
@@ -365,10 +373,10 @@
by the type code of the next argument.</entry>
</row><row>
<entry>BYTE</entry>
- <entry>a byte.</entry>
+ <entry>A byte.</entry>
</row><row>
<entry>BOOLEAN</entry>
- <entry>a byte, with valid values 0 and 1.</entry>
+ <entry>A byte, with valid values 0 and 1.</entry>
</row><row>
<entry>INT32</entry>
<entry>32-bit signed integer in the message's byte order, aligned to 4-byte boundary.</entry>
@@ -393,11 +401,13 @@
</entry>
</row><row>
<entry>ARRAY</entry>
- <entry>a byte giving the element type of the array followed
- by an UINT32 (aligned to 4 bytes) giving the length of the
- array data in bytes. This is then followed by a number of
- entries with the same type, encoded like that type normally
- would be encoded alone.
+ <entry>A sequence of bytes giving the element type of the array, terminated
+ by a type different from ARRAY (just one byte for one-dimensional arrays, but
+ larger for multi-dimensional arrays), followed by an UINT32 (aligned to 4 bytes)
+ giving the length of the array data in bytes. This is followed by each array entry
+ encoded the way it would normally be encoded, except arrays, which are encoded
+ without the type information, since that is already declared above. Arrays containing
+ NIL are not allowed.
</entry>
</row><row>
<entry>DICT</entry>
@@ -1524,7 +1534,9 @@
<row>
<entry>DBUS_SERVICE_FLAGS_REPLACE_EXISTING</entry>
<entry>0x2</entry>
- <entry>Only become the owner of the service if there is no current owner.</entry>
+ <entry>Try to replace the current owner if there is one. If this flag
+ is not set the application will only become the owner of the service if
+ there is no current owner.</entry>
</row>
</tbody>
</tgroup>