Module: kamailio
Branch: master
Commit: 232c541ab6a084011380d94569215d599725e588
URL:
https://github.com/kamailio/kamailio/commit/232c541ab6a084011380d94569215d5…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2018-09-04T11:12:16+02:00
htable: docs for sht_has_name(...) and sht_has_str_value(...)
---
Modified: src/modules/htable/doc/htable_admin.xml
---
Diff:
https://github.com/kamailio/kamailio/commit/232c541ab6a084011380d94569215d5…
Patch:
https://github.com/kamailio/kamailio/commit/232c541ab6a084011380d94569215d5…
---
diff --git a/src/modules/htable/doc/htable_admin.xml
b/src/modules/htable/doc/htable_admin.xml
index 00f7a6eb41..6a8492a94e 100644
--- a/src/modules/htable/doc/htable_admin.xml
+++ b/src/modules/htable/doc/htable_admin.xml
@@ -1026,6 +1026,114 @@ sht_iterator_end("i1");
}
sht_iterator_end("i1");
...
+</programlisting>
+ </example>
+ </section>
+ <section id="htable.f.sht_has_name">
+ <title>
+ <function moreinfo="none">sht_has_name(htable, op,
mval)</function>
+ </title>
+ <para>
+ Return greater than 0 (true) if the htable has an item that matches
+ the name against the mval parameter.
+ </para>
+ <para>
+ The op parameter can be:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>eq</emphasis> - match the val parameter as string equal
+ expression.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>ne</emphasis> - match the val parameter as string not-equal
+ expression.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>re</emphasis> - match the val parameter as regular
+ expression.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>sw</emphasis> - match the val parameter as 'starts
+ with' expression.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ All parameters can be static strings or contain variables.
+ </para>
+ <para>
+ This function can be used from ANY_ROUTE.
+ </para>
+ <example>
+ <title><function>sht_has_name</function> usage</title>
+ <programlisting format="linespecific">
+...
+if(sht_has_name("ha", "eq", "alice")) {
+ ...
+}
+...
+</programlisting>
+ </example>
+ </section>
+ <section id="htable.f.sht_has_str_value">
+ <title>
+ <function moreinfo="none">sht_has_str_value(htable, op,
mval)</function>
+ </title>
+ <para>
+ Return greater than 0 (true) if the htable has an item that matches
+ the string value against the mval parameter.
+ </para>
+ <para>
+ The op parameter can be:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>eq</emphasis> - match the val parameter as string equal
+ expression.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>ne</emphasis> - match the val parameter as string not-equal
+ expression.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>re</emphasis> - match the val parameter as regular
+ expression.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>sw</emphasis> - match the val parameter as 'starts
+ with' expression.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ All parameters can be static strings or contain variables.
+ </para>
+ <para>
+ This function can be used from ANY_ROUTE.
+ </para>
+ <example>
+ <title><function>sht_has_name</function> usage</title>
+ <programlisting format="linespecific">
+...
+if(sht_has_str_value("ha", "eq", "alice")) {
+ ...
+}
+...
</programlisting>
</example>
</section>