Add the QoS level to the publish/subscribe bridge options docs

halfgaar · Mar 2, 2024 · 676fb4e · 676fb4e
1 parent 9e4c51f
commit 676fb4e
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 7 deletions.
diff --git a/man/flashmq.conf.5 b/man/flashmq.conf.5
@@ -5,7 +5,7 @@
 \\$2 \(la\\$1\(ra\\$3
 ..
 .if \n(.g .mso www.tmac
-.TH flashmq.conf 5 "24 February 2024" "" ""
+.TH flashmq.conf 5 "2 March 2024" "" ""
 .SH NAME
 flashmq.conf \- FlashMQ configuration file format
 .SH SYNOPSIS
@@ -406,11 +406,19 @@ The prefix of the randomly generated client ID. Client IDs cannot be explicitely
 
 Default: \*(T<fmqbridge\*(T>
 .TP 
-\*(T<\fBpublish\fR\*(T> \fIfilter\fR 
+\*(T<\fBpublish\fR\*(T> \fIfilter\fR \fIqos\fR 
 Messages matching this filter will be published to the other side. Examples: \*(T<#\*(T> or \*(T<sport/tennis/#\*(T>. This option can be repeated several times.
+
+The QoS value should be seen as the QoS value of the internal subscription causing outgoing messages. Messages that are relayed have this QoS level at most.
+
+Default: \*(T<0\*(T>
 .TP 
-\*(T<\fBsubscribe\fR\*(T> \fIfilter\fR 
+\*(T<\fBsubscribe\fR\*(T> \fIfilter\fR \fIqos\fR 
 Subscriptions for this filter is placed at the other side. Examples: \*(T<#\*(T> or \*(T<sport/tennis/#\*(T>. This option can be repeated several times.
+
+The QoS value is like any subscription at a server. Messages received by the other end will be given this QoS level at most.
+
+Default: \*(T<0\*(T>
 .TP 
 \*(T<\fBlocal_username\fR\*(T> \fIusername\fR 
 Username as seen by the local FlashMQ's plugin or ACL checks. This is not always necessary.

diff --git a/man/flashmq.conf.5.dbk5 b/man/flashmq.conf.5.dbk5
@@ -820,20 +820,32 @@ listen {
       </varlistentry>
 
       <varlistentry xml:id="bridge__publish">
-        <term><option>publish</option> <replaceable>filter</replaceable></term>
+        <term><option>publish</option> <replaceable>filter</replaceable> <replaceable>qos</replaceable></term>
         <listitem>
           <para>
               Messages matching this filter will be published to the other side. Examples: <literal>#</literal> or <literal>sport/tennis/#</literal>. This option can be repeated several times.
           </para>
+          <para>
+            The QoS value should be seen as the QoS value of the internal subscription causing outgoing messages. Messages that are relayed have this QoS level at most.
+          </para>
+          <para>
+              Default: <literal>0</literal>
+          </para>
         </listitem>
       </varlistentry>
 
       <varlistentry xml:id="bridge__subscribe">
-        <term><option>subscribe</option> <replaceable>filter</replaceable></term>
+        <term><option>subscribe</option> <replaceable>filter</replaceable> <replaceable>qos</replaceable></term>
         <listitem>
           <para>
               Subscriptions for this filter is placed at the other side. Examples: <literal>#</literal> or <literal>sport/tennis/#</literal>. This option can be repeated several times.
           </para>
+          <para>
+            The QoS value is like any subscription at a server. Messages received by the other end will be given this QoS level at most.
+          </para>
+          <para>
+              Default: <literal>0</literal>
+          </para>
         </listitem>
       </varlistentry>
 

diff --git a/man/flashmq.conf.5.html b/man/flashmq.conf.5.html
@@ -869,20 +869,32 @@
 
 
 
-        <dt id="bridge__publish"><code class="option">publish</code> <code class="replaceable">filter</code><a class="hash-anchor" href="#bridge__publish">#</a></dt>
+        <dt id="bridge__publish"><code class="option">publish</code> <code class="replaceable">filter</code> <code class="replaceable">qos</code><a class="hash-anchor" href="#bridge__publish">#</a></dt>
         <dd>
           <p>
               Messages matching this filter will be published to the other side. Examples: <code class="literal">#</code> or <code class="literal">sport/tennis/#</code>. This option can be repeated several times.
           </p>
+          <p>
+            The QoS value should be seen as the QoS value of the internal subscription causing outgoing messages. Messages that are relayed have this QoS level at most.
+          </p>
+          <p>
+              Default: <code class="literal">0</code>
+          </p>
         </dd>
 
 
 
-        <dt id="bridge__subscribe"><code class="option">subscribe</code> <code class="replaceable">filter</code><a class="hash-anchor" href="#bridge__subscribe">#</a></dt>
+        <dt id="bridge__subscribe"><code class="option">subscribe</code> <code class="replaceable">filter</code> <code class="replaceable">qos</code><a class="hash-anchor" href="#bridge__subscribe">#</a></dt>
         <dd>
           <p>
               Subscriptions for this filter is placed at the other side. Examples: <code class="literal">#</code> or <code class="literal">sport/tennis/#</code>. This option can be repeated several times.
           </p>
+          <p>
+            The QoS value is like any subscription at a server. Messages received by the other end will be given this QoS level at most.
+          </p>
+          <p>
+              Default: <code class="literal">0</code>
+          </p>
         </dd>