Răsfoiți Sursa

modules: bunch of READMEs regenerated to be sync'ed with docbook

Daniel-Constantin Mierla 13 ani în urmă
părinte
comite
7defb42e5f

+ 30 - 30
modules_k/cfgutils/README

@@ -24,7 +24,7 @@ Daniel-Constantin Mierla
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2007, 2008, 2004 1und1 Internet AG, BASIS AudioNet GmbH,
+   Copyright © 2007, 2008, 2004 1und1 Internet AG, BASIS AudioNet GmbH,
    Elena-Ramona Modroiu, FhG FOKUS
    Elena-Ramona Modroiu, FhG FOKUS
      __________________________________________________________________
      __________________________________________________________________
 
 
@@ -163,10 +163,10 @@ Chapter 1. Admin Guide
 
 
    The cfgutils module can be used to introduce randomness to the
    The cfgutils module can be used to introduce randomness to the
    behaviour of the server. It provides setup functions and the
    behaviour of the server. It provides setup functions and the
-   “rand_event� function. This function return either true or false,
+   "rand_event" function. This function return either true or false,
    depending on a random value and a specified probability. E.g. if you
    depending on a random value and a specified probability. E.g. if you
    set via fifo or script a probability value of 5%, then 5% of all calls
    set via fifo or script a probability value of 5%, then 5% of all calls
-   to rand_event will return true. The pseudovariable “$RANDOM� could be
+   to rand_event will return true. The pseudovariable "$RANDOM" could be
    used to introduce random values e.g. into a SIP reply.
    used to introduce random values e.g. into a SIP reply.
 
 
    The benefit of this module is the probability of the decision can be
    The benefit of this module is the probability of the decision can be
@@ -176,20 +176,20 @@ Chapter 1. Admin Guide
 
 
    The module exports commands to FIFO server that can be used to change
    The module exports commands to FIFO server that can be used to change
    the global settings via FIFO interface. The FIFO commands are:
    the global settings via FIFO interface. The FIFO commands are:
-   “set_prob�, “reset_prob� and “get_prob�.
+   "set_prob", "reset_prob" and "get_prob".
 
 
    This module can be used for simple load-shedding, e.g. reply 5% of the
    This module can be used for simple load-shedding, e.g. reply 5% of the
    Invites with a 503 error and a adequate random Retry-After value.
    Invites with a 503 error and a adequate random Retry-After value.
 
 
    The module provides as well functions to delay the execution of the
    The module provides as well functions to delay the execution of the
-   server. The functions “sleep� and “usleep� could be used to let the
+   server. The functions "sleep" and "usleep" could be used to let the
    server wait a specific time interval.
    server wait a specific time interval.
 
 
    It can also hash the config file used from the server with a (weak)
    It can also hash the config file used from the server with a (weak)
    cryptographic hash function on startup. This value is saved and can be
    cryptographic hash function on startup. This value is saved and can be
    later compared to the actual hash, to detect modifications of this file
    later compared to the actual hash, to detect modifications of this file
    after the server start. This functions are available as the FIFO
    after the server start. This functions are available as the FIFO
-   commands “check_config_hash� and “get_config_hash�.
+   commands "check_config_hash" and "get_config_hash".
 
 
    The gflags functionality (global flags) keeps a bitmap of flags in
    The gflags functionality (global flags) keeps a bitmap of flags in
    shared memory and may be used to change behaviour of server based on
    shared memory and may be used to change behaviour of server based on
@@ -206,7 +206,7 @@ Chapter 1. Admin Guide
 
 
    The module exports external commands that can be used to change the
    The module exports external commands that can be used to change the
    global flags via Management Interface. The MI commands are:
    global flags via Management Interface. The MI commands are:
-   “set_gflag�, “reset_gflag� and “is_gflag�.
+   "set_gflag", "reset_gflag" and "is_gflag".
 
 
 2. Dependencies
 2. Dependencies
 
 
@@ -225,7 +225,7 @@ Chapter 1. Admin Guide
 
 
    The initial value of the probability.
    The initial value of the probability.
 
 
-   Default value is “10�.
+   Default value is "10".
 
 
    Example 1.1. initial_probability parameter usage
    Example 1.1. initial_probability parameter usage
 modparam("cfgutils", "initial_probability", 15)
 modparam("cfgutils", "initial_probability", 15)
@@ -245,7 +245,7 @@ modparam("cfgutils", "hash_file", "/etc/kamailio/kamailio.cfg")
 
 
    The initial value of global flags bitmap.
    The initial value of global flags bitmap.
 
 
-   Default value is “0�.
+   Default value is "0".
 
 
    Example 1.3. initial parameter usage
    Example 1.3. initial parameter usage
 modparam("cfgutils", "initial_gflags", 15)
 modparam("cfgutils", "initial_gflags", 15)
@@ -255,7 +255,7 @@ modparam("cfgutils", "initial_gflags", 15)
    Size of lock set - the value is used as power of two to compute the
    Size of lock set - the value is used as power of two to compute the
    size of lock array.
    size of lock array.
 
 
-   Default value is “0� - no lock set created.
+   Default value is "0" - no lock set created.
 
 
    Example 1.4. lock_set_size parameter usage
    Example 1.4. lock_set_size parameter usage
 modparam("cfgutils", "lock_set_size", 4)
 modparam("cfgutils", "lock_set_size", 4)
@@ -296,9 +296,9 @@ if (rand_event()) {
 
 
 4.2. rand_set_prob(probabiltiy)
 4.2. rand_set_prob(probabiltiy)
 
 
-   Set the “probability� of the decision.
+   Set the "probability" of the decision.
 
 
-   “probability� can have a value from the range 0..100.
+   "probability" can have a value from the range 0..100.
 
 
    Example 1.6. rand_set_prob() usage
    Example 1.6. rand_set_prob() usage
 ...
 ...
@@ -322,7 +322,7 @@ rand_reset_prob();
 ...
 ...
 rand_get_prob();
 rand_get_prob();
 
 
-4.5.  sleep(time)
+4.5. sleep(time)
 
 
    Waits "time" seconds.
    Waits "time" seconds.
 
 
@@ -337,7 +337,7 @@ rand_get_prob();
 sleep("1");
 sleep("1");
 ...
 ...
 
 
-4.6.  usleep(time)
+4.6. usleep(time)
 
 
    Waits "time" milli-seconds.
    Waits "time" milli-seconds.
 
 
@@ -352,7 +352,7 @@ sleep("1");
 usleep("500");
 usleep("500");
 ...
 ...
 
 
-4.7.  abort()
+4.7. abort()
 
 
    Debugging function that aborts the server. Depending on the
    Debugging function that aborts the server. Depending on the
    configuration of the server a core dump will be created.
    configuration of the server a core dump will be created.
@@ -365,7 +365,7 @@ usleep("500");
 abort();
 abort();
 ...
 ...
 
 
-4.8.  pkg_status()
+4.8. pkg_status()
 
 
    Debugging function that dumps the status for the private (PKG) memory.
    Debugging function that dumps the status for the private (PKG) memory.
    This information is logged to the default log facility, depending on
    This information is logged to the default log facility, depending on
@@ -380,7 +380,7 @@ abort();
 pkg_status();
 pkg_status();
 ...
 ...
 
 
-4.9.  pkg_summary()
+4.9. pkg_summary()
 
 
    Debugging function that dumps the summary for the private (PKG) memory
    Debugging function that dumps the summary for the private (PKG) memory
    usage. This information is logged to the default log facility,
    usage. This information is logged to the default log facility,
@@ -395,7 +395,7 @@ pkg_status();
 pkg_summary();
 pkg_summary();
 ...
 ...
 
 
-4.10.  shm_status()
+4.10. shm_status()
 
 
    Debugging function that dumps the status for the shared (SHM) memory.
    Debugging function that dumps the status for the shared (SHM) memory.
    This information is logged to the default log facility, depending on
    This information is logged to the default log facility, depending on
@@ -410,7 +410,7 @@ pkg_summary();
 shm_status();
 shm_status();
 ...
 ...
 
 
-4.11.  shm_summary()
+4.11. shm_summary()
 
 
    Debugging function that dumps the summary for the shared (SHM) memory
    Debugging function that dumps the summary for the shared (SHM) memory
    usage. This information is logged to the default log facility,
    usage. This information is logged to the default log facility,
@@ -427,9 +427,9 @@ shm_summary();
 
 
 4.12. set_gflag(flag)
 4.12. set_gflag(flag)
 
 
-   Set the bit at the position “flag� in global flags.
+   Set the bit at the position "flag" in global flags.
 
 
-   “flag� can have a value in the range of 0..31.
+   "flag" can have a value in the range of 0..31.
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
@@ -441,9 +441,9 @@ set_gflag("4");
 
 
 4.13. reset_gflag(flag)
 4.13. reset_gflag(flag)
 
 
-   Reset the bit at the position “flag� in global flags.
+   Reset the bit at the position "flag" in global flags.
 
 
-   “flag� can have a value in the range of 0..31.
+   "flag" can have a value in the range of 0..31.
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
@@ -455,9 +455,9 @@ reset_gflag("4");
 
 
 4.14. is_gflag(flag)
 4.14. is_gflag(flag)
 
 
-   Check if bit at the position “flag� in global flags is set.
+   Check if bit at the position "flag" in global flags is set.
 
 
-   “flag� can have a value in the range of 0..31.
+   "flag" can have a value in the range of 0..31.
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
@@ -480,7 +480,7 @@ if(is_gflag("4"))
    after another lock() unless you are sure the keys hit different array
    after another lock() unless you are sure the keys hit different array
    entries.
    entries.
 
 
-   “key� can be static string or string with PVs.
+   "key" can be static string or string with PVs.
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
@@ -494,7 +494,7 @@ lock("$rU");
 
 
    Unlock the key.
    Unlock the key.
 
 
-   “key� can be static string or string with PVs.
+   "key" can be static string or string with PVs.
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
@@ -539,7 +539,7 @@ $ kamctl fifo rand_set_prob 10
 
 
    This command don't need a parameter.
    This command don't need a parameter.
 
 
-   Example 1.22.  rand_reset_prob usage
+   Example 1.22. rand_reset_prob usage
 ...
 ...
 $ kamctl fifo rand_reset_prob
 $ kamctl fifo rand_reset_prob
 ...
 ...
@@ -603,7 +603,7 @@ $ kamctl fifo set_gflag 0x3
    The parameter value must be a bitmask in decimal or hexadecimal format.
    The parameter value must be a bitmask in decimal or hexadecimal format.
    The bitmask has a 32 bit size.
    The bitmask has a 32 bit size.
 
 
-   Example 1.27.  reset_gflag usage
+   Example 1.27. reset_gflag usage
 ...
 ...
 $ kamctl fifo reset_gflag 1
 $ kamctl fifo reset_gflag 1
 $ kamctl fifo reset_gflag 0x3
 $ kamctl fifo reset_gflag 0x3
@@ -642,7 +642,7 @@ TRUE
    Return the bitmap with all flags. The function gets no parameters and
    Return the bitmap with all flags. The function gets no parameters and
    returns the bitmap in hexadecimal and decimal format.
    returns the bitmap in hexadecimal and decimal format.
 
 
-   Example 1.29.  get_gflags usage
+   Example 1.29. get_gflags usage
 ...
 ...
 $ kamctl fifo get_gflags
 $ kamctl fifo get_gflags
 0x3039
 0x3039

+ 3 - 10
modules_k/dialog/README

@@ -95,7 +95,7 @@ Carsten Bock
               6.12. dlg_get(callid, ftag, ttag)
               6.12. dlg_get(callid, ftag, ttag)
               6.13. is_known_dlg()
               6.13. is_known_dlg()
 
 
-        7. Exported statistics
+        7. Statistics
 
 
               7.1. active_dialogs
               7.1. active_dialogs
               7.2. early_dialogs
               7.2. early_dialogs
@@ -276,7 +276,7 @@ Chapter 1. Admin Guide
         6.12. dlg_get(callid, ftag, ttag)
         6.12. dlg_get(callid, ftag, ttag)
         6.13. is_known_dlg()
         6.13. is_known_dlg()
 
 
-   7. Exported statistics
+   7. Statistics
 
 
         7.1. active_dialogs
         7.1. active_dialogs
         7.2. early_dialogs
         7.2. early_dialogs
@@ -1173,13 +1173,6 @@ dlg_refer("caller", "sip:[email protected]");
 
 
    This function can be used from REQUEST_ROUTE.
    This function can be used from REQUEST_ROUTE.
 
 
-   IMPORTANT: Users of this function should make sure that the dialog
-   created is further processed statefully. Specifically, if a stateless
-   response is sent out after dlg_manage() is called, the dialog cannot be
-   handled properly. So make sure that a transaction exists or create it
-   explicitly using the tm module. This is a shortcoming of the current
-   implementation that may be resolved in a future version hopefully.
-
    Example 1.53. dlg_manage usage
    Example 1.53. dlg_manage usage
 ...
 ...
 modparam("dialog", "default_timeout", 100)
 modparam("dialog", "default_timeout", 100)
@@ -1260,7 +1253,7 @@ if(!uri == myself) {
 }
 }
 ...
 ...
 
 
-7. Exported statistics
+7. Statistics
 
 
    7.1. active_dialogs
    7.1. active_dialogs
    7.2. early_dialogs
    7.2. early_dialogs

+ 124 - 124
modules_k/dispatcher/README

@@ -16,11 +16,11 @@ Carsten Bock
 
 
    ng-voice.com
    ng-voice.com
 
 
-   Copyright © 2004 FhG FOKUS
+   Copyright © 2004 FhG FOKUS
 
 
-   Copyright © 2005 Voice Sistem
+   Copyright © 2005 Voice Sistem
 
 
-   Copyright © 2010 Daniel-Constantin Mierla (asipto.com)
+   Copyright © 2010 Daniel-Constantin Mierla (asipto.com)
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -101,35 +101,35 @@ Carsten Bock
 
 
    List of Examples
    List of Examples
 
 
-   1.1. Set the “list_file� parameter
-   1.2. Set “db_url� parameter
-   1.3. Set “table_name� parameter
-   1.4. Set “setid_col� parameter
-   1.5. Set “destination_col� parameter
-   1.6. Set “flags_col� parameter
-   1.7. Set “priority_col� parameter
-   1.8. Set the “force_dst� parameter
-   1.9. Set the “flags� parameter
-   1.10. Set the “use_default� parameter
-   1.11. Set the “dst_avp� parameter
-   1.12. Set the “grp_avp� parameter
-   1.13. Set the “cnt_avp� parameter
-   1.14. Set the “dstid_avp� parameter
-   1.15. Set the “attrs_avp� parameter
+   1.1. Set the "list_file" parameter
+   1.2. Set "db_url" parameter
+   1.3. Set "table_name" parameter
+   1.4. Set "setid_col" parameter
+   1.5. Set "destination_col" parameter
+   1.6. Set "flags_col" parameter
+   1.7. Set "priority_col" parameter
+   1.8. Set the "force_dst" parameter
+   1.9. Set the "flags" parameter
+   1.10. Set the "use_default" parameter
+   1.11. Set the "dst_avp" parameter
+   1.12. Set the "grp_avp" parameter
+   1.13. Set the "cnt_avp" parameter
+   1.14. Set the "dstid_avp" parameter
+   1.15. Set the "attrs_avp" parameter
    1.16. Use $avp(i:273) for hashing:
    1.16. Use $avp(i:273) for hashing:
    1.17. Use combination of PVs for hashing:
    1.17. Use combination of PVs for hashing:
-   1.18. Set the “setid_pvar� parameter
-   1.19. Set the “ds_ping_method� parameter
-   1.20. Set the “ds_ping_from� parameter
-   1.21. Set the “ds_ping_interval� parameter
-   1.22. Set the “ds_probing_threshhold� parameter
-   1.23. Set the “ds_ping_reply_codes� parameter
-   1.24. Set the “ds_probing_mode� parameter
-   1.25. Set the “ds_hash_size� parameter
-   1.26. Set the “ds_hash_expire� parameter
-   1.27. Set the “ds_hash_initexpire� parameter
-   1.28. Set the “ds_hash_check_interval� parameter
-   1.29. Set the “outbound_proxy� parameter
+   1.18. Set the "setid_pvar" parameter
+   1.19. Set the "ds_ping_method" parameter
+   1.20. Set the "ds_ping_from" parameter
+   1.21. Set the "ds_ping_interval" parameter
+   1.22. Set the "ds_probing_threshhold" parameter
+   1.23. Set the "ds_ping_reply_codes" parameter
+   1.24. Set the "ds_probing_mode" parameter
+   1.25. Set the "ds_hash_size" parameter
+   1.26. Set the "ds_hash_expire" parameter
+   1.27. Set the "ds_hash_initexpire" parameter
+   1.28. Set the "ds_hash_check_interval" parameter
+   1.29. Set the "outbound_proxy" parameter
    1.30. ds_select_dst usage
    1.30. ds_select_dst usage
    1.31. ds_mark_dst usage
    1.31. ds_mark_dst usage
    1.32. ds_mark_dst usage
    1.32. ds_mark_dst usage
@@ -280,10 +280,10 @@ Chapter 1. Admin Guide
 
 
    Path to the file with destination sets.
    Path to the file with destination sets.
 
 
-   Default value is “/etc/kamailio/dispatcher.list� or
-   “/usr/local/etc/kamailio/dispatcher.list�.
+   Default value is "/etc/kamailio/dispatcher.list" or
+   "/usr/local/etc/kamailio/dispatcher.list".
 
 
-   Example 1.1. Set the “list_file� parameter
+   Example 1.1. Set the "list_file" parameter
 ...
 ...
 modparam("dispatcher", "list_file", "/var/run/kamailio/dispatcher.list")
 modparam("dispatcher", "list_file", "/var/run/kamailio/dispatcher.list")
 ...
 ...
@@ -293,9 +293,9 @@ modparam("dispatcher", "list_file", "/var/run/kamailio/dispatcher.list")
    If you want to load the sets of gateways from the database you must set
    If you want to load the sets of gateways from the database you must set
    this parameter.
    this parameter.
 
 
-   Default value is “NULL� (disable DB support).
+   Default value is "NULL" (disable DB support).
 
 
-   Example 1.2. Set “db_url� parameter
+   Example 1.2. Set "db_url" parameter
 ...
 ...
 modparam("dispatcher", "db_url", "mysql://user:passwb@localhost/database")
 modparam("dispatcher", "db_url", "mysql://user:passwb@localhost/database")
 ...
 ...
@@ -305,9 +305,9 @@ modparam("dispatcher", "db_url", "mysql://user:passwb@localhost/database")
    If you want to load the sets of gateways from the database you must set
    If you want to load the sets of gateways from the database you must set
    this parameter as the database name.
    this parameter as the database name.
 
 
-   Default value is “dispatcher�.
+   Default value is "dispatcher".
 
 
-   Example 1.3. Set “table_name� parameter
+   Example 1.3. Set "table_name" parameter
 ...
 ...
 modparam("dispatcher", "table_name", "my_dispatcher")
 modparam("dispatcher", "table_name", "my_dispatcher")
 ...
 ...
@@ -316,9 +316,9 @@ modparam("dispatcher", "table_name", "my_dispatcher")
 
 
    The column's name in the database storing the gateway's group id.
    The column's name in the database storing the gateway's group id.
 
 
-   Default value is “setid�.
+   Default value is "setid".
 
 
-   Example 1.4. Set “setid_col� parameter
+   Example 1.4. Set "setid_col" parameter
 ...
 ...
 modparam("dispatcher", "setid_col", "groupid")
 modparam("dispatcher", "setid_col", "groupid")
 ...
 ...
@@ -327,9 +327,9 @@ modparam("dispatcher", "setid_col", "groupid")
 
 
    The column's name in the database storing the destination's sip uri.
    The column's name in the database storing the destination's sip uri.
 
 
-   Default value is “destination�.
+   Default value is "destination".
 
 
-   Example 1.5. Set “destination_col� parameter
+   Example 1.5. Set "destination_col" parameter
 ...
 ...
 modparam("dispatcher", "destination_col", "uri")
 modparam("dispatcher", "destination_col", "uri")
 ...
 ...
@@ -339,9 +339,9 @@ modparam("dispatcher", "destination_col", "uri")
    The column's name in the database storing the flags for destination
    The column's name in the database storing the flags for destination
    uri.
    uri.
 
 
-   Default value is “flags�.
+   Default value is "flags".
 
 
-   Example 1.6. Set “flags_col� parameter
+   Example 1.6. Set "flags_col" parameter
 ...
 ...
 modparam("dispatcher", "flags_col", "dstflags")
 modparam("dispatcher", "flags_col", "dstflags")
 ...
 ...
@@ -351,9 +351,9 @@ modparam("dispatcher", "flags_col", "dstflags")
    The column's name in the database storing the priority for destination
    The column's name in the database storing the priority for destination
    uri.
    uri.
 
 
-   Default value is “priority�.
+   Default value is "priority".
 
 
-   Example 1.7. Set “priority_col� parameter
+   Example 1.7. Set "priority_col" parameter
 ...
 ...
 modparam("dispatcher", "priority_col", "dstpriority")
 modparam("dispatcher", "priority_col", "dstpriority")
 ...
 ...
@@ -364,9 +364,9 @@ modparam("dispatcher", "priority_col", "dstpriority")
    when that is already set. If set to 0, will return error when the
    when that is already set. If set to 0, will return error when the
    destination address is already set.
    destination address is already set.
 
 
-   Default value is “1�.
+   Default value is "1".
 
 
-   Example 1.8. Set the “force_dst� parameter
+   Example 1.8. Set the "force_dst" parameter
 ...
 ...
 modparam("dispatcher", "force_dst", 1)
 modparam("dispatcher", "force_dst", 1)
 ...
 ...
@@ -385,9 +385,9 @@ modparam("dispatcher", "force_dst", 1)
    destination set in AVP, and use these AVPs to contact next address when
    destination set in AVP, and use these AVPs to contact next address when
    the current-tried fails.
    the current-tried fails.
 
 
-   Default value is “0�.
+   Default value is "0".
 
 
-   Example 1.9. Set the “flags� parameter
+   Example 1.9. Set the "flags" parameter
  ...
  ...
  modparam("dispatcher", "flags", 3)
  modparam("dispatcher", "flags", 3)
  ...
  ...
@@ -399,9 +399,9 @@ modparam("dispatcher", "force_dst", 1)
    wanting to send the call to an anouncement server saying: "the gateways
    wanting to send the call to an anouncement server saying: "the gateways
    are full, try later".
    are full, try later".
 
 
-   Default value is “0�.
+   Default value is "0".
 
 
-   Example 1.10. Set the “use_default� parameter
+   Example 1.10. Set the "use_default" parameter
  ...
  ...
  modparam("dispatcher", "use_default", 1)
  modparam("dispatcher", "use_default", 1)
  ...
  ...
@@ -419,9 +419,9 @@ Note
 
 
    You must set this parameter if you want to do load balancing fail over.
    You must set this parameter if you want to do load balancing fail over.
 
 
-   Default value is “null� - don't add AVPs.
+   Default value is "null" - don't add AVPs.
 
 
-   Example 1.11. Set the “dst_avp� parameter
+   Example 1.11. Set the "dst_avp" parameter
  ...
  ...
  modparam("dispatcher", "dst_avp", "$avp(dsdst)")
  modparam("dispatcher", "dst_avp", "$avp(dsdst)")
  ...
  ...
@@ -435,9 +435,9 @@ Note
 
 
    You must set this parameter if you want to do load balancing fail over.
    You must set this parameter if you want to do load balancing fail over.
 
 
-   Default value is “null� - don't add AVP.
+   Default value is "null" - don't add AVP.
 
 
-   Example 1.12. Set the “grp_avp� parameter
+   Example 1.12. Set the "grp_avp" parameter
  ...
  ...
  modparam("dispatcher", "grp_avp", "$avp(dsgrp)")
  modparam("dispatcher", "grp_avp", "$avp(dsgrp)")
  ...
  ...
@@ -451,9 +451,9 @@ Note
 
 
    You must set this parameter if you want to do load balancing fail over.
    You must set this parameter if you want to do load balancing fail over.
 
 
-   Default value is “null� - don't add AVP.
+   Default value is "null" - don't add AVP.
 
 
-   Example 1.13. Set the “cnt_avp� parameter
+   Example 1.13. Set the "cnt_avp" parameter
  ...
  ...
  modparam("dispatcher", "cnt_avp", "$avp(dscnt)")
  modparam("dispatcher", "cnt_avp", "$avp(dscnt)")
  ...
  ...
@@ -468,9 +468,9 @@ Note
    You must set this parameter if you want to do load balancing on call
    You must set this parameter if you want to do load balancing on call
    load (alg 10).
    load (alg 10).
 
 
-   Default value is “null� - don't add AVP.
+   Default value is "null" - don't add AVP.
 
 
-   Example 1.14. Set the “dstid_avp� parameter
+   Example 1.14. Set the "dstid_avp" parameter
  ...
  ...
  modparam("dispatcher", "dstid_avp", "$avp(dsdstid)")
  modparam("dispatcher", "dstid_avp", "$avp(dsdstid)")
  ...
  ...
@@ -481,9 +481,9 @@ Note
 
 
 Note
 Note
 
 
-   Default value is “null� - don't add AVP.
+   Default value is "null" - don't add AVP.
 
 
-   Example 1.15. Set the “attrs_avp� parameter
+   Example 1.15. Set the "attrs_avp" parameter
  ...
  ...
  modparam("dispatcher", "attrs_avp", "$avp(dsattrs)")
  modparam("dispatcher", "attrs_avp", "$avp(dsattrs)")
  ...
  ...
@@ -497,7 +497,7 @@ Note
    You must set this parameter if you want do hashing over custom message
    You must set this parameter if you want do hashing over custom message
    parts.
    parts.
 
 
-   Default value is “null� - disabled.
+   Default value is "null" - disabled.
 
 
    Example 1.16. Use $avp(i:273) for hashing:
    Example 1.16. Use $avp(i:273) for hashing:
  ...
  ...
@@ -514,9 +514,9 @@ Note
    The name of the PV where to store the set ID (group ID) when calling
    The name of the PV where to store the set ID (group ID) when calling
    ds_is_from_list() with no parameter.
    ds_is_from_list() with no parameter.
 
 
-   Default value is “null� - don't set PV.
+   Default value is "null" - don't set PV.
 
 
-   Example 1.18. Set the “setid_pvar� parameter
+   Example 1.18. Set the "setid_pvar" parameter
  ...
  ...
  modparam("dispatcher", "setid_pvar", "$var(setid)")
  modparam("dispatcher", "setid_pvar", "$var(setid)")
  ...
  ...
@@ -527,9 +527,9 @@ Note
    the gateways. Pinging gateways feature depends on ds_ping_interval
    the gateways. Pinging gateways feature depends on ds_ping_interval
    parameter.
    parameter.
 
 
-   Default value is “OPTIONS�.
+   Default value is "OPTIONS".
 
 
-   Example 1.19. Set the “ds_ping_method� parameter
+   Example 1.19. Set the "ds_ping_method" parameter
  ...
  ...
  modparam("dispatcher", "ds_ping_method", "INFO")
  modparam("dispatcher", "ds_ping_method", "INFO")
  ...
  ...
@@ -540,9 +540,9 @@ Note
    to the failed gateways. This method is only available, if compiled with
    to the failed gateways. This method is only available, if compiled with
    the probing of failed gateways enabled.
    the probing of failed gateways enabled.
 
 
-   Default value is “sip:dispatcher@localhost�.
+   Default value is "sip:dispatcher@localhost".
 
 
-   Example 1.20. Set the “ds_ping_from� parameter
+   Example 1.20. Set the "ds_ping_from" parameter
  ...
  ...
  modparam("dispatcher", "ds_ping_from", "sip:[email protected]")
  modparam("dispatcher", "ds_ping_from", "sip:[email protected]")
  ...
  ...
@@ -552,11 +552,11 @@ Note
    With this parameter you can define the interval for sending a request
    With this parameter you can define the interval for sending a request
    to a gateway marked as inactive upon a failed request routing to it.
    to a gateway marked as inactive upon a failed request routing to it.
    This parameter is only used, when the TM-Module is loaded. If set to
    This parameter is only used, when the TM-Module is loaded. If set to
-   “0�, the pinging of inactive gateway is disabled.
+   "0", the pinging of inactive gateway is disabled.
 
 
-   Default value is “0�.
+   Default value is "0".
 
 
-   Example 1.21. Set the “ds_ping_interval� parameter
+   Example 1.21. Set the "ds_ping_interval" parameter
  ...
  ...
  modparam("dispatcher", "ds_ping_interval", 30)
  modparam("dispatcher", "ds_ping_interval", 30)
  ...
  ...
@@ -570,9 +570,9 @@ Note
    The number of attempts can be set with this parameter. This parameter
    The number of attempts can be set with this parameter. This parameter
    can be modified via ser config framework.
    can be modified via ser config framework.
 
 
-   Default value is “1� (set inactive with first failure).
+   Default value is "1" (set inactive with first failure).
 
 
-   Example 1.22. Set the “ds_probing_threshhold� parameter
+   Example 1.22. Set the "ds_probing_threshhold" parameter
  ...
  ...
  modparam("dispatcher", "ds_probing_threshhold", 10)
  modparam("dispatcher", "ds_probing_threshhold", 10)
  ...
  ...
@@ -587,9 +587,9 @@ Note
    valid response). This parameter can be modified via ser config
    valid response). This parameter can be modified via ser config
    framework.
    framework.
 
 
-   Default value is “� (only 200 OK is accepted).
+   Default value is "" (only 200 OK is accepted).
 
 
-   Example 1.23. Set the “ds_ping_reply_codes� parameter
+   Example 1.23. Set the "ds_ping_reply_codes" parameter
  ...
  ...
  modparam("dispatcher", "ds_ping_reply_codes", "class=2;code=403;code=488;class=
  modparam("dispatcher", "ds_ping_reply_codes", "class=2;code=403;code=488;class=
 3")
 3")
@@ -603,9 +603,9 @@ Note
    probing mode set are tested. If set to 1 and there is a failure of
    probing mode set are tested. If set to 1 and there is a failure of
    keepalive to an active gateway, then it is set to TRYING state.
    keepalive to an active gateway, then it is set to TRYING state.
 
 
-   Default value is “0�.
+   Default value is "0".
 
 
-   Example 1.24. Set the “ds_probing_mode� parameter
+   Example 1.24. Set the "ds_probing_mode" parameter
  ...
  ...
  modparam("dispatcher", "ds_probing_mode", 1)
  modparam("dispatcher", "ds_probing_mode", 1)
  ...
  ...
@@ -617,9 +617,9 @@ Note
    a hash table with 256 slots). It must be greater than 0 to enable call
    a hash table with 256 slots). It must be greater than 0 to enable call
    load dispatching feature (alg 10).
    load dispatching feature (alg 10).
 
 
-   Default value is “0�.
+   Default value is "0".
 
 
-   Example 1.25. Set the “ds_hash_size� parameter
+   Example 1.25. Set the "ds_hash_size" parameter
  ...
  ...
  modparam("dispatcher", "ds_hash_size", 9)
  modparam("dispatcher", "ds_hash_size", 9)
  ...
  ...
@@ -629,9 +629,9 @@ Note
    Expiration time in seconds to remove the load on a destination if no
    Expiration time in seconds to remove the load on a destination if no
    BYE was received meanwhile.
    BYE was received meanwhile.
 
 
-   Default value is “7200�.
+   Default value is "7200".
 
 
-   Example 1.26. Set the “ds_hash_expire� parameter
+   Example 1.26. Set the "ds_hash_expire" parameter
  ...
  ...
  modparam("dispatcher", "ds_hash_expire", 3600)
  modparam("dispatcher", "ds_hash_expire", 3600)
  ...
  ...
@@ -642,9 +642,9 @@ Note
    200 for INVITE was received meanwhile and state updated with
    200 for INVITE was received meanwhile and state updated with
    ds_load_update().
    ds_load_update().
 
 
-   Default value is “7200�.
+   Default value is "7200".
 
 
-   Example 1.27. Set the “ds_hash_initexpire� parameter
+   Example 1.27. Set the "ds_hash_initexpire" parameter
  ...
  ...
  modparam("dispatcher", "ds_hash_initexpire", 60)
  modparam("dispatcher", "ds_hash_initexpire", 60)
  ...
  ...
@@ -654,9 +654,9 @@ Note
    Time interval in seconds to scan internal hash table with call load
    Time interval in seconds to scan internal hash table with call load
    dispatching data for expired items.
    dispatching data for expired items.
 
 
-   Default value is “30�.
+   Default value is "30".
 
 
-   Example 1.28. Set the “ds_hash_check_interval� parameter
+   Example 1.28. Set the "ds_hash_check_interval" parameter
  ...
  ...
  modparam("dispatcher", "ds_hash_check_interval", 60)
  modparam("dispatcher", "ds_hash_check_interval", 60)
  ...
  ...
@@ -667,7 +667,7 @@ Note
 
 
    By default no outbound proxy is defined.
    By default no outbound proxy is defined.
 
 
-   Example 1.29. Set the “outbound_proxy� parameter
+   Example 1.29. Set the "outbound_proxy" parameter
  ...
  ...
  modparam("dispatcher", "outbound_proxy", "sip:outbound.example.com")
  modparam("dispatcher", "outbound_proxy", "sip:outbound.example.com")
  ...
  ...
@@ -683,7 +683,7 @@ Note
    4.7. ds_load_update()
    4.7. ds_load_update()
    4.8. ds_load_unset()
    4.8. ds_load_unset()
 
 
-4.1.  ds_select_dst(set, alg)
+4.1. ds_select_dst(set, alg)
 
 
    The method selects a destination from addresses set.
    The method selects a destination from addresses set.
 
 
@@ -693,21 +693,21 @@ Note
        be an integer or a variable holding an interger.
        be an integer or a variable holding an interger.
      * alg - the algorithm used to select the destination address. The
      * alg - the algorithm used to select the destination address. The
        parameter can be an integer or a variable holding an interger.
        parameter can be an integer or a variable holding an interger.
