[sr-dev] git:master:235591cd: cfgutils: document second optional string for hashing on lock functions family [skip ci]

Module: kamailio Branch: master Commit: 235591cd704529589bbde700b6232ac55281d071 URL: https://github.com/kamailio/kamailio/commit/235591cd704529589bbde700b6232ac… Author: Victor Seva &lt;linuxmaniac(a)torreviejawireless.org&gt; Committer: Victor Seva &lt;linuxmaniac(a)torreviejawireless.org&gt; Date: 2024-04-15T10:50:26+02:00 cfgutils: document second optional string for hashing on lock functions family [skip ci] --- Modified: src/modules/cfgutils/doc/cfgutils_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/235591cd704529589bbde700b6232ac… Patch: https://github.com/kamailio/kamailio/commit/235591cd704529589bbde700b6232ac… --- diff --git a/src/modules/cfgutils/doc/cfgutils_admin.xml b/src/modules/cfgutils/doc/cfgutils_admin.xml index 1cab1284fd5..35721e31c6d 100644 --- a/src/modules/cfgutils/doc/cfgutils_admin.xml +++ b/src/modules/cfgutils/doc/cfgutils_admin.xml @@ -485,10 +485,10 @@ if(is_gflag("4")) </example> </section> <section id="cfgutils.f.lock"> - <title><function moreinfo="none">lock(key)</function></title> + <title><function moreinfo="none">lock(key [, key2])</function></title> <para> Lock the key. Can be used to synchronize operations in config file, - a hash id is computed over the key and appropriate lock is set in the + a hash id is computed over the keys and appropriate lock is set in the lock array controlled by parameter "lock_set_size". Do not use lock() after another lock() unless you are sure the keys hit different array entries. @@ -497,6 +497,9 @@ if(is_gflag("4")) <quote>key</quote> can be static string or string with PVs. </para> <para> + <quote>key2</quote> is optional and can be static string or string with PVs. + </para> + <para> This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE. </para> @@ -510,7 +513,7 @@ lock("$rU"); </example> </section> <section id="cfgutils.f.trylock"> - <title><function moreinfo="none">trylock(key)</function></title> + <title><function moreinfo="none">trylock(key [, key2])</function></title> <para> Try to lock the key. If the lock can not be obtained (possibly already locked), the function returns an error and script execution continues. @@ -519,6 +522,9 @@ lock("$rU"); <quote>key</quote> can be static string or string with PVs. </para> <para> + <quote>key2</quote> is optional and can be static string or string with PVs. + </para> + <para> This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE. </para> @@ -535,7 +541,7 @@ if (trylock("$rU")) { </example> </section> <section id="cfgutils.f.unlock"> - <title><function moreinfo="none">unlock(key)</function></title> + <title><function moreinfo="none">unlock(key [, key2])</function></title> <para> Unlock the key. </para> @@ -543,6 +549,9 @@ if (trylock("$rU")) { <quote>key</quote> can be static string or string with PVs. </para> <para> + <quote>key2</quote> is optional and can be static string or string with PVs. + </para> + <para> This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE. </para> @@ -854,4 +863,3 @@ if (rand_event()) { </section> </section> </chapter> -