htable: elaborated docs about sht_lock() and sht_unlock()

(cherry picked from commit 44269cd)
kamailio · Nov 11, 2014 · 69db8e6 · 69db8e6
1 parent 7e6a27a
commit 69db8e6
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/modules/htable/README b/modules/htable/README
@@ -672,7 +672,9 @@ sht_reset("ha$var(x)");
 
 4.5.  sht_lock(htable=>key)
 
-   Lock the slot in htable corespoding to the key item.
+   Lock the slot in htable corespoding to the key item. Note that the
+   locking is re-entrant for the process, therefore the lock and unlock
+   should be done by the same process.
 
    This function can be used from ANY_ROUTE.
 
@@ -683,7 +685,9 @@ sht_lock("ha=>test");
 
 4.6.  sht_unlock(htable=>key)
 
-   Unlock the slot in htable corespoding to the key item.
+   Unlock the slot in htable corespoding to the key item. Note that the
+   locking is re-entrant for the process, therefore the lock and unlock
+   should be done by the same process.
 
    This function can be used from ANY_ROUTE.
 

diff --git a/modules/htable/doc/htable_admin.xml b/modules/htable/doc/htable_admin.xml
@@ -735,7 +735,9 @@ sht_reset("ha$var(x)");
 		<function moreinfo="none">sht_lock(htable=>key)</function>
 		</title>
 		<para>
-			Lock the slot in htable corespoding to the key item.
+			Lock the slot in htable corespoding to the key item. Note that
+			the locking is re-entrant for the process, therefore the lock
+			and unlock should be done by the same process.
 		</para>
 		<para>
 			This function can be used from ANY_ROUTE.
@@ -754,7 +756,9 @@ sht_lock("ha=>test");
 		<function moreinfo="none">sht_unlock(htable=>key)</function>
 		</title>
 		<para>
-			Unlock the slot in htable corespoding to the key item.
+			Unlock the slot in htable corespoding to the key item. Note that
+			the locking is re-entrant for the process, therefore the lock
+			and unlock should be done by the same process.
 		</para>
 		<para>
 			This function can be used from ANY_ROUTE.