[sr-dev] git:master:a2530363: dmq: docs for dmq_process_message()

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: a2530363bba4415dcb82f4a03691e3e2aa48c88e
URL: https://github.com/kamailio/kamailio/commit/a2530363bba4415dcb82f4a03691e3e2aa48c88e

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2021-03-31T08:02:58+02:00

dmq: docs for dmq_process_message()

---

Modified: src/modules/dmq/doc/dmq_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/a2530363bba4415dcb82f4a03691e3e2aa48c88e.diff
Patch: https://github.com/kamailio/kamailio/commit/a2530363bba4415dcb82f4a03691e3e2aa48c88e.patch

---

diff --git a/src/modules/dmq/doc/dmq_admin.xml b/src/modules/dmq/doc/dmq_admin.xml
index b48eea4fe1..20a2e647b3 100644
--- a/src/modules/dmq/doc/dmq_admin.xml
+++ b/src/modules/dmq/doc/dmq_admin.xml
@@ -293,6 +293,41 @@ modparam("dmq", "ping_interval", 90)
         dmq_handle_message();
     }
 ...
+</programlisting>
+                </example>
+        </section>
+        <section id="dmq.f.dmq_process_message">
+                <title>
+                <function moreinfo="none">dmq_process_message([continue])</function>
+                </title>
+                <para>
+					Similar to dmq_handle_message, but the processing is happening
+					immediately, no longer cloning the request in shared memory
+					to be passed to a DMQ worker process.
+                </para>
+                <para>Meaning of parameters:</para>
+                <itemizedlist>
+                    <listitem>
+                    <para>
+                    <emphasis>continue</emphasis> - by default, dmq_process_message() will end
+					execution of routing script by returning 0. If this optional parameter
+					is set to "1", dmq_process_message() will continue executing the routing
+					script after it is been executed, returning 1.
+                    </para>
+                    </listitem>
+                </itemizedlist>
+                <para>
+                This function can be used from REQUEST_ROUTE.
+                </para>
+
+                <example>
+                <title><function>dmq_process_message</function> usage</title>
+                <programlisting format="linespecific">
+...
+    if(is_method("KDMQ")) {
+        dmq_process_message();
+    }
+...
 </programlisting>
                 </example>
         </section>