]> git.ipfire.org Git - thirdparty/dbus.git/commitdiff
doc: described send_destination_prefix in manual
authorAdrian Szyndela <adrian.s@samsung.com>
Fri, 26 Apr 2019 09:14:08 +0000 (11:14 +0200)
committerAdrian Szyndela <adrian.s@samsung.com>
Tue, 14 May 2019 08:31:13 +0000 (10:31 +0200)
This adds a description of send_destination_prefix to the dbus-daemon manual.

Signed-off-by: Adrian Szyndela <adrian.s@samsung.com>
Change-Id: I46e6fa54ee34095c3ac83ec2c06cb91cf5669c7f

doc/dbus-daemon.1.xml.in

index acbc7ded4fca0d3a35975c3d41defdccb5df5fbc..84698ca7c596c2f5c4bb26d004d2fb030006b88d 100644 (file)
@@ -919,6 +919,7 @@ statements, and works just like &lt;deny&gt; but with the inverse meaning.</para
    send_error="error_name" | "*"
    send_broadcast="true" | "false"
    send_destination="name" | "*"
+   send_destination_prefix="name"
    send_type="method_call" | "method_return" | "signal" | "error" | "*"
    send_path="/path/name" | "*"
 
@@ -997,6 +998,22 @@ will not work either. As a special case,
 (whether it has a destination specified or not), and
 <literal>receive_sender="*"</literal> similarly matches any message.</para>
 
+<para>
+  A <literal>send_destination_prefix</literal> rule opens or closes
+  the whole namespace for sending. It means that messages may or may not
+  be sent to the <emphasis>owner</emphasis> of any name matching the prefix, regardless of whether
+  it is the primary or the queued owner.
+  In other words, for <literal>&lt;allow send_destination_prefix="a.b"/&gt;</literal>
+  rule and names "a.b", "a.b.c", and "a.b.c.d" present on the bus, it works the same as
+  if three separate rules: <literal>&lt;allow send_destination="a.b"/&gt;</literal>,
+  <literal>&lt;allow send_destination="a.b.c"/&gt;</literal>, and
+  <literal>&lt;allow send_destination="a.b.c.d"/&gt;</literal> had been defined.
+  The rules for matching names are the same as in <literal>own_prefix</literal>
+  (see below): a prefix of "a.b" matches names "a.b" or "a.b.c" or "a.b.c.d", but not "a.bc"
+  or "a.c". The <literal>send_destination_prefix</literal> attribute cannot be combined
+  with the <literal>send_destination</literal> attribute in the same rule.
+</para>
+
 <para>
   Rules with <literal>send_broadcast="true"</literal> match signal messages
   with no destination (broadcasts). Rules with