-          + “0� - hash over callid
-          + “1� - hash over from uri.
-          + “2� - hash over to uri.
-          + “3� - hash over request-uri.
-          + “4� - round-robin (next destination).
-          + “5� - hash over authorization-username (Proxy-Authorization or
+          + "0" - hash over callid
+          + "1" - hash over from uri.
+          + "2" - hash over to uri.
+          + "3" - hash over request-uri.
+          + "4" - round-robin (next destination).
+          + "5" - hash over authorization-username (Proxy-Authorization or
             "normal" authorization). If no username is found, round robin
             "normal" authorization). If no username is found, round robin
             is used.
             is used.
-          + “6� - random (using rand()).
-          + “7� - hash over the content of PVs string. Note: This works
+          + "6" - random (using rand()).
+          + "7" - hash over the content of PVs string. Note: This works
             only when the parameter hash_pvar is set.
             only when the parameter hash_pvar is set.
-          + “8� - use first destination (good for failover).
-          + “9� - use weight based load distribution. You have to set the
+          + "8" - use first destination (good for failover).
+          + "9" - use weight based load distribution. You have to set the
             attribute 'weight' per each address in destination set.
             attribute 'weight' per each address in destination set.
-          + “10� - use call load distribution. You have to set the
+          + "10" - use call load distribution. You have to set the
             attribute 'duid' (as an unique string id) per each address in
             attribute 'duid' (as an unique string id) per each address in
             destination set. Also, you must set parameters 'dstid_avp' and
             destination set. Also, you must set parameters 'dstid_avp' and
             'ds_hash_size'.
             'ds_hash_size'.
@@ -722,7 +722,7 @@ Note
             on each address can change.
             on each address can change.
             This algorithm can be used only for dispatching INVITE
             This algorithm can be used only for dispatching INVITE
             requests as it is the only SIP method creating a SIP call.
             requests as it is the only SIP method creating a SIP call.
-          + “X� - if the algorithm is not implemented, the first entry in
+          + "X" - if the algorithm is not implemented, the first entry in
             set is chosen.
             set is chosen.
 
 
    If the bit 2 in 'flags' is set, the rest of the addresses from the
    If the bit 2 in 'flags' is set, the rest of the addresses from the
@@ -740,7 +740,7 @@ $var(a) = 4;
 ds_select_dst("1", "$var(a)");
 ds_select_dst("1", "$var(a)");
 ...
 ...
 
 
-4.2.  ds_select_domain(set, alg)
+4.2. ds_select_domain(set, alg)
 
 
    The method selects a destination from addresses set and rewrites the
    The method selects a destination from addresses set and rewrites the
    host and port from R-URI. The parameters have same meaning as for
    host and port from R-URI. The parameters have same meaning as for
@@ -753,21 +753,21 @@ ds_select_dst("1", "$var(a)");
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
 
-4.3.  ds_next_dst()
+4.3. ds_next_dst()
 
 
    Takes the next destination address from the AVPs with id 'dst_avp_id'
    Takes the next destination address from the AVPs with id 'dst_avp_id'
    and sets the dst_uri (outbound proxy address).
    and sets the dst_uri (outbound proxy address).
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
 
-4.4.  ds_next_domain()
+4.4. ds_next_domain()
 
 
    Takes the next destination address from the AVPs with id 'dst_avp_id'
    Takes the next destination address from the AVPs with id 'dst_avp_id'
    and sets the domain part of the request uri.
    and sets the domain part of the request uri.
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
 
-4.5.  ds_mark_dst([state])
+4.5. ds_mark_dst([state])
 
 
    Mark the last used address from destination set as inactive ("i"/"I"),
    Mark the last used address from destination set as inactive ("i"/"I"),
    active ("a"/"A"), disabled ("d"/"D") or trying ("t"/"T"). Apart of
    active ("a"/"A"), disabled ("d"/"D") or trying ("t"/"T"). Apart of
@@ -804,7 +804,7 @@ failure_route[tryagain] {
 }
 }
 ...
 ...
 
 
-4.6.  ds_is_from_list([groupid])
+4.6. ds_is_from_list([groupid])
 
 
    This function returns true, if the current request comes from a host in
    This function returns true, if the current request comes from a host in
    the given group of the dispatcher-list; otherwise false.
    the given group of the dispatcher-list; otherwise false.
@@ -822,7 +822,7 @@ if(ds_is_from_list("10")) {
 }
 }
 ...
 ...
 
 
-4.7.  ds_load_update()
+4.7. ds_load_update()
 
 
    Updates the load state:
    Updates the load state:
      * if it is a BYE or CANCEL - remove the load from destination address
      * if it is a BYE or CANCEL - remove the load from destination address
