diff --git a/modules/uac_registrant/README b/modules/uac_registrant/README index 6185eee4897..d7b33a58c60 100644 --- a/modules/uac_registrant/README +++ b/modules/uac_registrant/README @@ -10,7 +10,7 @@ Ovidiu Sas - Copyright © 2011-2013 VoIP Embedded, Inc. + Copyright © 2011-2014 VoIP Embedded, Inc. Revision History Revision $Revision$ $Date$ __________________________________________________________ @@ -70,17 +70,24 @@ Chapter 1. Admin Guide 1.1. Overview The module enable OpenSIPS to register itself on a remote SIP - registrar. Several registrant accounts can be defined, each - account is specified by the "uac" parameter. + registrar. At startup, the registrant records are loaded into a hash table in memory and a timer is started. The hash index is computed - over the AOR field. For better hash distribution, the size of - the hash table is configurable. When the timer fires for the - first time, the first hash table will be checked and REGISTERs - will be sent out for each record that is found. On the next - timeout fire, the second hash table will be checked and so on. - The timer interval is configurable. + over the AOR field. + + The timer interval for checking records in a hash bucket is + computed by dividing the timer_interval module param by the + number of hash buckets. When the timer fires for the first + time, the first hash bucket will be checked and REGISTERs will + be sent out for each record that is found. On the next timeout + fire, the second hash bucket will be checked and so on. If the + configured timer_interval module param is lower then the number + of buckets, the module will fail to start. + + Example: setting the timer_interval module to 8 with a + hash_size of 2, will result in having 4 hash buckets (2^2=4) + and buckets will be checked one by one every 2s (8/4=2). Each registrant has it's own state. Registranr's status can be inspected via "reg_list" MI comand. @@ -151,8 +158,8 @@ modparam("uac_registrant", "timer_interval", 120) Example 1.3. Set “db_url” parameter ... -modparam("uac_registrant", "db_url", "mysql://user:passw@localhost/datab -ase") +modparam("uac_registrant", "db_url", "mysql://user:passw@localhost/data +base") ... 1.3.4. table_name (string) diff --git a/modules/uac_registrant/doc/uac_registrant.xml b/modules/uac_registrant/doc/uac_registrant.xml index c46c044d5ba..b9041f5f0fb 100644 --- a/modules/uac_registrant/doc/uac_registrant.xml +++ b/modules/uac_registrant/doc/uac_registrant.xml @@ -29,7 +29,7 @@ - 2011-2013 + 2011-2014 VoIP Embedded, Inc. diff --git a/modules/uac_registrant/doc/uac_registrant_admin.xml b/modules/uac_registrant/doc/uac_registrant_admin.xml index 7d7ef4ce744..3e06a0073fb 100644 --- a/modules/uac_registrant/doc/uac_registrant_admin.xml +++ b/modules/uac_registrant/doc/uac_registrant_admin.xml @@ -9,22 +9,28 @@ Overview The module enable &osips; to register itself on a remote SIP registrar. - Several registrant accounts can be defined, each account is - specified by the "uac" parameter. At startup, the registrant records are loaded into a hash table in memory and a timer is started. The hash index is computed over the AOR field. - For better hash distribution, the size of the hash table is configurable. - When the timer fires for the first time, the first hash table will be checked and + + + The timer interval for checking records in a hash bucket is computed + by dividing the timer_interval module param by the number of hash buckets. + When the timer fires for the first time, the first hash bucket will be checked and REGISTERs will be sent out for each record that is found. - On the next timeout fire, the second hash table will be checked and so on. - The timer interval is configurable. + On the next timeout fire, the second hash bucket will be checked and so on. + If the configured timer_interval module param is lower then the number of buckets, + the module will fail to start. + + + Example: setting the timer_interval module to 8 with a hash_size of 2, will result + in having 4 hash buckets (2^2=4) and buckets will be checked one by one every 2s (8/4=2). - Each registrant has it's own state. - Registranr's status can be inspected via "reg_list" MI comand. + Each registrant has it's own state. + Registranr's status can be inspected via "reg_list" MI comand. UAC registrant states: