Module: sip-router
Branch: 4.2
Commit: 69db8e643ac2356e443eddd9eecb14430f3e7452
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=69db8e6…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: Sat Nov 8 11:10:11 2014 +0100
htable: elaborated docs about sht_lock() and sht_unlock()
(cherry picked from commit 44269cd654a6ab0557ca242f25ec41158e7dcbaf)
---
modules/htable/README | 8 ++++++--
modules/htable/doc/htable_admin.xml | 8 ++++++--
2 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/modules/htable/README b/modules/htable/README
index 5a27593..322fac9 100644
--- 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
index bfba088..5281f74 100644
--- 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.