@@ -833,7 +833,7 @@ if(ds_is_from_list("10")) {
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
 
-4.8.  ds_load_unset()
+4.8. ds_load_unset()
 
 
    Remove the call load for the destination that routed the call.
    Remove the call load for the destination that routed the call.
 
 
@@ -870,7 +870,7 @@ onreply_route {
    5.2. ds_list
    5.2. ds_list
    5.3. ds_reload
    5.3. ds_reload
 
 
-5.1.  ds_set_state
+5.1. ds_set_state
 
 
    Sets the status for a destination address (can be use to mark the
    Sets the status for a destination address (can be use to mark the
    destination as active or inactive).
    destination as active or inactive).
@@ -879,11 +879,11 @@ onreply_route {
 
 
    Parameters:
    Parameters:
      * _state_ : state of the destination address
      * _state_ : state of the destination address
-          + “a�: active
-          + “i�: inactive
-          + “t�: trying
-          + “d�: disabled
-       The states “a�, “i� or “t� can be followed by “p� to set probing
+          + "a": active
+          + "i": inactive
+          + "t": trying
+          + "d": disabled
+       The states "a", "i" or "t" can be followed by "p" to set probing
        mode (e.g. 'ap', 'ip' or 'tp').
        mode (e.g. 'ap', 'ip' or 'tp').
      * _group_: destination group id
      * _group_: destination group id
      * _address_: address of the destination in the _group_
      * _address_: address of the destination in the _group_
@@ -895,7 +895,7 @@ onreply_route {
                 _address_
                 _address_
                 _empty_line_
                 _empty_line_
 
 
-5.2.  ds_list
+5.2. ds_list
 
 
    It lists the groups and included destinations.
    It lists the groups and included destinations.
 
 
@@ -907,7 +907,7 @@ onreply_route {
                 :ds_list:_reply_fifo_file_
                 :ds_list:_reply_fifo_file_
                 _empty_line_
                 _empty_line_
 
 
-5.3.  ds_reload
+5.3. ds_reload
 
 
    It reloads the groups and included destinations. The command is
    It reloads the groups and included destinations. The command is
    disabled for call load based dispatching (algorithm 10) since removal
    disabled for call load based dispatching (algorithm 10) since removal
@@ -927,7 +927,7 @@ onreply_route {
    6.2. dispatcher.list
    6.2. dispatcher.list
    6.3. dispatcher.reload
    6.3. dispatcher.reload
 
 
-6.1.  dispatcher.set_state
+6.1. dispatcher.set_state
 
 
    Sets the state for a destination address (can be use to mark the
    Sets the state for a destination address (can be use to mark the
    destination as active or inactive).
    destination as active or inactive).
@@ -936,11 +936,11 @@ onreply_route {
 
 
    Parameters:
    Parameters:
      * _state_ : state of the destination address
      * _state_ : state of the destination address
-          + “a�: active
-          + “i�: inactive
-          + “t�: trying
-          + “d�: disabled
-       The states “a�, “i� or “t� can be followed by “p� to set probing
+          + "a": active
+          + "i": inactive
+          + "t": trying
+          + "d": disabled
+       The states "a", "i" or "t" can be followed by "p" to set probing
        mode (e.g. 'ap', 'ip' or 'tp').
        mode (e.g. 'ap', 'ip' or 'tp').
      * _group_: destination group id
      * _group_: destination group id
      * _address_: address of the destination in the _group_
      * _address_: address of the destination in the _group_
@@ -951,7 +951,7 @@ onreply_route {
 sercmd dispatcher.set_state ip 2 sip:127.0.0.1:5080
 sercmd dispatcher.set_state ip 2 sip:127.0.0.1:5080
 ...
 ...
 
 
-6.2.  dispatcher.list
+6.2. dispatcher.list
 
 
    It lists the groups and included destinations.
    It lists the groups and included destinations.
 
 
@@ -962,7 +962,7 @@ sercmd dispatcher.set_state ip 2 sip:127.0.0.1:5080
    Example:
    Example:
                 sercmd dispatcher.list
                 sercmd dispatcher.list
 
 
-6.3.  dispatcher.reload
+6.3. dispatcher.reload
 
 
    It reloads the groups and included destinations. The command is
    It reloads the groups and included destinations. The command is
    disabled for call load based dispatching (algorithm 10) since removal
    disabled for call load based dispatching (algorithm 10) since removal
@@ -1324,7 +1324,7 @@ failure_route[RTF_DISPATCH] {
    8.1. dispatcher:dst-down
    8.1. dispatcher:dst-down
    8.2. dispatcher:dst-up
    8.2. dispatcher:dst-up
 
 
-8.1.  dispatcher:dst-down
+8.1. dispatcher:dst-down
 
 
    When defined, the module calls event_route[dispatcher:ds-down] when a
    When defined, the module calls event_route[dispatcher:ds-down] when a
    destination goes down (becomes probing). A typical use case is to
    destination goes down (becomes probing). A typical use case is to
@@ -1335,7 +1335,7 @@ event_route[dispatcher:dst-down] {
 }
 }
 ...
 ...
 
 
-8.2.  dispatcher:dst-up
+8.2. dispatcher:dst-up
 
 
    When defined, the module calls event_route[dispatcher:ds-up] when a
    When defined, the module calls event_route[dispatcher:ds-up] when a
    destination that was previously down (probing) comes up. A typical use
    destination that was previously down (probing) comes up. A typical use

+ 9 - 9
modules_k/imc/README

@@ -14,7 +14,7 @@ Edited by
 
 
 Anca-Maria Vamanu
 Anca-Maria Vamanu
 
 
-   Copyright © 2006 Voice Sistem SRL
+   Copyright © 2006 Voice Sistem SRL
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -46,7 +46,7 @@ Anca-Maria Vamanu
               5.1. imc_list_rooms
               5.1. imc_list_rooms
               5.2. imc_list_members
               5.2. imc_list_members
 
 
-        6. Exported Statistics
+        6. Statistics
 
 
               6.1. active_rooms
               6.1. active_rooms
 
 
@@ -94,7 +94,7 @@ Chapter 1. Admin Guide
         5.1. imc_list_rooms
         5.1. imc_list_rooms
         5.2. imc_list_members
         5.2. imc_list_members
 
 
-   6. Exported Statistics
+   6. Statistics
 
 
         6.1. active_rooms
         6.1. active_rooms
 
 
@@ -149,7 +149,7 @@ Chapter 1. Admin Guide
 
 
    The database url.
    The database url.
 
 
-   The default value is “mysql://openser:openserrw@localhost/openser�.
+   The default value is "mysql://openser:openserrw@localhost/openser".
 
 
    Example 1.1. Set db_url parameter
    Example 1.1. Set db_url parameter
 ...
 ...
@@ -232,7 +232,7 @@ modparam("imc", "extra_hdrs", "P-Flags: 3\r\n")
 
 
    4.1. imc_manager()
    4.1. imc_manager()
 
 
-4.1.  imc_manager()
+4.1. imc_manager()
 
 
    Handles Message method.It detects if the body of the message is a
    Handles Message method.It detects if the body of the message is a
    conference command.If so it executes it, otherwise it sends the message
    conference command.If so it executes it, otherwise it sends the message
@@ -261,7 +261,7 @@ if(is_method("MESSAGE)
    5.1. imc_list_rooms
    5.1. imc_list_rooms
    5.2. imc_list_members
    5.2. imc_list_members
 
 
-5.1.  imc_list_rooms
+5.1. imc_list_rooms
 
 
    Lists of the IM Conferencing rooms.
    Lists of the IM Conferencing rooms.
 
 
@@ -273,7 +273,7 @@ if(is_method("MESSAGE)
                 :imc_list_rooms:_reply_fifo_file_
                 :imc_list_rooms:_reply_fifo_file_
                 _empty_line_
                 _empty_line_
 
 
-5.2.  imc_list_members
+5.2. imc_list_members
 
 
    Listing of the members in IM Conferencing rooms.
    Listing of the members in IM Conferencing rooms.
 
 
@@ -287,11 +287,11 @@ if(is_method("MESSAGE)
                 _room_
                 _room_
                 _empty_line_
                 _empty_line_
 
 
-6. Exported Statistics
+6. Statistics
 
 
    6.1. active_rooms
    6.1. active_rooms
 
 
-6.1.  active_rooms
+6.1. active_rooms
 
 
    Number of active IM Conferencing rooms.
    Number of active IM Conferencing rooms.
 
 

+ 101 - 101
modules_k/msilo/README

@@ -20,9 +20,9 @@ Juha Heinanen
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2003 FhG FOKUS
+   Copyright © 2003 FhG FOKUS
 
 
-   Copyright © 2009 Juha Heinanen
+   Copyright © 2009 Juha Heinanen
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -72,7 +72,7 @@ Juha Heinanen
               4.1. m_store([owner])
               4.1. m_store([owner])
               4.2. m_dump([owner])
               4.2. m_dump([owner])
 
 
-        5. Exported Statistics
+        5. Statistics
 
 
               5.1. stored_messages
               5.1. stored_messages
               5.2. dumped_messages
               5.2. dumped_messages
@@ -86,35 +86,35 @@ Juha Heinanen
 
 
    List of Examples
    List of Examples
 
 
-   1.1. Set the “db_url� parameter
-   1.2. Set the “db_table� parameter
-   1.3. Set the “from_address� parameter
-   1.4. Set the “contact_hdr� parameter
-   1.5. Set the “extra_hdrs� parameter
-   1.6. Set the “offline_message� parameter
-   1.7. Set the “content_type_hdr� parameter
-   1.8. Set the “reminder� parameter
-   1.9. Set the “outbound_proxy� parameter
-   1.10. Set the “expire_time� parameter
-   1.11. Set the “check_time� parameter
-   1.12. Set the “send_time� parameter
-   1.13. Set the “clean_period� parameter
-   1.14. Set the “use_contact� parameter
-   1.15. Set the “sc_mid� parameter
-   1.16. Set the “sc_from� parameter
-   1.17. Set the “sc_to� parameter
-   1.18. Set the “sc_uri_user� parameter
-   1.19. Set the “sc_uri_host� parameter
-   1.20. Set the “sc_body� parameter
-   1.21. Set the “sc_ctype� parameter
-   1.22. Set the “sc_exp_time� parameter
-   1.23. Set the “sc_inc_time� parameter
-   1.24. Set the “sc_snd_time� parameter
-   1.25. Set the “snd_time_avp� parameter
-   1.26. Set the “add_date� parameter
-   1.27. Set the “max_messages� parameter
-   1.28. Set the “add_contact� parameter
-   1.29. Set the “extra_hdrs_avp� parameter
+   1.1. Set the "db_url" parameter
+   1.2. Set the "db_table" parameter
+   1.3. Set the "from_address" parameter
+   1.4. Set the "contact_hdr" parameter
+   1.5. Set the "extra_hdrs" parameter
+   1.6. Set the "offline_message" parameter
+   1.7. Set the "content_type_hdr" parameter
+   1.8. Set the "reminder" parameter
+   1.9. Set the "outbound_proxy" parameter
+   1.10. Set the "expire_time" parameter
+   1.11. Set the "check_time" parameter
+   1.12. Set the "send_time" parameter
+   1.13. Set the "clean_period" parameter
+   1.14. Set the "use_contact" parameter
+   1.15. Set the "sc_mid" parameter
+   1.16. Set the "sc_from" parameter
+   1.17. Set the "sc_to" parameter
+   1.18. Set the "sc_uri_user" parameter
+   1.19. Set the "sc_uri_host" parameter
+   1.20. Set the "sc_body" parameter
+   1.21. Set the "sc_ctype" parameter
+   1.22. Set the "sc_exp_time" parameter
+   1.23. Set the "sc_inc_time" parameter
+   1.24. Set the "sc_snd_time" parameter
+   1.25. Set the "snd_time_avp" parameter
+   1.26. Set the "add_date" parameter
+   1.27. Set the "max_messages" parameter
+   1.28. Set the "add_contact" parameter
+   1.29. Set the "extra_hdrs_avp" parameter
    1.30. m_store usage
    1.30. m_store usage
    1.31. m_dump usage
    1.31. m_dump usage
    1.32. Kamailio config script - sample msilo usage
    1.32. Kamailio config script - sample msilo usage
@@ -166,7 +166,7 @@ Chapter 1. Admin Guide
         4.1. m_store([owner])
         4.1. m_store([owner])
         4.2. m_dump([owner])
         4.2. m_dump([owner])
 
 
-   5. Exported Statistics
+   5. Statistics
 
 
         5.1. stored_messages
         5.1. stored_messages
         5.2. dumped_messages
         5.2. dumped_messages
@@ -184,12 +184,12 @@ Chapter 1. Admin Guide
    Server Platform. It stores received messages for an offline user and
    Server Platform. It stores received messages for an offline user and
    sends them when the user becomes online.
    sends them when the user becomes online.
 
 
-   For each message, the modules stores “Request-URI� (“R-URI�) only if it
-   is a complete address of record (“username@hostname�), URI from “To�
-   header, URI from “From� header, incoming time, expiration time, content
-   type and body of the message. If “R-URI� is not an address of record
+   For each message, the modules stores "Request-URI" ("R-URI") only if it
+   is a complete address of record ("username@hostname"), URI from "To"
+   header, URI from "From" header, incoming time, expiration time, content
+   type and body of the message. If "R-URI" is not an address of record
    (it might be the contact address for current SIP session) the URI from
    (it might be the contact address for current SIP session) the URI from
-   “To� header will be used as R-URI.
+   "To" header will be used as R-URI.
 
 
    When the expiration time passed, the message is discarded from
    When the expiration time passed, the message is discarded from
    database. Expiration time is computed based on incoming time and one of
    database. Expiration time is computed based on incoming time and one of
@@ -201,7 +201,7 @@ Chapter 1. Admin Guide
 
 
    It may happen the SIP user to be registered but his SIP User Agent to
    It may happen the SIP user to be registered but his SIP User Agent to
    have no support for MESSAGE request. In this case it should be used the
    have no support for MESSAGE request. In this case it should be used the
-   “failure_route� to store the undelivered requests.
+   "failure_route" to store the undelivered requests.
 
 
    Another functionality provided by the modules is to send messages at a
    Another functionality provided by the modules is to send messages at a
    certain time -- the reminder functionality. Using config logic, a
    certain time -- the reminder functionality. Using config logic, a
@@ -217,7 +217,7 @@ Chapter 1. Admin Guide
 
 
    The following modules must be loaded before this module:
    The following modules must be loaded before this module:
      * database module - mysql, dbtext or other module that implements the
      * database module - mysql, dbtext or other module that implements the
-       “db� interface and provides support for storing/receiving data
+       "db" interface and provides support for storing/receiving data
        to/from a database system.
        to/from a database system.
      * TM--transaction module--is used to send SIP requests.
      * TM--transaction module--is used to send SIP requests.
 
 
@@ -263,9 +263,9 @@ Chapter 1. Admin Guide
 
 
    Database URL.
    Database URL.
 
 
-   Default value is “mysql://openser:openserrw@localhost/openser�.
+   Default value is "mysql://openser:openserrw@localhost/openser".
 
 
-   Example 1.1. Set the “db_url� parameter
+   Example 1.1. Set the "db_url" parameter
 ...
 ...
 modparam("msilo", "db_url", "mysql://user:[email protected]/dbname")
 modparam("msilo", "db_url", "mysql://user:[email protected]/dbname")
 ...
 ...
@@ -274,9 +274,9 @@ modparam("msilo", "db_url", "mysql://user:[email protected]/dbname")
 
 
    The name of table where to store the messages.
    The name of table where to store the messages.
 
 
-   Default value is “silo�.
+   Default value is "silo".
 
 
-   Example 1.2. Set the “db_table� parameter
+   Example 1.2. Set the "db_table" parameter
 ...
 ...
 modparam("msilo", "db_table", "silo")
 modparam("msilo", "db_table", "silo")
 ...
 ...
@@ -288,9 +288,9 @@ modparam("msilo", "db_table", "silo")
    user goes online. If the parameter is not set, the module will not send
    user goes online. If the parameter is not set, the module will not send
    any notification. It can contain pseudo-variables.
    any notification. It can contain pseudo-variables.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
-   Example 1.3. Set the “from_address� parameter
+   Example 1.3. Set the "from_address" parameter
 ...
 ...
 modparam("msilo", "from_address", "sip:[email protected]")
 modparam("msilo", "from_address", "sip:[email protected]")
 modparam("msilo", "from_address", "sip:[email protected]")
 modparam("msilo", "from_address", "sip:[email protected]")
@@ -301,9 +301,9 @@ modparam("msilo", "from_address", "sip:[email protected]")
    The value of the Contact header (including header name and ending \r\n)
    The value of the Contact header (including header name and ending \r\n)
    to be added in notification messages. It can contain pseudo-variables.
    to be added in notification messages. It can contain pseudo-variables.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
-   Example 1.4. Set the “contact_hdr� parameter
+   Example 1.4. Set the "contact_hdr" parameter
 ...
 ...
 modparam("msilo", "contact_hdr", "Contact: <sip:[email protected]>\r\n")
 modparam("msilo", "contact_hdr", "Contact: <sip:[email protected]>\r\n")
 ...
 ...
@@ -313,9 +313,9 @@ modparam("msilo", "contact_hdr", "Contact: <sip:[email protected]>\r\n")
    Extra headers (each ending with \r\n) to be added in messages sent from
    Extra headers (each ending with \r\n) to be added in messages sent from
    silo by m_dump. It can contain pseudo-variables.
    silo by m_dump. It can contain pseudo-variables.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
-   Example 1.5. Set the “extra_hdrs� parameter
+   Example 1.5. Set the "extra_hdrs" parameter
 ...
 ...
 modparam("msilo", "contact_hdr", "X-Extra: $tu\r\nY-Extra: foo\r\n")
 modparam("msilo", "contact_hdr", "X-Extra: $tu\r\nY-Extra: foo\r\n")
 ...
 ...
@@ -324,9 +324,9 @@ modparam("msilo", "contact_hdr", "X-Extra: $tu\r\nY-Extra: foo\r\n")
 
 
    The body of the notification message. It can contain pseudo-variables.
    The body of the notification message. It can contain pseudo-variables.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
-   Example 1.6. Set the “offline_message� parameter
+   Example 1.6. Set the "offline_message" parameter
 ...
 ...
 modparam("msilo", "offline_message", "*** User $rU is offline!")
 modparam("msilo", "offline_message", "*** User $rU is offline!")
 modparam("msilo", "offline_message", "<em>I am offline!</em>")
 modparam("msilo", "offline_message", "<em>I am offline!</em>")
@@ -338,9 +338,9 @@ modparam("msilo", "offline_message", "<em>I am offline!</em>")
    \r\n) to be added in notification messages. It must reflect what the
    \r\n) to be added in notification messages. It must reflect what the
    'offline_message' contains. It can contain pseudo-variables.
    'offline_message' contains. It can contain pseudo-variables.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
-   Example 1.7. Set the “content_type_hdr� parameter
+   Example 1.7. Set the "content_type_hdr" parameter
 ...
 ...
 modparam("msilo", "content_type_hdr", "Content-Type: text/plain\r\n")
 modparam("msilo", "content_type_hdr", "Content-Type: text/plain\r\n")
 modparam("msilo", "content_type_hdr", "Content-Type: text/html\r\n")
 modparam("msilo", "content_type_hdr", "Content-Type: text/html\r\n")
@@ -351,9 +351,9 @@ modparam("msilo", "content_type_hdr", "Content-Type: text/html\r\n")
    The SIP address used to send reminder messages. If this value is not
    The SIP address used to send reminder messages. If this value is not
    set, the reminder feature is disabled.
    set, the reminder feature is disabled.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
-   Example 1.8. Set the “reminder� parameter
+   Example 1.8. Set the "reminder" parameter
 ...
 ...
 modparam("msilo", "reminder", "sip:[email protected]")
 modparam("msilo", "reminder", "sip:[email protected]")
 ...
 ...
@@ -365,9 +365,9 @@ modparam("msilo", "reminder", "sip:[email protected]")
    separate Kamailio instance for msilo processing. If not set, the
    separate Kamailio instance for msilo processing. If not set, the
    message will be sent to the address in destination URI.
    message will be sent to the address in destination URI.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
-   Example 1.9. Set the “outbound_proxy� parameter
+   Example 1.9. Set the "outbound_proxy" parameter
 ...
 ...
 modparam("msilo", "outbound_proxy", "sip:kamailio.org;transport=tcp")
 modparam("msilo", "outbound_proxy", "sip:kamailio.org;transport=tcp")
 ...
 ...
@@ -377,9 +377,9 @@ modparam("msilo", "outbound_proxy", "sip:kamailio.org;transport=tcp")
    Expire time of stored messages - seconds. When this time passed, the
    Expire time of stored messages - seconds. When this time passed, the
    message is silently discarded from database.
    message is silently discarded from database.
 
 
-   Default value is “259200 (72 hours = 3 days)�.
+   Default value is "259200 (72 hours = 3 days)".
 
 
-   Example 1.10. Set the “expire_time� parameter
+   Example 1.10. Set the "expire_time" parameter
 ...
 ...
 modparam("msilo", "expire_time", 36000)
 modparam("msilo", "expire_time", 36000)
 ...
 ...
@@ -390,9 +390,9 @@ modparam("msilo", "expire_time", 36000)
    module keeps each request send by itself for a new online user and if
    module keeps each request send by itself for a new online user and if
    the reply is 2xx then the message is deleted from database.
    the reply is 2xx then the message is deleted from database.
 
 
-   Default value is “30�.
+   Default value is "30".
 
 
-   Example 1.11. Set the “check_time� parameter
+   Example 1.11. Set the "check_time" parameter
 ...
 ...
 modparam("msilo", "check_time", 10)
 modparam("msilo", "check_time", 10)
 ...
 ...
@@ -405,21 +405,21 @@ modparam("msilo", "check_time", 10)
 
 
    If the value is 0, the reminder feature is disabled.
    If the value is 0, the reminder feature is disabled.
 
 
-   Default value is “0�.
+   Default value is "0".
 
 
-   Example 1.12. Set the “send_time� parameter
+   Example 1.12. Set the "send_time" parameter
 ...
 ...
 modparam("msilo", "send_time", 60)
 modparam("msilo", "send_time", 60)
 ...
 ...
 
 
 3.13. clean_period (int)
 3.13. clean_period (int)
 
 
-   Number of “check_time� cycles when to check if there are expired
+   Number of "check_time" cycles when to check if there are expired
    messages in database.
    messages in database.
 
 
-   Default value is “5�.
+   Default value is "5".
 
 
-   Example 1.13. Set the “clean_period� parameter
+   Example 1.13. Set the "clean_period" parameter
 ...
 ...
 modparam("msilo", "clean_period", 3)
 modparam("msilo", "clean_period", 3)
 ...
 ...
@@ -429,9 +429,9 @@ modparam("msilo", "clean_period", 3)
    Turns on/off the usage of the Contact address to send notification back
    Turns on/off the usage of the Contact address to send notification back
    to sender whose message is stored by MSILO.
    to sender whose message is stored by MSILO.
 
 
-   Default value is “1 (0 = off, 1 = on)�.
+   Default value is "1 (0 = off, 1 = on)".
 
 
-   Example 1.14. Set the “use_contact� parameter
+   Example 1.14. Set the "use_contact" parameter
 ...
 ...
 modparam("msilo", "use_contact", 0)
 modparam("msilo", "use_contact", 0)
 ...
 ...
@@ -440,9 +440,9 @@ modparam("msilo", "use_contact", 0)
 
 
    The name of the column in silo table, storing message id.
    The name of the column in silo table, storing message id.
 
 
-   Default value is “mid�.
+   Default value is "mid".
 
 
-   Example 1.15. Set the “sc_mid� parameter
+   Example 1.15. Set the "sc_mid" parameter
 ...
 ...
 modparam("msilo", "sc_mid", "other_mid")
 modparam("msilo", "sc_mid", "other_mid")
 ...
 ...
@@ -451,9 +451,9 @@ modparam("msilo", "sc_mid", "other_mid")
 
 
    The name of the column in silo table, storing the source address.
    The name of the column in silo table, storing the source address.
 
 
-   Default value is “src_addr�.
+   Default value is "src_addr".
 
 
-   Example 1.16. Set the “sc_from� parameter
+   Example 1.16. Set the "sc_from" parameter
 ...
 ...
 modparam("msilo", "sc_from", "source_address")
 modparam("msilo", "sc_from", "source_address")
 ...
 ...
@@ -462,9 +462,9 @@ modparam("msilo", "sc_from", "source_address")
 
 
    The name of the column in silo table, storing the destination address.
    The name of the column in silo table, storing the destination address.
 
 
-   Default value is “dst_addr�.
+   Default value is "dst_addr".
 
 
-   Example 1.17. Set the “sc_to� parameter
+   Example 1.17. Set the "sc_to" parameter
 ...
 ...
 modparam("msilo", "sc_to", "destination_address")
 modparam("msilo", "sc_to", "destination_address")
 ...
 ...
@@ -473,9 +473,9 @@ modparam("msilo", "sc_to", "destination_address")
 
 
    The name of the column in silo table, storing the user name.
    The name of the column in silo table, storing the user name.
 
 
-   Default value is “username�.
+   Default value is "username".
 
 
-   Example 1.18. Set the “sc_uri_user� parameter
+   Example 1.18. Set the "sc_uri_user" parameter
 ...
 ...
 modparam("msilo", "sc_uri_user", "user")
 modparam("msilo", "sc_uri_user", "user")
 ...
 ...
@@ -484,9 +484,9 @@ modparam("msilo", "sc_uri_user", "user")
 
 
    The name of the column in silo table, storing the domain.
    The name of the column in silo table, storing the domain.
 
 
-   Default value is “domain�.
+   Default value is "domain".
 
 
-   Example 1.19. Set the “sc_uri_host� parameter
+   Example 1.19. Set the "sc_uri_host" parameter
 ...
 ...
 modparam("msilo", "sc_uri_host", "domain")
 modparam("msilo", "sc_uri_host", "domain")
 ...
 ...
@@ -495,9 +495,9 @@ modparam("msilo", "sc_uri_host", "domain")
 
 
    The name of the column storing the message body in silo table.
    The name of the column storing the message body in silo table.
 
 
-   Default value is “body�.
+   Default value is "body".
 
 
-   Example 1.20. Set the “sc_body� parameter
+   Example 1.20. Set the "sc_body" parameter
 ...
 ...
 modparam("msilo", "sc_body", "message_body")
 modparam("msilo", "sc_body", "message_body")
 ...
 ...
@@ -506,9 +506,9 @@ modparam("msilo", "sc_body", "message_body")
 
 
    The name of the column in silo table, storing content type.
    The name of the column in silo table, storing content type.
 
 
-   Default value is “ctype�.
+   Default value is "ctype".
 
 
-   Example 1.21. Set the “sc_ctype� parameter
+   Example 1.21. Set the "sc_ctype" parameter
 ...
 ...
 modparam("msilo", "sc_ctype", "content_type")
 modparam("msilo", "sc_ctype", "content_type")
 ...
 ...
@@ -518,9 +518,9 @@ modparam("msilo", "sc_ctype", "content_type")
    The name of the column in silo table, storing the expire time of the
    The name of the column in silo table, storing the expire time of the
    message.
    message.
 
 
-   Default value is “exp_time�.
+   Default value is "exp_time".
 
 
-   Example 1.22. Set the “sc_exp_time� parameter
+   Example 1.22. Set the "sc_exp_time" parameter
 ...
 ...
 modparam("msilo", "sc_exp_time", "expire_time")
 modparam("msilo", "sc_exp_time", "expire_time")
 ...
 ...
@@ -530,9 +530,9 @@ modparam("msilo", "sc_exp_time", "expire_time")
    The name of the column in silo table, storing the incoming time of the
    The name of the column in silo table, storing the incoming time of the
    message.
    message.
 
 
-   Default value is “inc_time�.
+   Default value is "inc_time".
 
 
-   Example 1.23. Set the “sc_inc_time� parameter
+   Example 1.23. Set the "sc_inc_time" parameter
 ...
 ...
 modparam("msilo", "sc_inc_time", "incoming_time")
 modparam("msilo", "sc_inc_time", "incoming_time")
 ...
 ...
@@ -542,9 +542,9 @@ modparam("msilo", "sc_inc_time", "incoming_time")
    The name of the column in silo table, storing the send time for the
    The name of the column in silo table, storing the send time for the
    reminder.
    reminder.
 
 
-   Default value is “snd_time�.
+   Default value is "snd_time".
 
 
-   Example 1.24. Set the “sc_snd_time� parameter
+   Example 1.24. Set the "sc_snd_time" parameter
 ...
 ...
 modparam("msilo", "sc_snd_time", "send_reminder_time")
 modparam("msilo", "sc_snd_time", "send_reminder_time")
 ...
 ...
@@ -558,9 +558,9 @@ modparam("msilo", "sc_snd_time", "send_reminder_time")
    the value is set to a valid AVP name, then the module expects in the
    the value is set to a valid AVP name, then the module expects in the
    AVP to be a time value in format YYYYMMDDHHMMSS (e.g., 20060101201500).
    AVP to be a time value in format YYYYMMDDHHMMSS (e.g., 20060101201500).
 
 
-   Default value is “null�.
+   Default value is "null".
 
 
-   Example 1.25. Set the “snd_time_avp� parameter
+   Example 1.25. Set the "snd_time_avp" parameter
 ...
 ...
 modparam("msilo", "snd_time_avp", "$avp(i:123)")
 modparam("msilo", "snd_time_avp", "$avp(i:123)")
 ...
 ...
@@ -569,9 +569,9 @@ modparam("msilo", "snd_time_avp", "$avp(i:123)")
 
 
    Wheter to add as prefix the date when the message was stored.
    Wheter to add as prefix the date when the message was stored.
 
 
-   Default value is “1� (1==on/0==off).
+   Default value is "1" (1==on/0==off).
 
 
-   Example 1.26. Set the “add_date� parameter
+   Example 1.26. Set the "add_date" parameter
 ...
 ...
 modparam("msilo", "add_date", 0)
 modparam("msilo", "add_date", 0)
 ...
 ...
@@ -583,7 +583,7 @@ modparam("msilo", "add_date", 0)
 
 
    Default value is 0.
    Default value is 0.
 
 
-   Example 1.27. Set the “max_messages� parameter
+   Example 1.27. Set the "max_messages" parameter
 ...
 ...
 modparam("msilo", "max_messages", 0)
 modparam("msilo", "max_messages", 0)
 ...
 ...
@@ -593,9 +593,9 @@ modparam("msilo", "max_messages", 0)
    Wheter to add contact header to generated messages. The contact address
    Wheter to add contact header to generated messages. The contact address
    is the From URI.
    is the From URI.
 
 
-   Default value is “0� (1==on; 0==off as per RFC3428).
+   Default value is "0" (1==on; 0==off as per RFC3428).
 
 
-   Example 1.28. Set the “add_contact� parameter
+   Example 1.28. Set the "add_contact" parameter
 ...
 ...
 modparam("msilo", "add_contact", 1)
 modparam("msilo", "add_contact", 1)
 ...
 ...
@@ -609,9 +609,9 @@ modparam("msilo", "add_contact", 1)
    If the parameter is not set, m_store() does not look for extra headers
    If the parameter is not set, m_store() does not look for extra headers
    from any AVP.
    from any AVP.
 
 
-   Default value is “null�.
+   Default value is "null".
 
 
-   Example 1.29. Set the “extra_hdrs_avp� parameter
+   Example 1.29. Set the "extra_hdrs_avp" parameter
 ...
 ...
 modparam("msilo", "extra_hdrs_avp", "$avp(msilo_extra_hdrs)")
 modparam("msilo", "extra_hdrs_avp", "$avp(msilo_extra_hdrs)")
 ...
 ...
@@ -627,7 +627,7 @@ modparam("msilo", "extra_hdrs_avp", "$avp(msilo_extra_hdrs)")
    be called when the request type is MESSAGE and the destination user is
    be called when the request type is MESSAGE and the destination user is
    offline or his UA does not support MESSAGE requests). If the user is
    offline or his UA does not support MESSAGE requests). If the user is
    registered with a UA which does not support MESSAGE requests you should
    registered with a UA which does not support MESSAGE requests you should
-   not use mode=“0� if you have changed the request uri with the contact
+   not use mode="0" if you have changed the request uri with the contact
    address of user's UA.
    address of user's UA.
 
 
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
@@ -647,7 +647,7 @@ m_store("$tu");
 
 
    The method sends stored messages for the SIP user that is going to
    The method sends stored messages for the SIP user that is going to
    register to his actual contact address. The method should be called
    register to his actual contact address. The method should be called
-   when a REGISTER request is received and the “Expire� header has a value
+   when a REGISTER request is received and the "Expire" header has a value
    greater than zero.
    greater than zero.
 
 
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
@@ -663,7 +663,7 @@ m_dump();
 m_dump("$fu");
 m_dump("$fu");
 ...
 ...
 
 
-5. Exported Statistics
+5. Statistics
 
 
    5.1. stored_messages
    5.1. stored_messages
    5.2. dumped_messages
    5.2. dumped_messages

+ 12 - 12
modules_k/nat_traversal/README

@@ -10,7 +10,7 @@ Dan Pascu
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2008 Dan Pascu
+   Copyright © 2008 Dan Pascu
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -43,7 +43,7 @@ Dan Pascu
               5.2. fix_contact()
               5.2. fix_contact()
               5.3. nat_keepalive()
               5.3. nat_keepalive()
 
 
-        6. Exported statistics
+        6. Statistics
 
 
               6.1. keepalive_endpoints
               6.1. keepalive_endpoints
               6.2. registered_endpoints
               6.2. registered_endpoints
@@ -106,7 +106,7 @@ Chapter 1. Admin Guide
         5.2. fix_contact()
         5.2. fix_contact()
         5.3. nat_keepalive()
         5.3. nat_keepalive()
 
 
-   6. Exported statistics
+   6. Statistics
 
 
         6.1. keepalive_endpoints
         6.1. keepalive_endpoints
         6.2. registered_endpoints
         6.2. registered_endpoints
@@ -405,7 +405,7 @@ Chapter 1. Admin Guide
    each endpoint will receive exactly one keepalive message. A negative
    each endpoint will receive exactly one keepalive message. A negative
    value or zero will disable the keepalive functionality.
    value or zero will disable the keepalive functionality.
 
 
-   Default value is “60�.
+   Default value is "60".
 
 
    Example 1.1. Setting the keepalive_interval parameter
    Example 1.1. Setting the keepalive_interval parameter
 ...
 ...
@@ -418,7 +418,7 @@ modparam("nat_traversal", "keepalive_interval", 90)
    for this purpose are NOTIFY and OPTIONS. NOTIFY generates smaller
    for this purpose are NOTIFY and OPTIONS. NOTIFY generates smaller
    replies from user agents, but they are almost entirely negative
    replies from user agents, but they are almost entirely negative
    replies. Apparently almost none of the user agents understand that the
    replies. Apparently almost none of the user agents understand that the
-   purpose of the NOTIFY with a “keep-alive� event is to keep NAT open,
+   purpose of the NOTIFY with a "keep-alive" event is to keep NAT open,
    even though many user agents send such NOTIFY requests themselves.
    even though many user agents send such NOTIFY requests themselves.
    However this does not affect the result at all, since the purpose is to
    However this does not affect the result at all, since the purpose is to
    trigger a response from the user agent behind NAT, positive or negative
    trigger a response from the user agent behind NAT, positive or negative
@@ -433,7 +433,7 @@ modparam("nat_traversal", "keepalive_interval", 90)
    times bigger than negative replies or replies to NOTIFY requests. For
    times bigger than negative replies or replies to NOTIFY requests. For
    this reason the default value for the used method is NOTIFY.
    this reason the default value for the used method is NOTIFY.
 
 
-   Default value is “NOTIFY�.
+   Default value is "NOTIFY".
 
 
    Example 1.2. Setting the keepalive_method parameter
    Example 1.2. Setting the keepalive_method parameter
 ...
 ...
@@ -448,7 +448,7 @@ modparam("nat_traversal", "keepalive_method", "OPTIONS")
    keepalive message, which is the same interface on which the request
    keepalive message, which is the same interface on which the request
    that triggered keepalive functionality arrived.
    that triggered keepalive functionality arrived.
 
 
-   Default value is “sip:keepalive@proxy_ip� with proxy_ip being the
+   Default value is "sip:keepalive@proxy_ip" with proxy_ip being the
    actual IP of the outgoing interface.
    actual IP of the outgoing interface.
 
 
    Example 1.3. Setting the keepalive_from parameter
    Example 1.3. Setting the keepalive_from parameter
@@ -487,7 +487,7 @@ MyHeader: some_value\r\n")
    case it will store it in the Kamailio working directory, or an absolute
    case it will store it in the Kamailio working directory, or an absolute
    path.
    path.
 
 
-   Default value is undefined “keepalive_state�.
+   Default value is undefined "keepalive_state".
 
 
    Example 1.5. Setting the keepalive_state_file parameter
    Example 1.5. Setting the keepalive_state_file parameter
 ...
 ...
@@ -501,7 +501,7 @@ tate")
    5.2. fix_contact()
    5.2. fix_contact()
    5.3. nat_keepalive()
    5.3. nat_keepalive()
 
 
-5.1.  client_nat_test(type)
+5.1. client_nat_test(type)
 
 
    Check if the client is behind NAT. What tests are performed is
    Check if the client is behind NAT. What tests are performed is
    specified by the type parameter which is an integer given by the sum of
    specified by the type parameter which is an integer given by the sum of
@@ -529,7 +529,7 @@ if (client_nat_test("3")) {
 }
 }
 ...
 ...
 
 
-5.2.  fix_contact()
+5.2. fix_contact()
 
 
    Will replace the IP and port in the Contact header with the IP and port
    Will replace the IP and port in the Contact header with the IP and port
    the SIP message was received from. Usually called after a succesful
    the SIP message was received from. Usually called after a succesful
@@ -545,7 +545,7 @@ if (client_nat_test("3")) {
 }
 }
 ...
 ...
 
 
-5.3.  nat_keepalive()
+5.3. nat_keepalive()
 
 
    Trigger keepalive functionality for the source address of the request.
    Trigger keepalive functionality for the source address of the request.
    When called it only sets some internal flags, which will trigger later
    When called it only sets some internal flags, which will trigger later
@@ -575,7 +575,7 @@ if ((method=="REGISTER" || method=="SUBSCRIBE" ||
 }
 }
 ...
 ...
 
 
-6. Exported statistics
+6. Statistics
 
 
    6.1. keepalive_endpoints
    6.1. keepalive_endpoints
    6.2. registered_endpoints
    6.2. registered_endpoints

+ 8 - 8
modules_k/qos/README

@@ -8,7 +8,7 @@ Edited by
 
 
 Ovidiu Sas
 Ovidiu Sas
 
 
-   Copyright © 2008 SOMA Networks, Inc.
+   Copyright © 2008 SOMA Networks, Inc.
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -27,7 +27,7 @@ Ovidiu Sas
               4.1. qos_flag (integer)
               4.1. qos_flag (integer)
 
 
         5. Functions
         5. Functions
-        6. Exported Statistics
+        6. Statistics
         7. MI Commands
         7. MI Commands
         8. Exported pseudo-variables
         8. Exported pseudo-variables
         9. Installation and Running
         9. Installation and Running
@@ -58,7 +58,7 @@ Chapter 1. Admin Guide
         4.1. qos_flag (integer)
         4.1. qos_flag (integer)
 
 
    5. Functions
    5. Functions
-   6. Exported Statistics
+   6. Statistics
    7. MI Commands
    7. MI Commands
    8. Exported pseudo-variables
    8. Exported pseudo-variables
    9. Installation and Running
    9. Installation and Running
@@ -127,7 +127,7 @@ Chapter 1. Admin Guide
 
 
    This parameter must be set of the module will not load.
    This parameter must be set of the module will not load.
 
 
-   Default value is “Not set!�.
+   Default value is "Not set!".
 
 
    Example 1.1. Set qos_flag parameter
    Example 1.1. Set qos_flag parameter
 ...
 ...
@@ -147,7 +147,7 @@ route {
 
 
    There are no exported functions that could be used in scripts.
    There are no exported functions that could be used in scripts.
 
 
-6. Exported Statistics
+6. Statistics
 
 
    There are no exported statistics for the qos module.
    There are no exported statistics for the qos module.
 
 
@@ -176,7 +176,7 @@ Chapter 2. Developer Guide
 
 
    1.1. register_qoscb (qos, type, cb, param)
    1.1. register_qoscb (qos, type, cb, param)
 
 
-1.1.  register_qoscb (qos, type, cb, param)
+1.1. register_qoscb (qos, type, cb, param)
 
 
    Register a new callback to the qos.
    Register a new callback to the qos.
 
 
@@ -195,7 +195,7 @@ Chapter 2. Developer Guide
           + QOSCB_REMOVE_SDP - called when an existing SDP is removed -
           + QOSCB_REMOVE_SDP - called when an existing SDP is removed -
             it's a per qos type.
             it's a per qos type.
           + QOSCB_TERMINATED - called when the qos is terminated.
           + QOSCB_TERMINATED - called when the qos is terminated.
-     * qos_cb cb - callback function to be called. Prototype is: “void
+     * qos_cb cb - callback function to be called. Prototype is: "void
        (qos_cb) (struct qos_ctx_st *qos, int type, struct qos_cb_params
        (qos_cb) (struct qos_ctx_st *qos, int type, struct qos_cb_params
-       *params); �
+       *params); "
      * void *param - parameter to be passed to the callback function.
      * void *param - parameter to be passed to the callback function.

+ 42 - 42
modules_k/registrar/README

@@ -16,7 +16,7 @@ Edited by
 
 
 Bogdan-Andre Iancu
 Bogdan-Andre Iancu
 
 
-   Copyright © 2003 FhG FOKUS
+   Copyright © 2003 FhG FOKUS
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -66,7 +66,7 @@ Bogdan-Andre Iancu
               4.7. reg_fetch_contacts(domain, uri, profile)
               4.7. reg_fetch_contacts(domain, uri, profile)
               4.8. reg_free_contacts(profile)
               4.8. reg_free_contacts(profile)
 
 
-        5. Exported Statistics
+        5. Statistics
 
 
               5.1. max_expires
               5.1. max_expires
               5.2. max_contacts
               5.2. max_contacts
@@ -159,7 +159,7 @@ Chapter 1. Admin Guide
         4.7. reg_fetch_contacts(domain, uri, profile)
         4.7. reg_fetch_contacts(domain, uri, profile)
         4.8. reg_free_contacts(profile)
         4.8. reg_free_contacts(profile)
 
 
-   5. Exported Statistics
+   5. Statistics
 
 
         5.1. max_expires
         5.1. max_expires
         5.2. max_contacts
         5.2. max_contacts
@@ -189,8 +189,8 @@ Chapter 1. Admin Guide
      * off - stores the value of the Path headers into usrloc without
      * off - stores the value of the Path headers into usrloc without
        passing it back to the UAC in the reply.
        passing it back to the UAC in the reply.
      * lazy - stores the Path header and passes it back to the UAC if
      * lazy - stores the Path header and passes it back to the UAC if
-       Path-support is indicated by the “path� param in the Supported HF.
-     * strict - rejects the registration with “420 Bad Extension� if
+       Path-support is indicated by the "path" param in the Supported HF.
+     * strict - rejects the registration with "420 Bad Extension" if
        there's a Path header but no support for it is indicated by the
        there's a Path header but no support for it is indicated by the
        UAC. Otherwise it's stored and passed back to the UAC.
        UAC. Otherwise it's stored and passed back to the UAC.
 
 
@@ -202,8 +202,8 @@ Chapter 1. Admin Guide
    client's NAT).
    client's NAT).
 
 
    The whole process is transparent to the user, so no config changes are
    The whole process is transparent to the user, so no config changes are
-   required beside setting the registrar-parameters “use_path� and
-   “path_mode�.
+   required beside setting the registrar-parameters "use_path" and
+   "path_mode".
 
 
 2. Dependencies
 2. Dependencies
 
 
@@ -251,7 +251,7 @@ Chapter 1. Admin Guide
    contact parameters, this value will be used for newly created usrloc
    contact parameters, this value will be used for newly created usrloc
    records. The parameter contains number of second to expire (for example
    records. The parameter contains number of second to expire (for example
    use 3600 for one hour). If it is set to a lower value than the
    use 3600 for one hour). If it is set to a lower value than the
-   “min_expires� parameter then it will be ignored. This parameter can be
+   "min_expires" parameter then it will be ignored. This parameter can be
    modified via ser config framework. A random value in a specific
    modified via ser config framework. A random value in a specific
    interval can be selected by using the default_expires_range parameter
    interval can be selected by using the default_expires_range parameter
 
 
@@ -265,9 +265,9 @@ modparam("registrar", "default_expires", 1800)
 3.2. default_expires_range (integer)
 3.2. default_expires_range (integer)
 
 
    This parameter specifies that the expiry used for newly created usrloc
    This parameter specifies that the expiry used for newly created usrloc
-   records are not fixed(when “default_expires� applies), but a random
-   value in the interval “[default_expires-default_expires_range%,
-   default_expires+default_expires_range%]�. The value is between 0 and
+   records are not fixed(when "default_expires" applies), but a random
+   value in the interval "[default_expires-default_expires_range%,
+   default_expires+default_expires_range%]". The value is between 0 and
    100 and represent the maximim percentage from default_expires that will
    100 and represent the maximim percentage from default_expires that will
    be substracted or added when computing the value. Default in 0, meaning
    be substracted or added when computing the value. Default in 0, meaning
    default_expires is left unmodified. This parameter can be modified via
    default_expires is left unmodified. This parameter can be modified via
@@ -495,7 +495,7 @@ modparam("registrar", "method_filtering", 1)
 3.17. use_path (integer)
 3.17. use_path (integer)
 
 
    If set to 1, the Path header is handled according to the parameter This
    If set to 1, the Path header is handled according to the parameter This
-   parameter can be modified via ser config framework. “path_mode�.
+   parameter can be modified via ser config framework. "path_mode".
 
 
    Default value is 0 (disabled).
    Default value is 0 (disabled).
 
 
@@ -512,12 +512,12 @@ modparam("registrar", "use_path", 1)
        the reply.
        the reply.
      * 1 - The Path header is saved into usrloc, but is only included in
      * 1 - The Path header is saved into usrloc, but is only included in
        the reply if path support is indicated in the registration request
        the reply if path support is indicated in the registration request
-       by the “path� option of the “Supported� header.
+       by the "path" option of the "Supported" header.
      * 2 - The path header is only saved into usrloc, if path support is
      * 2 - The path header is only saved into usrloc, if path support is
-       indicated in the registration request by the “path� option of the
-       “Supported� header. If no path support is indicated, the request is
-       rejected with “420 - Bad Extension� and the header “Unsupported:
-       path� is included in the reply along with the received “Path�
+       indicated in the registration request by the "path" option of the
+       "Supported" header. If no path support is indicated, the request is
+       rejected with "420 - Bad Extension" and the header "Unsupported:
+       path" is included in the reply along with the received "Path"
        header. This mode is the one recommended by RFC-3327.
        header. This mode is the one recommended by RFC-3327.
 
 
    Default value is 2.
    Default value is 2.
@@ -529,10 +529,10 @@ modparam("registrar", "path_mode", 0)
 
 
 3.19. path_use_received (integer)
 3.19. path_use_received (integer)
 
 
-   If set to 1, the “received� parameter of the first Path URI of a
+   If set to 1, the "received" parameter of the first Path URI of a
    registration is set as received-uri and the NAT branch flag is set for
    registration is set as received-uri and the NAT branch flag is set for
    this contact. This is useful if the registrar is placed behind a SIP
    this contact. This is useful if the registrar is placed behind a SIP
-   loadbalancer, which passes the nat'ed UAC address as “received�
+   loadbalancer, which passes the nat'ed UAC address as "received"
    parameter in it's Path uri.
    parameter in it's Path uri.
 
 
    Default value is 0 (disabled).
    Default value is 0 (disabled).
@@ -566,7 +566,7 @@ modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
    4.7. reg_fetch_contacts(domain, uri, profile)
    4.7. reg_fetch_contacts(domain, uri, profile)
    4.8. reg_free_contacts(profile)
    4.8. reg_free_contacts(profile)
 
 
-4.1.  save(domain)
+4.1. save(domain)
 
 
    The function processes a REGISTER message. It can add, remove or modify
    The function processes a REGISTER message. It can add, remove or modify
    usrloc records depending on Contact and Expires HFs in the REGISTER
    usrloc records depending on Contact and Expires HFs in the REGISTER
@@ -593,7 +593,7 @@ modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
 save("location");
 save("location");
 ...
 ...
 
 
-4.2.  save(domain,flags)
+4.2. save(domain,flags)
 
 
    Same as save() but it accepts a set of flags for controlling its
    Same as save() but it accepts a set of flags for controlling its
    behaviour.
    behaviour.
@@ -620,7 +620,7 @@ save("location");
 save("location","0x01");
 save("location","0x01");
 ...
 ...
 
 
-4.3.  lookup(domain)
+4.3. lookup(domain)
 
 
    The functions extracts username from Request-URI and tries to find all
    The functions extracts username from Request-URI and tries to find all
    contacts for the username in usrloc. If there are no such contacts, -1
    contacts for the username in usrloc. If there are no such contacts, -1
@@ -658,7 +658,7 @@ switch ($retcode) {
 };
 };
 ...
 ...
 
 
-4.4.  registered(domain)
+4.4. registered(domain)
 
 
    The function returns true if the AOR in the Request-URI is registered,
    The function returns true if the AOR in the Request-URI is registered,
    false otherwise. The function does not modify the message being
    false otherwise. The function does not modify the message being
@@ -678,9 +678,9 @@ if (registered("location")) {
 };
 };
 ...
 ...
 
 
-4.5.  add_sock_hdr(hdr_name)
+4.5. add_sock_hdr(hdr_name)
 
 
-   Adds to the current REGISTER request a new header with “hdr_name� which
+   Adds to the current REGISTER request a new header with "hdr_name" which
    contains the description of the received socket (proto:ip:port)
    contains the description of the received socket (proto:ip:port)
 
 
    This make sens only in multiple replicated servers scenarios.
    This make sens only in multiple replicated servers scenarios.
@@ -695,7 +695,7 @@ if (registered("location")) {
 add_sock_hdr("Sock-Info");
 add_sock_hdr("Sock-Info");
 ...
 ...
 
 
-4.6.  unregister(domain, uri)
+4.6. unregister(domain, uri)
 
 
    The function remove all the contact associated to 'uri'.
    The function remove all the contact associated to 'uri'.
 
 
@@ -714,7 +714,7 @@ unregister("location", "$ru");
 unregister("location", "sip:[email protected]");
 unregister("location", "sip:[email protected]");
 ...
 ...
 
 
-4.7.  reg_fetch_contacts(domain, uri, profile)
+4.7. reg_fetch_contacts(domain, uri, profile)
 
 
    The function fetches the contacts for 'uri' from table 'domain' to
    The function fetches the contacts for 'uri' from table 'domain' to
    pseudo-variable $ulc(profile).
    pseudo-variable $ulc(profile).
@@ -736,7 +736,7 @@ reg_fetch_contacts("location", "$ru", "callee");
 reg_fetch_contacts("location", "sip:[email protected]", "caller");
 reg_fetch_contacts("location", "sip:[email protected]", "caller");
 ...
 ...
 
 
-4.8.  reg_free_contacts(profile)
+4.8. reg_free_contacts(profile)
 
 
    The function frees the contacts from pseudo-variable $ulc(profile).
    The function frees the contacts from pseudo-variable $ulc(profile).
    Should be called to release the content of a profile. Anyhow, fetching
    Should be called to release the content of a profile. Anyhow, fetching
@@ -754,7 +754,7 @@ reg_fetch_contacts("location", "sip:[email protected]", "caller");
 reg_free_contacts("callee");
 reg_free_contacts("callee");
 ...
 ...
 
 
-5. Exported Statistics
+5. Statistics
 
 
    5.1. max_expires
    5.1. max_expires
    5.2. max_contacts
    5.2. max_contacts
@@ -789,12 +789,12 @@ reg_free_contacts("callee");
 6.1. $ulc(profile=>attr)
 6.1. $ulc(profile=>attr)
 
 
    Access the attributes of contact addresses stored in 'profile'. It must
    Access the attributes of contact addresses stored in 'profile'. It must
-   be used after a call of “reg_fetch_contacts()�.
+   be used after a call of "reg_fetch_contacts()".
 
 
-   The “profile� has to be one of the values used with
-   “reg_fetch_contacts()�.
+   The "profile" has to be one of the values used with
+   "reg_fetch_contacts()".
 
 
-   The “attr� can be:
+   The "attr" can be:
      * aor - address of record
      * aor - address of record
      * domain - use location domain name
      * domain - use location domain name
      * aorhash - hash id for the record
      * aorhash - hash id for the record
@@ -847,9 +847,9 @@ if(reg_fetch_contacts("location", "$fu", "caller"))
 
 
 Chapter 2. Frequently Asked Questions
 Chapter 2. Frequently Asked Questions
 
 
-   2.1. What happend with the old “nat_flag� module parameter?
-   2.2. What happend with the old “use_domain� module parameter?
-   2.3. What happend with the old “save_noreply� and “save_memory�
+   2.1. What happend with the old "nat_flag" module parameter?
+   2.2. What happend with the old "use_domain" module parameter?
+   2.3. What happend with the old "save_noreply" and "save_memory"
           functions?
           functions?
 
 
    2.4. Where can I find more about Kamailio?
    2.4. Where can I find more about Kamailio?
@@ -859,23 +859,23 @@ Chapter 2. Frequently Asked Questions
 
 
    2.1.
    2.1.
 
 
-   What happend with the old “nat_flag� module parameter?
+   What happend with the old "nat_flag" module parameter?
 
 
    In was removed, as the module internally loads this value from the
    In was removed, as the module internally loads this value from the
-   “USRLOC� module (see the “nat_bflag� USRLOC parameter).
+   "USRLOC" module (see the "nat_bflag" USRLOC parameter).
 
 
    2.2.
    2.2.
 
 
-   What happend with the old “use_domain� module parameter?
+   What happend with the old "use_domain" module parameter?
 
 
    In was removed, as the module internally loads this option from the
    In was removed, as the module internally loads this option from the
-   “USRLOC� module. This was done in order to simplify the configuration.
+   "USRLOC" module. This was done in order to simplify the configuration.
 
 
    2.3.
    2.3.
 
 
-   What happend with the old “save_noreply� and “save_memory� functions?
+   What happend with the old "save_noreply" and "save_memory" functions?
 
 
-   There functions were merged into the new “save(domain,flags)�
+   There functions were merged into the new "save(domain,flags)"
    functions. If a reply should be sent or if the DB should be updated
    functions. If a reply should be sent or if the DB should be updated
    also is controlled via the flags.
    also is controlled via the flags.
 
 

+ 14 - 14
modules_k/sqlops/README

@@ -11,7 +11,7 @@ Daniel-Constantin Mierla
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2008 http://www.asipto.com
+   Copyright © 2008 http://www.asipto.com
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -93,7 +93,7 @@ Chapter 1. Admin Guide
      * access via pseudo-variables - the content of the SQL query result
      * access via pseudo-variables - the content of the SQL query result
        is accessible via pseudo-variables. Please note that only integer
        is accessible via pseudo-variables. Please note that only integer
        and string variables are supported at the moment because of the
        and string variables are supported at the moment because of the
-       internal usage of “AVPs� to hold the values. So it is not possible
+       internal usage of "AVPs" to hold the values. So it is not possible
        for example to return floating point or big integer values this
        for example to return floating point or big integer values this
        way.
        way.
      * array indexes - fast access to result values via array position:
      * array indexes - fast access to result values via array position:
@@ -135,7 +135,7 @@ Chapter 1. Admin Guide
    This parameter may be set multiple times to get many DB connections in
    This parameter may be set multiple times to get many DB connections in
    the same configuration file.
    the same configuration file.
      * connection_name - string specifying the name of a DB connection.
      * connection_name - string specifying the name of a DB connection.
-       This string is used by the “sql_query()� function to refer to the
+       This string is used by the "sql_query()" function to refer to the
        DB connection.
        DB connection.
      * database_url - Standardized database URL used to connect to
      * database_url - Standardized database URL used to connect to
        database.
        database.
@@ -170,11 +170,11 @@ modparam("sqlops", "sqlres", "ra")
    4.3. sql_pvquery(connection, query, result)
    4.3. sql_pvquery(connection, query, result)
    4.4. sql_result_free(result)
    4.4. sql_result_free(result)
 
 
-4.1.  sql_query(connection, query[, result])
+4.1. sql_query(connection, query[, result])
 
 
    Make an SQL query using 'connection' and store data in 'result'.
    Make an SQL query using 'connection' and store data in 'result'.
      * connection - the name of the connection to be used for query
      * connection - the name of the connection to be used for query
-       (defined via the “sqlcon� parameter).
+       (defined via the "sqlcon" parameter).
      * query - SQL query string or pseudo-variables containing SQL query.
      * query - SQL query string or pseudo-variables containing SQL query.
      * result - string name to identify the result. Will be used by
      * result - string name to identify the result. Will be used by
        $dbr(...) pseudo-variable to access result attributes. If omitted,
        $dbr(...) pseudo-variable to access result attributes. If omitted,
@@ -193,11 +193,11 @@ xlog("number of rows in table domain: $dbr(ra=>rows)\n");
 sql_result_free("ra");
 sql_result_free("ra");
 ...
 ...
 
 
-4.2.  sql_xquery(connection, query, result)
+4.2. sql_xquery(connection, query, result)
 
 
    Make an SQL query using 'connection' and store data in 'result' xavp.
    Make an SQL query using 'connection' and store data in 'result' xavp.
      * connection - the name of the connection to be used for query
      * connection - the name of the connection to be used for query
-       (defined via the “sqlcon� parameter).
+       (defined via the "sqlcon" parameter).
      * query - SQL query string or pseudo-variables containing SQL query.
      * query - SQL query string or pseudo-variables containing SQL query.
      * result - string name to identify the result xavp. Each row will be
      * result - string name to identify the result xavp. Each row will be
        added to this xavp, each column can be accessed by its name.
        added to this xavp, each column can be accessed by its name.
@@ -212,15 +212,15 @@ sql_xquery("ca", "select * from domain", "ra");
   xlog("first domain: $xavp(ra=>domain) with id: $xavp(ra=>domain_id)\n");
   xlog("first domain: $xavp(ra=>domain) with id: $xavp(ra=>domain_id)\n");
 ...
 ...
 
 
-4.3.  sql_pvquery(connection, query, result)
+4.3. sql_pvquery(connection, query, result)
 
 
    Make an SQL query using 'connection' and store data in arbitrary PV's
    Make an SQL query using 'connection' and store data in arbitrary PV's
    specified by 'result' parameter.
    specified by 'result' parameter.
      * connection - the name of the connection to be used for query
      * connection - the name of the connection to be used for query
-       (defined via the “sqlcon� parameter).
+       (defined via the "sqlcon" parameter).
      * query - SQL query string or pseudo-variables containing SQL query.
      * query - SQL query string or pseudo-variables containing SQL query.
      * result - a list with PV names where to store the result. The format
      * result - a list with PV names where to store the result. The format
-       is “$pv;$pv;...�. Every PV that is writable may be used (for
+       is "$pv;$pv;...". Every PV that is writable may be used (for
        example $var, $avp, $xavp, $ru, $du, $sht, etc).
        example $var, $avp, $xavp, $ru, $du, $sht, etc).
        The PV are assigned values in the following order: last row to
        The PV are assigned values in the following order: last row to
        first row, first field to last field. Assignment has the same
        first row, first field to last field. Assignment has the same
@@ -244,7 +244,7 @@ sql_xquery("ca", "select 'col1', 2, NULL, 'sip:[email protected]'",
         "$var(a), $avp(col2), $xavp(item[0]=>s), $ru");
         "$var(a), $avp(col2), $xavp(item[0]=>s), $ru");
 ...
 ...
 
 
-4.4.  sql_result_free(result)
+4.4. sql_result_free(result)
 
 
    Free data in SQL 'result'.
    Free data in SQL 'result'.
 
 
@@ -269,10 +269,10 @@ sql_result_free("ra");
 
 
    Access hash table entries.
    Access hash table entries.
 
 
-   The “result� must be the name identifying a SQL result (third parameter
+   The "result" must be the name identifying a SQL result (third parameter
    of sql_query(...)).
    of sql_query(...)).
 
 
-   The “key� can be:
+   The "key" can be:
      * rows - return the number of rows in query result
      * rows - return the number of rows in query result
      * cols - return the number of columns in the result.
      * cols - return the number of columns in the result.
      * [row,col] - return the value at position (row,col) in the result
      * [row,col] - return the value at position (row,col) in the result
@@ -337,7 +337,7 @@ if (sql_xquery("ca", "select * from domain", "ra") == 1)
    connection. Its primary use is to get the number of rows affected by
    connection. Its primary use is to get the number of rows affected by
    UPDATE, INSERT and DELETE queries.
    UPDATE, INSERT and DELETE queries.
 
 
-   “con� must be the name identifying an SQL connection.
+   "con" must be the name identifying an SQL connection.
 
 
    Example 1.8. $sqlrows(con) usage
    Example 1.8. $sqlrows(con) usage
 ...
 ...

+ 16 - 16
modules_k/sst/README

@@ -8,7 +8,7 @@ Edited by
 
 
 Ron Winacott
 Ron Winacott
 
 
-   Copyright © 2006 SOMA Networks, Inc.
+   Copyright © 2006 SOMA Networks, Inc.
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -34,7 +34,7 @@ Ron Winacott
 
 
               5.1. sstCheckMin(send_reply_flag)
               5.1. sstCheckMin(send_reply_flag)
 
 
-        6. Exported Statistics
+        6. Statistics
 
 
               6.1. expired_sst
               6.1. expired_sst
 
 
@@ -73,7 +73,7 @@ Chapter 1. Admin Guide
 
 
         5.1. sstCheckMin(send_reply_flag)
         5.1. sstCheckMin(send_reply_flag)
 
 
-   6. Exported Statistics
+   6. Statistics
 
 
         6.1. expired_sst
         6.1. expired_sst
 
 
@@ -99,7 +99,7 @@ Chapter 1. Admin Guide
 
 
 2. How it works
 2. How it works
 
 
-   The sst module uses the “dialog module� to be notified of any new or
+   The sst module uses the "dialog module" to be notified of any new or
    updated dialogs. It will then look for and extract the session-expire:
    updated dialogs. It will then look for and extract the session-expire:
    header value (if there is one) and override the dialog expire timer
    header value (if there is one) and override the dialog expire timer
    value for the current context dialog by setting the avp value.
    value for the current context dialog by setting the avp value.
@@ -111,10 +111,10 @@ Chapter 1. Admin Guide
    All of this happens with a properly configured dialog and sst module
    All of this happens with a properly configured dialog and sst module
    and setting the dialog flag and the sst flag at the time any INVITE sip
    and setting the dialog flag and the sst flag at the time any INVITE sip
    message is seen. There is no kamailio.cfg script function call required
    message is seen. There is no kamailio.cfg script function call required
-   to set the dialog expire timeout value. See the “dialog module� users
+   to set the dialog expire timeout value. See the "dialog module" users
    guide for more information.
    guide for more information.
 
 
-   The “sstCheckMin()� script function can be used to verify that the
+   The "sstCheckMin()" script function can be used to verify that the
    Session-expires / MIN-SE header field values are not too small for your
    Session-expires / MIN-SE header field values are not too small for your
    server. If the SST min_se parameter value is smaller than the messages
    server. If the SST min_se parameter value is smaller than the messages
    Session-Expires / MIN-SE values, the test will return true. You can
    Session-Expires / MIN-SE values, the test will return true. You can
@@ -193,7 +193,7 @@ Chapter 1. Admin Guide
    variables, the module provide information about the dialog processing.
    variables, the module provide information about the dialog processing.
    Set it to zero to disable or to non-zero to enable it.
    Set it to zero to disable or to non-zero to enable it.
 
 
-   Default value is “1� (enabled).
+   Default value is "1" (enabled).
 
 
    Example 1.2. Set enable_stats parameter
    Example 1.2. Set enable_stats parameter
 ...
 ...
@@ -204,13 +204,13 @@ modparam("sst", "enable_stats", 0)
 
 
    The value is used to set the proxies MIN-SE value and is used in the
    The value is used to set the proxies MIN-SE value and is used in the
    422 error reply as the proxys MIN-SE: header value if the
    422 error reply as the proxys MIN-SE: header value if the
-   “sstCheckMin()� flag is set to true and the check fails.
+   "sstCheckMin()" flag is set to true and the check fails.
 
 
-   If not set and “sstCheckMin()� is called with the send-reply flag set
+   If not set and "sstCheckMin()" is called with the send-reply flag set
    to true, the default 1800 seconds will be used as the compare and the
    to true, the default 1800 seconds will be used as the compare and the
    MIN-SE: header value if the 422 reply is sent.
    MIN-SE: header value if the 422 reply is sent.
 
 
-   Default value is “1800� seconds.
+   Default value is "1800" seconds.
 
 
    Example 1.3. Set min_se parameter
    Example 1.3. Set min_se parameter
 ...
 ...
@@ -226,7 +226,7 @@ modparam("sst", "min_se", 2400)
    This is how the sst module knows which avp in the dialog module it has
    This is how the sst module knows which avp in the dialog module it has
    to change with the new expire value.
    to change with the new expire value.
 
 
-   Default value is “NULL!� it is not set by default.
+   Default value is "NULL!" it is not set by default.
 
 
    Example 1.4. Set timeout_avp parameter
    Example 1.4. Set timeout_avp parameter
 ...
 ...
@@ -240,14 +240,14 @@ modparam("sst", "timeout_avp", "$avp(i:10)")
    In the initial INVITE if the UAC has requested a Session-Expire: and
    In the initial INVITE if the UAC has requested a Session-Expire: and
    it's value is smaller than our local policies Min-SE (see min_se
    it's value is smaller than our local policies Min-SE (see min_se
    above), then the proxy has the right to reject the call by replying to
    above), then the proxy has the right to reject the call by replying to
-   the message with a “422 Session Timer Too Small� and state our local
+   the message with a "422 Session Timer Too Small" and state our local
    Min-SE: value. The INVITE is NOT forwarded on through the proxy.
    Min-SE: value. The INVITE is NOT forwarded on through the proxy.
 
 
    If this flag is true, the SST module to reject the INVITE with a 422
    If this flag is true, the SST module to reject the INVITE with a 422
    response. If false, the INVITE is forwarded through the PROXY without
    response. If false, the INVITE is forwarded through the PROXY without
    any modifications.
    any modifications.
 
 
-   Default value is “1� (true/on).
+   Default value is "1" (true/on).
 
 
    Example 1.5. Set reject_to_small parameter
    Example 1.5. Set reject_to_small parameter
 ...
 ...
@@ -268,7 +268,7 @@ modparam("sst", "reject_to_small", 0)
 
 
    This parameter must be set or the module will not load.
    This parameter must be set or the module will not load.
 
 
-   Default value is “Not set!�.
+   Default value is "Not set!".
 
 
    Example 1.6. Set sst_flag parameter
    Example 1.6. Set sst_flag parameter
 ...
 ...
@@ -288,7 +288,7 @@ route {
 
 
    5.1. sstCheckMin(send_reply_flag)
    5.1. sstCheckMin(send_reply_flag)
 
 
-5.1.  sstCheckMin(send_reply_flag)
+5.1. sstCheckMin(send_reply_flag)
 
 
    Check the current Session-Expires / MIN-SE values against the
    Check the current Session-Expires / MIN-SE values against the
    sst_min_se parameter value. If the Session-Expires or MIN_SE header
    sst_min_se parameter value. If the Session-Expires or MIN_SE header
@@ -340,7 +340,7 @@ route {
 }
 }
 ...
 ...
 
 
-6. Exported Statistics
+6. Statistics
 
 
    6.1. expired_sst
    6.1. expired_sst
 
 

+ 26 - 26
modules_k/tmx/README

@@ -11,7 +11,7 @@ Daniel-Constantin Mierla
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2009 Daniel-Constantin Mierla
+   Copyright © 2009 Daniel-Constantin Mierla
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -44,7 +44,7 @@ Daniel-Constantin Mierla
               5.4. t_reply
               5.4. t_reply
               5.5. t_reply_callid
               5.5. t_reply_callid
 
 
-        6. Exported statistics
+        6. Statistics
 
 
               6.1. received_replies
               6.1. received_replies
               6.2. relayed_replies
               6.2. relayed_replies
@@ -99,7 +99,7 @@ Chapter 1. Admin Guide
         5.4. t_reply
         5.4. t_reply
         5.5. t_reply_callid
         5.5. t_reply_callid
 
 
-   6. Exported statistics
+   6. Statistics
 
 
         6.1. received_replies
         6.1. received_replies
         6.2. relayed_replies
         6.2. relayed_replies
@@ -147,7 +147,7 @@ Chapter 1. Admin Guide
    3.7. t_suspend()
    3.7. t_suspend()
    3.8. t_continue(tindex, tlabel, rtname)
    3.8. t_continue(tindex, tlabel, rtname)
 
 
-3.1.  t_cancel_branches(which)
+3.1. t_cancel_branches(which)
 
 
    Cancel branches of an active SIP transaction. The function can be
    Cancel branches of an active SIP transaction. The function can be
    called for a SIP reply that will identify the current branch.
    called for a SIP reply that will identify the current branch.
@@ -166,7 +166,7 @@ if (t_cancel_branches("all")) {
 }
 }
 ...
 ...
 
 
-3.2.  t_cancel_callid(callid, cseq, flag)
+3.2. t_cancel_callid(callid, cseq, flag)
 
 
    Cancel first INVITE transaction identified by callid and cseq. It sets
    Cancel first INVITE transaction identified by callid and cseq. It sets
    the flag if the value is greater than zero
    the flag if the value is greater than zero
@@ -185,7 +185,7 @@ if (t_cancel_callid("123qaz", "5", "22")) {
 }
 }
 ...
 ...
 
 
-3.3.  t_reply_callid(callid, cseq, code, reason)
+3.3. t_reply_callid(callid, cseq, code, reason)
 
 
    Send reply to first INVITE transaction identified by callid and cseq.
    Send reply to first INVITE transaction identified by callid and cseq.
 
 
@@ -204,7 +204,7 @@ if (t_reply_callid("123qaz", "5", "458", "Replied remotely")) {
 }
 }
 ...
 ...
 
 
-3.4.  t_flush_flags()
+3.4. t_flush_flags()
 
 
    Flush the flags from current SIP message into the already created
    Flush the flags from current SIP message into the already created
    transaction. It make sense only in routing block if the transaction was
    transaction. It make sense only in routing block if the transaction was
@@ -217,7 +217,7 @@ if (t_reply_callid("123qaz", "5", "458", "Replied remotely")) {
 t_flush_flags();
 t_flush_flags();
 ...
 ...
 
 
-3.5.  t_is_failure_route()
+3.5. t_is_failure_route()
 
 
    Returns true if the top-executed route block is failure_route.
    Returns true if the top-executed route block is failure_route.
 
 
@@ -234,7 +234,7 @@ route[abc] {
 }
 }
 ...
 ...
 
 
-3.6.  t_is_branch_route()
+3.6. t_is_branch_route()
 
 
    Returns true if the top-executed route block is branch_route.
    Returns true if the top-executed route block is branch_route.
 
 
@@ -251,7 +251,7 @@ route[abc] {
 }
 }
 ...
 ...
 
 
