summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorHavoc Pennington <hp@redhat.com>2003-04-23 03:36:12 +0000
committerHavoc Pennington <hp@redhat.com>2003-04-23 03:36:12 +0000
commitda237031b3104ecdfe1f2df058179cda187fcbc8 (patch)
tree5053b784185cee8e97c3962bdf418332a8e7e79a /doc
parentb29d0c534a631b211f1f94168e7672c604c8f815 (diff)
2003-04-20 Havoc Pennington <hp@pobox.com>
* doc/dbus-specification.sgml: document the restrictions on message and service names
Diffstat (limited to 'doc')
-rw-r--r--doc/TODO3
-rw-r--r--doc/dbus-specification.sgml19
2 files changed, 19 insertions, 3 deletions
diff --git a/doc/TODO b/doc/TODO
index 2cd7e44d..9e7b7505 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -58,6 +58,3 @@
- if you send a message to a service then block for reply, and the service exits/crashes
after the message bus has processed your message but before the service has replied,
it would be nice if the message bus sent you an error reply.
-
- - We have a limit on the number of messages a connection can send, but
- not on how many can be buffered for a given connection.
diff --git a/doc/dbus-specification.sgml b/doc/dbus-specification.sgml
index eda6c00e..d510ca6a 100644
--- a/doc/dbus-specification.sgml
+++ b/doc/dbus-specification.sgml
@@ -436,6 +436,25 @@
</informaltable>
</para>
</sect2>
+
+ <sect2 id="message-protocol-names">
+ <title>Valid names</title>
+ <para>
+ Messages and services have names with type STRING, meaning that
+ they must be valid UTF-8. However, there are also some
+ additional restrictions that apply to message and service names
+ specifically:
+ <itemizedlist>
+ <listitem><para>They must contain at least one '.' (period) character</para></listitem>
+ <listitem><para>They must not begin with a '.' (period) character</para></listitem>
+ <listitem><para>They must not exceed 256 bytes in length</para></listitem>
+ <listitem><para>They must be at least 1 byte in length</para></listitem>
+ </itemizedlist>
+ As a special exception, base service names (those beginning with a colon (':') character)
+ need not contain a period.
+ </para>
+ </sect2>
+
</sect1>
<sect1 id="auth-protocol">