Browse Source

htable: readme was regenerated

Daniel-Constantin Mierla 14 years ago
parent
commit
ca91d71fd1
1 changed files with 10 additions and 3 deletions
  1. 10 3
      modules_k/htable/README

+ 10 - 3
modules_k/htable/README

@@ -11,7 +11,7 @@ Elena-Ramona Modroiu
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2008-2011 http://www.asipto.com
+   Copyright © 2008-2011 http://www.asipto.com
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -130,7 +130,7 @@ Chapter 1. Admin Guide
    You can read more about hash tables at:
    You can read more about hash tables at:
    http://en.wikipedia.org/wiki/Hash_table.
    http://en.wikipedia.org/wiki/Hash_table.
 
 
-   The “name� can be a static string or can include pseudo- variables that
+   The "name" can be a static string or can include pseudo- variables that
    will be replaced at runtime.
    will be replaced at runtime.
 
 
    Example 1.1. Accessing $sht(htname=>key)
    Example 1.1. Accessing $sht(htname=>key)
@@ -153,7 +153,7 @@ $sht(a=>$ci::srcip) = $si;
    the failed authentications per user and one for storing the time of
    the failed authentications per user and one for storing the time of
    last authentication attempt. To ensure unique name per user, the hash
    last authentication attempt. To ensure unique name per user, the hash
    table uses a combination of authentication username and text
    table uses a combination of authentication username and text
-   “::auth_count� and “::last_auth�.
+   "::auth_count" and "::last_auth".
 
 
    Example 1.2. Dictionary attack limitation
    Example 1.2. Dictionary attack limitation
 ...
 ...
@@ -268,6 +268,8 @@ if(is_present_hf("Authorization"))
        database table when the SIP server is stopped (i.e., ensure
        database table when the SIP server is stopped (i.e., ensure
        persistency over restarts). Default value is 0 (no write back to db
        persistency over restarts). Default value is 0 (no write back to db
        table).
        table).
+     * initval - the integer value to be returned insted of $null when a
+       requested key is not set.
 
 
    Default value is NULL.
    Default value is NULL.
 
 
@@ -275,6 +277,7 @@ if(is_present_hf("Authorization"))
 ...
 ...
 modparam("htable", "htable", "a=>size=4;autoexpire=7200;dbtable=htable_a;")
 modparam("htable", "htable", "a=>size=4;autoexpire=7200;dbtable=htable_a;")
 modparam("htable", "htable", "b=>size=5;")
 modparam("htable", "htable", "b=>size=5;")
+modparam("htable", "htable", "c=>size=4;autoexpire=7200;initval=1;")
 ...
 ...
 
 
 3.2. db_url (str)
 3.2. db_url (str)
@@ -427,6 +430,10 @@ sht_rm_value_re("ha=>.*");
 
 
      * $sht(htable=>key)
      * $sht(htable=>key)
      * $shtex(htable=>key)
      * $shtex(htable=>key)
+     * $shtcn(htable=>key)
+     * $shtcv(htable=>key)
+     * $shtinc(htable=>key)
+     * $shtval(htable=>key)
 
 
    Exported pseudo-variables are documented at
    Exported pseudo-variables are documented at
    http://www.kamailio.org/dokuwiki/.
    http://www.kamailio.org/dokuwiki/.