-3.7.  t_suspend()
+3.7. t_suspend()
 
 
    Suspend the execution of SIP request in a transaction. If transaction
    Suspend the execution of SIP request in a transaction. If transaction
    was not created yet, it is created by this function. Returns true in
    was not created yet, it is created by this function. Returns true in
@@ -269,7 +269,7 @@ if(t_suspend())
 }
 }
 ...
 ...
 
 
-3.8.  t_continue(tindex, tlabel, rtname)
+3.8. t_continue(tindex, tlabel, rtname)
 
 
    Continue the execution of the transaction identified by tindex and
    Continue the execution of the transaction identified by tindex and
    tlabel with the actions defined in route[rtname].
    tlabel with the actions defined in route[rtname].
@@ -307,22 +307,22 @@ tcontinue('123', '456', 'MYROUTE');
    5.4. t_reply
    5.4. t_reply
    5.5. t_reply_callid
    5.5. t_reply_callid
 
 
-5.1.  t_uac_dlg
+5.1. t_uac_dlg
 
 
    Generates and sends a local SIP request.
    Generates and sends a local SIP request.
 
 
    Parameters:
    Parameters:
      * method - request method
      * method - request method
      * RURI - request SIP URI
      * RURI - request SIP URI
-     * NEXT HOP - next hop SIP URI (OBP); use “.� if no value.
-     * socket - local socket to be used for sending the request; use “.�
+     * NEXT HOP - next hop SIP URI (OBP); use "." if no value.
+     * socket - local socket to be used for sending the request; use "."
        if no value.
        if no value.
      * headers - set of additional headers to be added to the request; at
      * headers - set of additional headers to be added to the request; at
