htable: docs for sht_has_name(...) and sht_has_str_value(...)

kamailio · Sep 4, 2018 · 232c541 · 232c541
1 parent 37eb8b0
commit 232c541
Showing 1 changed file with 108 additions and 0 deletions.
diff --git 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>