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

Author: Daniel-Constantin Mierla <[email protected]>
Committer: Daniel-Constantin Mierla <[email protected]>
Date: 2019-02-22T12:16:40+01:00

evrexec: documentation for rpc command evrexec.run

---

Modified: src/modules/evrexec/doc/evrexec_admin.xml

---

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

---

diff --git a/src/modules/evrexec/doc/evrexec_admin.xml 
b/src/modules/evrexec/doc/evrexec_admin.xml
index 3d39cf6ab4..bcd6af5f49 100644
--- a/src/modules/evrexec/doc/evrexec_admin.xml
+++ b/src/modules/evrexec/doc/evrexec_admin.xml
@@ -123,5 +123,43 @@ event_route[evrexec:timer] {
        </section>
        </section>
 
+       <section>
+       <title>RPC Commands</title>
+       <section id="evrexec.r.run">
+               <title>evrexec.run</title>
+               <para>
+               Run an event_route block or a KEMI function upon an RPC command.
+               </para>
+               <para>
+               Name: <emphasis>evroute.run</emphasis>
+               </para>
+               <para>Parameters:
+               <itemizedlist>
+                       <listitem>
+                       <para>evname</para> - the name of the event route block 
or the KEMI
+                       function.
+                       </listitem>
+                       <listitem>
+                       <para>evdata</para> - (optional) - arbitrary data 
passed as a string,
+                       which is made available inside event route block as 
$evr(data).
+                       </listitem>
+               </itemizedlist>
+               </para>
+
+               <para>
+               RPC Command Format:
+               </para>
+               <programlisting  format="linespecific">
+...
+event_route[evrexec:test] {
+   xlog("rpc command data: $evr(data)\n");
+}
+...
+kamctl rpc evroute.run evroute:test
+kamctl rpc evroute.run evroute:test mydata
+...
+               </programlisting>
+       </section>
+       </section>
 </chapter>
 


_______________________________________________
Kamailio (SER) - Development Mailing List
[email protected]
https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev

Reply via email to