-       least “From� and “To� headers must be specify)
+       least "From" and "To" headers must be specify)
      * body - (optional, may not be present) request body (if present,
      * body - (optional, may not be present) request body (if present,
-       requires the “Content-Type� and “Content-length� headers)
+       requires the "Content-Type" and "Content-length" headers)
 
 
-5.2.  t_uac_cancel
+5.2. t_uac_cancel
 
 
    Generates and sends a CANCEL for an existing local SIP request.
    Generates and sends a CANCEL for an existing local SIP request.
 
 
@@ -330,14 +330,14 @@ tcontinue('123', '456', 'MYROUTE');
      * callid - callid of the INVITE request to be cancelled.
      * callid - callid of the INVITE request to be cancelled.
      * cseq - cseq of the INVITE request to be cancelled.
      * cseq - cseq of the INVITE request to be cancelled.
 
 
-5.3.  t_hash
+5.3. t_hash
 
 
    Gets information about the load of TM internal hash table.
    Gets information about the load of TM internal hash table.
 
 
    Parameters:
    Parameters:
      * none
      * none
 
 
-5.4.  t_reply
+5.4. t_reply
 
 
    Generates and sends a reply for an existing inbound SIP transaction.
    Generates and sends a reply for an existing inbound SIP transaction.
 
 
@@ -347,11 +347,11 @@ tcontinue('123', '456', 'MYROUTE');
      * trans_id - transaction identifier (has the hash_entry:label format)
      * trans_id - transaction identifier (has the hash_entry:label format)
      * to_tag - To tag to be added to TO header
      * to_tag - To tag to be added to TO header
      * new_headers - extra headers to be appended to the reply; use a dot
      * new_headers - extra headers to be appended to the reply; use a dot
-       (“.�) char only if there are no headers;
+       (".") char only if there are no headers;
      * body - (optional, may not be present) reply body (if present,
      * body - (optional, may not be present) reply body (if present,
-       requires the “Content-Type� and “Content-length� headers)
+       requires the "Content-Type" and "Content-length" headers)
 
 
-5.5.  t_reply_callid
+5.5. t_reply_callid
 
 
    Generates and sends a reply for an existing inbound SIP transaction.
    Generates and sends a reply for an existing inbound SIP transaction.
 
 
@@ -362,11 +362,11 @@ tcontinue('123', '456', 'MYROUTE');
      * cseq - SIP CSeq header
      * cseq - SIP CSeq header
      * to_tag - To tag to be added to TO header
      * to_tag - To tag to be added to TO header
      * new_headers - extra headers to be appended to the reply; use a dot
      * new_headers - extra headers to be appended to the reply; use a dot
-       (“.�) char only if there are no headers;
+       (".") char only if there are no headers;
      * body - (optional, may not be present) reply body (if present,
      * body - (optional, may not be present) reply body (if present,
-       requires the “Content-Type� and “Content-length� headers)
+       requires the "Content-Type" and "Content-length" headers)
 
 
-6. Exported statistics
+6. Statistics
 
 
    6.1. received_replies
    6.1. received_replies
    6.2. relayed_replies
    6.2. relayed_replies
@@ -381,7 +381,7 @@ tcontinue('123', '456', 'MYROUTE');
    6.11. inuse_transactions
    6.11. inuse_transactions
 
 
    Exported statistics are listed in the next sections. All statistics
    Exported statistics are listed in the next sections. All statistics
-   except “inuse_transactions� can be reset.
+   except "inuse_transactions" can be reset.
 
 
 6.1. received_replies
 6.1. received_replies
 
 

+ 53 - 53
modules_k/usrloc/README

@@ -16,9 +16,9 @@ Edited by
 
 
 Bogdan-Andrei Iancu
 Bogdan-Andrei Iancu
 
 
-   Copyright © 2003 FhG FOKUS
+   Copyright © 2003 FhG FOKUS
 
 
-   Copyright © 2005 Voice Sistem SRL
+   Copyright © 2005 Voice Sistem SRL
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -72,7 +72,7 @@ Bogdan-Andrei Iancu
               5.5. ul_add
               5.5. ul_add
               5.6. ul_show_contact
               5.6. ul_show_contact
 
 
-        6. Exported statistics
+        6. Statistics
 
 
               6.1. users
               6.1. users
               6.2. contacts
               6.2. contacts
@@ -182,7 +182,7 @@ Chapter 1. Admin Guide
         5.5. ul_add
         5.5. ul_add
         5.6. ul_show_contact
         5.6. ul_show_contact
 
 
-   6. Exported statistics
+   6. Statistics
 
 
         6.1. users
         6.1. users
         6.2. contacts
         6.2. contacts
@@ -226,8 +226,8 @@ Chapter 1. Admin Guide
        retransmissions in this case.
        retransmissions in this case.
 
 
    How to control/select the contact maching algorithm, please see the
    How to control/select the contact maching algorithm, please see the
-   module parameter matching_mode at Section 3.21, “matching_mode
-   (integer)�.
+   module parameter matching_mode at Section 3.21, "matching_mode
+   (integer)".
 
 
 2. Dependencies
 2. Dependencies
 
 
@@ -279,7 +279,7 @@ Chapter 1. Admin Guide
    is or not natted). This is a branch flag and it will be imported and
    is or not natted). This is a branch flag and it will be imported and
    used by all other modules depending of usrloc module.
    used by all other modules depending of usrloc module.
 
 
-   Default value is “not set�.
+   Default value is "not set".
 
 
    Example 1.1. Set nat_bflag parameter
    Example 1.1. Set nat_bflag parameter
 ...
 ...
@@ -290,7 +290,7 @@ modparam("usrloc", "nat_bflag", 3)
 
 
    Name of column containing usernames.
    Name of column containing usernames.
 
 
-   Default value is “username�.
+   Default value is "username".
 
 
    Example 1.2. Set user_column parameter
    Example 1.2. Set user_column parameter
 ...
 ...
@@ -301,7 +301,7 @@ modparam("usrloc", "user_column", "username")
 
 
    Name of column containing domains.
    Name of column containing domains.
 
 
-   Default value is “domain�.
+   Default value is "domain".
 
 
    Example 1.3. Set user_column parameter
    Example 1.3. Set user_column parameter
 ...
 ...
@@ -312,7 +312,7 @@ modparam("usrloc", "domain_column", "domain")
 
 
    Name of column containing contacts.
    Name of column containing contacts.
 
 
-   Default value is “contact�.
+   Default value is "contact".
 
 
    Example 1.4. Set contact_column parameter
    Example 1.4. Set contact_column parameter
 ...
 ...
@@ -323,7 +323,7 @@ modparam("usrloc", "contact_column", "contact")
 
 
    Name of column containing expires value.
    Name of column containing expires value.
 
 
-   Default value is “expires�.
+   Default value is "expires".
 
 
    Example 1.5. Set expires_column parameter
    Example 1.5. Set expires_column parameter
 ...
 ...
@@ -334,7 +334,7 @@ modparam("usrloc", "expires_column", "expires")
 
 
    Name of column containing q values.
    Name of column containing q values.
 
 
-   Default value is “q�.
+   Default value is "q".
 
 
    Example 1.6. Set q_column parameter
    Example 1.6. Set q_column parameter
 ...
 ...
@@ -345,7 +345,7 @@ modparam("usrloc", "q_column", "q")
 
 
    Name of column containing callid values.
    Name of column containing callid values.
 
 
-   Default value is “callid�.
+   Default value is "callid".
 
 
    Example 1.7. Set callid_column parameter
    Example 1.7. Set callid_column parameter
 ...
 ...
@@ -356,7 +356,7 @@ modparam("usrloc", "callid_column", "callid")
 
 
    Name of column containing cseq numbers.
    Name of column containing cseq numbers.
 
 
-   Default value is “cseq�.
+   Default value is "cseq".
 
 
    Example 1.8. Set cseq_column parameter
    Example 1.8. Set cseq_column parameter
 ...
 ...
@@ -367,7 +367,7 @@ modparam("usrloc", "cseq_column", "cseq")
 
 
    Name of column containing supported methods.
    Name of column containing supported methods.
 
 
-   Default value is “methods�.
+   Default value is "methods".
 
 
    Example 1.9. Set methods_column parameter
    Example 1.9. Set methods_column parameter
 ...
 ...
@@ -378,7 +378,7 @@ modparam("usrloc", "methods_column", "methods")
 
 
    Name of column to save the internal flags of the record.
    Name of column to save the internal flags of the record.
 
 
-   Default value is “flags�.
+   Default value is "flags".
 
 
    Example 1.10. Set flags_column parameter
    Example 1.10. Set flags_column parameter
 ...
 ...
@@ -389,7 +389,7 @@ modparam("usrloc", "flags_column", "flags")
 
 
    Name of column to save the branch/contact flags of the record.
    Name of column to save the branch/contact flags of the record.
 
 
-   Default value is “cflags�.
+   Default value is "cflags".
 
 
    Example 1.11. Set cflags_column parameter
    Example 1.11. Set cflags_column parameter
 ...
 ...
@@ -400,7 +400,7 @@ modparam("usrloc", "cflags_column", "cflags")
 
 
    Name of column containing user-agent values.
    Name of column containing user-agent values.
 
 
-   Default value is “user_agent�.
+   Default value is "user_agent".
 
 
    Example 1.12. Set user_agent_column parameter
    Example 1.12. Set user_agent_column parameter
 ...
 ...
@@ -412,7 +412,7 @@ modparam("usrloc", "user_agent_column", "user_agent")
    Name of column containing the source IP, port, and protocol from the
    Name of column containing the source IP, port, and protocol from the
    REGISTER message.
    REGISTER message.
 
 
-   Default value is “received�.
+   Default value is "received".
 
 
    Example 1.13. Set received_column parameter
    Example 1.13. Set received_column parameter
 ...
 ...
@@ -424,7 +424,7 @@ modparam("usrloc", "received_column", "received")
    Name of column containing the received socket information (IP:port) for
    Name of column containing the received socket information (IP:port) for
    the REGISTER message.
    the REGISTER message.
 
 
-   Default value is “socket�.
+   Default value is "socket".
 
 
    Example 1.14. Set socket_column parameter
    Example 1.14. Set socket_column parameter
 ...
 ...
@@ -435,7 +435,7 @@ modparam("usrloc", "socket_column", "socket")
 
 
    Name of column containing the Path header.
    Name of column containing the Path header.
 
 
-   Default value is “path�.
+   Default value is "path".
 
 
    Example 1.15. Set path_column parameter
    Example 1.15. Set path_column parameter
 ...
 ...
@@ -448,7 +448,7 @@ modparam("usrloc", "path_column", "path")
    identifing the user (along with the username part). Useful in multi
    identifing the user (along with the username part). Useful in multi
    domain scenarios. Non 0 value means true.
    domain scenarios. Non 0 value means true.
 
 
-   Default value is “0 (false)�.
+   Default value is "0 (false)".
 
 
    Example 1.16. Set use_domain parameter
    Example 1.16. Set use_domain parameter
 ...
 ...
@@ -460,7 +460,7 @@ modparam("usrloc", "use_domain", 1)
    If the user's contacts should be kept timestamp ordered; otherwise the
    If the user's contacts should be kept timestamp ordered; otherwise the
    contact will be ordered based on q value. Non 0 value means true.
    contact will be ordered based on q value. Non 0 value means true.
 
 
-   Default value is “0 (false)�.
+   Default value is "0 (false)".
 
 
    Example 1.17. Set desc_time_order parameter
    Example 1.17. Set desc_time_order parameter
 ...
 ...
@@ -484,7 +484,7 @@ modparam("usrloc", "timer_interval", 120)
 
 
    URL of the database that should be used.
    URL of the database that should be used.
 
 
-   Default value is “mysql://openser:openserrw@localhost/openser�.
+   Default value is "mysql://openser:openserrw@localhost/openser".
 
 
    Example 1.19. Set db_url parameter
    Example 1.19. Set db_url parameter
 ...
 ...
@@ -540,7 +540,7 @@ modparam("usrloc", "db_mode", 2)
 3.21. matching_mode (integer)
 3.21. matching_mode (integer)
 
 
    What contact matching algorithm to be used. Refer to section
    What contact matching algorithm to be used. Refer to section
-   Section 1.1, “Contact matching� for the description of the algorithms.
+   Section 1.1, "Contact matching" for the description of the algorithms.
 
 
    The parameter may take the following values:
    The parameter may take the following values:
      * 0 - CONTACT ONLY based matching algorithm.
      * 0 - CONTACT ONLY based matching algorithm.
@@ -568,7 +568,7 @@ modparam("usrloc", "matching_mode", 1)
 
 
    A value of 0 disable the retransmission detection.
    A value of 0 disable the retransmission detection.
 
 
-   Default value is “20 seconds�.
+   Default value is "20 seconds".
 
 
    Example 1.22. Set cseq_delay parameter
    Example 1.22. Set cseq_delay parameter
 ...
 ...
@@ -582,7 +582,7 @@ modparam("usrloc", "cseq_delay", 5)
    startup. For 1MB of private memory (default) it should be below 4000.
    startup. For 1MB of private memory (default) it should be below 4000.
    The database driver must support fetch_result() capability.
    The database driver must support fetch_result() capability.
 
 
-   Default value is “2000�.
+   Default value is "2000".
 
 
    Example 1.23. Set fetch_rows parameter
    Example 1.23. Set fetch_rows parameter
 ...
 ...
@@ -595,7 +595,7 @@ modparam("usrloc", "fetch_rows", 3000)
    location records is 2^hash_size. For hash_size=4, the number of entries
    location records is 2^hash_size. For hash_size=4, the number of entries
    of the hash table is 16.
    of the hash table is 16.
 
 
-   Default value is “9�.
+   Default value is "9".
 
 
    Example 1.24. Set hash_size parameter
    Example 1.24. Set hash_size parameter
 ...
 ...
@@ -609,7 +609,7 @@ modparam("usrloc", "hash_size", 10)
    parameter only to load tables that are not used by registrar module
    parameter only to load tables that are not used by registrar module
    directly in configuration file.
    directly in configuration file.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
    Example 1.25. Set preload parameter
    Example 1.25. Set preload parameter
 ...
 ...
@@ -629,7 +629,7 @@ modparam("usrloc", "preload", "location")
    5.5. ul_add
    5.5. ul_add
    5.6. ul_show_contact
    5.6. ul_show_contact
 
 
-5.1.  ul_rm
+5.1. ul_rm
 
 
    Deletes an entire AOR record (including its contacts).
    Deletes an entire AOR record (including its contacts).
 
 
@@ -638,7 +638,7 @@ modparam("usrloc", "preload", "location")
      * AOR - user AOR in username[@domain] format (domain must be supplied
      * AOR - user AOR in username[@domain] format (domain must be supplied
        only if use_domain option is on).
        only if use_domain option is on).
 
 
-5.2.  ul_rm_contact
+5.2. ul_rm_contact
 
 
    Deletes a contact from an AOR record.
    Deletes a contact from an AOR record.
 
 
@@ -648,20 +648,20 @@ modparam("usrloc", "preload", "location")
        only if use_domain option is on).
        only if use_domain option is on).
      * contact - exact contact to be removed
      * contact - exact contact to be removed
 
 
-5.3.  ul_dump
+5.3. ul_dump
 
 
    Dumps the entire content of the USRLOC in memory cache
    Dumps the entire content of the USRLOC in memory cache
 
 
    Parameters:
    Parameters:
      * brief - (optional, may not be present); if equals to string
      * brief - (optional, may not be present); if equals to string
-       “brief�, a brief dump will be done (only AOR and contacts, with no
+       "brief", a brief dump will be done (only AOR and contacts, with no
        other details)
        other details)
 
 
-5.4.  ul_flush
+5.4. ul_flush
 
 
    Triggers the flush of USRLOC memory cache into DB.
    Triggers the flush of USRLOC memory cache into DB.
 
 
-5.5.  ul_add
+5.5. ul_add
 
 
    Adds a new contact for an user AOR.
    Adds a new contact for an user AOR.
 
 
@@ -677,7 +677,7 @@ modparam("usrloc", "preload", "location")
      * cflags - per branch flags of the contact
      * cflags - per branch flags of the contact
      * methods - mask with supported requests of the contact
      * methods - mask with supported requests of the contact
 
 
-5.6.  ul_show_contact
+5.6. ul_show_contact
 
 
    Dumps the contacts of an user AOR.
    Dumps the contacts of an user AOR.
 
 
@@ -686,7 +686,7 @@ modparam("usrloc", "preload", "location")
      * AOR - user AOR in username[@domain] format (domain must be supplied
      * AOR - user AOR in username[@domain] format (domain must be supplied
        only if use_domain option is on).
        only if use_domain option is on).
 
 
-6. Exported statistics
+6. Statistics
 
 
    6.1. users
    6.1. users
    6.2. contacts
    6.2. contacts
@@ -765,7 +765,7 @@ Chapter 2. Developer Guide
    1.14. ul_register_ulcb(type ,callback, param)
    1.14. ul_register_ulcb(type ,callback, param)
    1.15. ul_get_num_users()
    1.15. ul_get_num_users()
 
 
-1.1.  ul_register_domain(name)
+1.1. ul_register_domain(name)
 
 
    The function registers a new domain. Domain is just another name for
    The function registers a new domain. Domain is just another name for
    table used in registrar. The function is called from fixups in
    table used in registrar. The function is called from fixups in
@@ -780,7 +780,7 @@ Chapter 2. Developer Guide
      * const char* name - Name of the domain (also called table) to be
      * const char* name - Name of the domain (also called table) to be
        registered.
        registered.
 
 
-1.2.  ul_insert_urecord(domain, aor, rec)
+1.2. ul_insert_urecord(domain, aor, rec)
 
 
    The function creates a new record structure and inserts it in the
    The function creates a new record structure and inserts it in the
    specified domain. The record is structure that contains all the
    specified domain. The record is structure that contains all the
@@ -795,7 +795,7 @@ Chapter 2. Developer Guide
 
 
      * urecord_t** rec - The newly created record structure.
      * urecord_t** rec - The newly created record structure.
 
 
-1.3.  ul_delete_urecord(domain, aor)
+1.3. ul_delete_urecord(domain, aor)
 
 
    The function deletes all the contacts bound with the given Address Of
    The function deletes all the contacts bound with the given Address Of
    Record.
    Record.
@@ -807,7 +807,7 @@ Chapter 2. Developer Guide
      * str* aor - Address of record (aka username) of the record, that
      * str* aor - Address of record (aka username) of the record, that
        should be deleted.
        should be deleted.
 
 
-1.4.  ul_get_urecord(domain, aor)
+1.4. ul_get_urecord(domain, aor)
 
 
    The function returns pointer to record with given Address of Record.
    The function returns pointer to record with given Address of Record.
 
 
@@ -817,7 +817,7 @@ Chapter 2. Developer Guide
 
 
      * str* aor - Address of Record of request record.
      * str* aor - Address of Record of request record.
 
 
-1.5.  ul_lock_udomain(domain)
+1.5. ul_lock_udomain(domain)
 
 
    The function lock the specified domain, it means, that no other
    The function lock the specified domain, it means, that no other
    processes will be able to access during the time. This prevents race
    processes will be able to access during the time. This prevents race
@@ -828,14 +828,14 @@ Chapter 2. Developer Guide
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
      * udomain_t* domain - Domain to be locked.
      * udomain_t* domain - Domain to be locked.
 
 
-1.6.  ul_unlock_udomain(domain)
+1.6. ul_unlock_udomain(domain)
 
 
    Unlock the specified domain previously locked by ul_lock_udomain.
    Unlock the specified domain previously locked by ul_lock_udomain.
 
 
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
      * udomain_t* domain - Domain to be unlocked.
      * udomain_t* domain - Domain to be unlocked.
 
 
-1.7.  ul_release_urecord(record)
+1.7. ul_release_urecord(record)
 
 
    Do some sanity checks - if all contacts have been removed, delete the
    Do some sanity checks - if all contacts have been removed, delete the
    entire record structure.
    entire record structure.
@@ -843,7 +843,7 @@ Chapter 2. Developer Guide
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
      * urecord_t* record - Record to be released.
      * urecord_t* record - Record to be released.
 
 
-1.8.  ul_insert_ucontact(record, contact, expires, q, callid, cseq, flags,
+1.8. ul_insert_ucontact(record, contact, expires, q, callid, cseq, flags,
 cont, ua, sock)
 cont, ua, sock)
 
 
    The function inserts a new contact in the given record with specified
    The function inserts a new contact in the given record with specified
@@ -864,7 +864,7 @@ cont, ua, sock)
      * struct socket_info *sock - socket on which the REGISTER message was
      * struct socket_info *sock - socket on which the REGISTER message was
        received on.
        received on.
 
 
-1.9.  ul_delete_ucontact (record, contact)
+1.9. ul_delete_ucontact (record, contact)
 
 
    The function deletes given contact from record.
    The function deletes given contact from record.
 
 
@@ -874,7 +874,7 @@ cont, ua, sock)
 
 
      * ucontact_t* contact - Contact to be deleted.
      * ucontact_t* contact - Contact to be deleted.
 
 
-1.10.  ul_get_ucontact(record, contact)
+1.10. ul_get_ucontact(record, contact)
 
 
    The function tries to find contact with given Contact URI and returns
    The function tries to find contact with given Contact URI and returns
    pointer to structure representing the contact.
    pointer to structure representing the contact.
@@ -884,13 +884,13 @@ cont, ua, sock)
 
 
      * str_t* contact - URI of the request contact.
      * str_t* contact - URI of the request contact.
 
 
-1.11.  ul_get_all_ucontacts (buf, len, flags)
+1.11. ul_get_all_ucontacts (buf, len, flags)
 
 
    The function retrieves all contacts of all registered users and returns
    The function retrieves all contacts of all registered users and returns
    them in the caller-supplied buffer. If the buffer is too small, the
    them in the caller-supplied buffer. If the buffer is too small, the
    function returns positive value indicating how much additional space
    function returns positive value indicating how much additional space
    would be necessary to accommodate all of them. Please note that the
    would be necessary to accommodate all of them. Please note that the
-   positive return value should be used only as a “hint�, as there is no
+   positive return value should be used only as a "hint", as there is no
    guarantee that during the time between two subsequent calls number of
    guarantee that during the time between two subsequent calls number of
    registered contacts will remain the same.
    registered contacts will remain the same.
 
 
@@ -905,7 +905,7 @@ cont, ua, sock)
 
 
      * unsigned int flags - Flags that must be set.
      * unsigned int flags - Flags that must be set.
 
 
-1.12.  ul_update_ucontact(contact, expires, q, callid, cseq, set, res, ua,
+1.12. ul_update_ucontact(contact, expires, q, callid, cseq, set, res, ua,
 sock)
 sock)
 
 
    The function updates contact with new values.
    The function updates contact with new values.
@@ -924,7 +924,7 @@ sock)
      * struct socket_info *sock - socket on which the REGISTER message was
      * struct socket_info *sock - socket on which the REGISTER message was
        received on.
        received on.
 
 
-1.13.  ul_bind_ursloc( api )
+1.13. ul_bind_ursloc( api )
 
 
    The function imports all functions that are exported by the USRLOC
    The function imports all functions that are exported by the USRLOC
    module. Overs for other modules which want to user the internal USRLOC
    module. Overs for other modules which want to user the internal USRLOC
@@ -933,7 +933,7 @@ sock)
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
      * usrloc_api_t* api - USRLOC API
      * usrloc_api_t* api - USRLOC API
 
 
-1.14.  ul_register_ulcb(type ,callback, param)
+1.14. ul_register_ulcb(type ,callback, param)
 
 
    The function register with USRLOC a callback function to be called when
    The function register with USRLOC a callback function to be called when
    some event occures inside USRLOC.
    some event occures inside USRLOC.
@@ -946,6 +946,6 @@ sock)
      * void *param - some parameter to be passed to the callback each time
      * void *param - some parameter to be passed to the callback each time
        when it is called.
        when it is called.
 
 
-1.15.  ul_get_num_users()
+1.15. ul_get_num_users()
 
 
    The function loops through all domains summing up the number of users.
    The function loops through all domains summing up the number of users.