Browse code

modules: readme files regenerated - acc ... [skip ci]

Kamailio Dev authored on 28/02/2018 17:03:37
Showing 153 changed files
... ...
@@ -456,7 +456,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
456 456
    one SIP call but with 2 legs ( A to B and B to C). Accounting the legs
457 457
    of a call is required for proper billing of the calls (if C is a PSTN
458 458
    number and the call is billed, user B must pay for the call - as last
459
-   party modifing the call destination-, and not A - as initiator of the
459
+   party modifying the call destination-, and not A - as initiator of the
460 460
    call. Call forwarding on server is only one example which shows the
461 461
    necessity of the having an accounting engine with multiple legs
462 462
    support.
... ...
@@ -465,7 +465,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
465 465
 
466 466
    First how it works: The idea is to have a set of AVPs and for each call
467 467
    leg to store a set of values in the AVPs. The meaning of the AVP
468
-   content is stricly decided by the script writer - it can be the origin
468
+   content is strictly decided by the script writer - it can be the origin
469 469
    and source of the leg, its status or any other related information. If
470 470
    you have a set of 4 AVPS (AVP1, AVP2, AVP3, AVP4), then for the "A call
471 471
    B and B forwards to C" example, you need to set a different set of
... ...
@@ -493,8 +493,8 @@ if (uri=~"sip:+40") /* calls to Romania */ {
493 493
        call-leg info.
494 494
 
495 495
 Note
496
-       You will need to add in your DB (all acc related tables) the colums
497
-       for call-leg info (a column for each AVP of the set).
496
+       You will need to add in your DB (all acc related tables) the
497
+       columns for call-leg info (a column for each AVP of the set).
498 498
      * Radius -- all sets will be added to the same Radius accounting
499 499
        message as RADIUS AVPs - for each call-leg a set of RADIUS AVPs
500 500
        will be added (corresponding to the per-leg AVP set). Note that
... ...
@@ -593,10 +593,10 @@ Note
593 593
    with the corresponding caller and callee in a dialog based
594 594
    pseudo-variable (dlg_var) (e.g. chain=B;cfa;C|C;cfnr;D). Additionally
595 595
    it is necessary to store the caller and callee for each leg. All this
596
-   helps to identify the involved phone parners and forwarding chain. When
597
-   you route such calls multiple times to the same Proxy, you could store
598
-   the caller and callee within an transaction based avp and write it into
599
-   the dialog based dlg_var pv during a 200 INVITE.
596
+   helps to identify the involved phone partners and forwarding chain.
597
+   When you route such calls multiple times to the same Proxy, you could
598
+   store the caller and callee within an transaction based avp and write
599
+   it into the dialog based dlg_var pv during a 200 INVITE.
600 600
 
601 601
 4.3.2.1. Example for a spiraled Proxy
602 602
 
... ...
@@ -768,7 +768,7 @@ modparam("acc", "report_cancels", 1)
768 768
 
769 769
 6.6. detect_direction (integer)
770 770
 
771
-   Controlles the direction detection for sequential requests. If enabled
771
+   Controls the direction detection for sequential requests. If enabled
772 772
    (non zero value), for sequential requests with upstream direction (from
773 773
    callee to caller), the FROM and TO will be swapped (the direction will
774 774
    be preserved as in the original request).
... ...
@@ -871,7 +871,7 @@ modparam("acc", "log_level", 2)   # Set log_level to 2 (L_INFO)
871 871
 6.13. log_facility (string)
872 872
 
873 873
    Log facility to which accounting messages are issued to syslog. This
874
-   allows to easily seperate the accounting specific logging from the
874
+   allows to easily separate the accounting specific logging from the
875 875
    other log messages.
876 876
 
877 877
    Default value is LOG_DAEMON.
... ...
@@ -919,7 +919,7 @@ modparam("acc", "db_missed_flag", 3)
919 919
 
920 920
 6.17. db_table_acc (string)
921 921
 
922
-   Table name of accounting successfull calls -- database specific. It can
922
+   Table name of accounting successful calls -- database specific. It can
923 923
    contain config variables that will be evaluated at runtime.
924 924
 
925 925
    Default value is “acc”
... ...
@@ -944,8 +944,8 @@ modparam("acc", "db_table_missed_calls", "myMC_table")
944 944
 
945 945
 6.19. db_url (string)
946 946
 
947
-   SQL address -- database specific. If is set to NULL or emty string, the
948
-   SQL support is disabled.
947
+   SQL address -- database specific. If is set to NULL or empty string,
948
+   the SQL support is disabled.
949 949
 
950 950
    Default value is “NULL” (SQL disabled).
951 951
 
... ...
@@ -1001,7 +1001,7 @@ modparam("acc", "acc_callid_column", "callid")
1001 1001
 
1002 1002
 6.24. acc_sip_code_column (string)
1003 1003
 
1004
-   Column name in accounting table to store the final reply's numric code
1004
+   Column name in accounting table to store the final reply's numeric code
1005 1005
    value in string format.
1006 1006
 
1007 1007
    Default value is “sip_code”.
... ...
@@ -1336,7 +1336,7 @@ modparam("acc", "reason_from_hf", 1)
1336 1336
 
1337 1337
    If set to 1, request structure from transaction is cloned temporarily
1338 1338
    in the callback to get acc attributes. It is required if you account
1339
-   values from SIP headers to avoid concurent access to the shared memory
1339
+   values from SIP headers to avoid concurrent access to the shared memory
1340 1340
    transaction structure, specially when accounting 1xx events. If set to
1341 1341
    0, it uses directly the shared memory structure, be sure you store all
1342 1342
    needed attributes in AVPs/XAVPs inside request route.
... ...
@@ -1468,15 +1468,15 @@ Chapter 2. Frequently Asked Questions
1468 1468
 
1469 1469
        The parameter became obsolete with the restructure of the data logged
1470 1470
        by ACC module (refer to the Overview chapter). For similar behaviour
1471
-       you can use the extra accouting (see the coresponding chapter).
1471
+       you can use the extra accounting (see the corresponding chapter).
1472 1472
 
1473 1473
    2.2.
1474 1474
 
1475 1475
        What happened with old multi_leg_enabled parameter
1476 1476
 
1477
-       The parameter becaome obsolete by the addition of the new
1478
-       multi_leg_info parameter. The multi-leg accouting is automatically
1479
-       enabled when multi_leg_info is defined.
1477
+       The parameter became obsolete by the addition of the new multi_leg_info
1478
+       parameter. The multi-leg accounting is automatically enabled when
1479
+       multi_leg_info is defined.
1480 1480
 
1481 1481
    2.3.
1482 1482
 
... ...
@@ -10,7 +10,7 @@ Ramona-Elena Modroiu
10 10
    rosdev.ro
11 11
    <ramona@rosdev.ro>
12 12
 
13
-   Copyright � 2002, 2003 FhG FOKUS
13
+   Copyright © 2002, 2003 FhG FOKUS
14 14
      __________________________________________________________________
15 15
 
16 16
    Table of Contents
... ...
@@ -73,7 +73,7 @@ Chapter 1. Admin Guide
73 73
 
74 74
    NOTE: This was developed based on some very early version of the
75 75
    Diameter protocol, and has not been really tested for many years. It is
76
-   verly likely to be deleted in upcoming releases. If you want to revive
76
+   very likely to be deleted in upcoming releases. If you want to revive
77 77
    this module, you are welcome, be sure you do proper testing before
78 78
    using in production -- it also may need to be updated first to match
79 79
    the exported API by 'acc' module.
... ...
@@ -143,7 +143,7 @@ modparam("acc_diameter", "diameter_missed_flag", 3)
143 143
    Hostname of the machine where the DIAMETER Client is running --
144 144
    DIAMETER specific.
145 145
 
146
-   Default value is "localhost".
146
+   Default value is “localhost”.
147 147
 
148 148
    Example 1.3. diameter_client_host example
149 149
 ...
... ...
@@ -179,7 +179,7 @@ email)")
179 179
 
180 180
    4.1. acc_diam_request(comment)
181 181
 
182
-4.1. acc_diam_request(comment)
182
+4.1.  acc_diam_request(comment)
183 183
 
184 184
    Like acc_log_request, acc_diam_request reports on a request. It reports
185 185
    to the configured Diameter server.
... ...
@@ -16,7 +16,7 @@ Julien Chavanton
16 16
    flowroute.com
17 17
    <jchavanton@gmail.com>
18 18
 
19
-   Copyright � 2018 Flowroute.com
19
+   Copyright © 2018 Flowroute.com
20 20
      __________________________________________________________________
21 21
 
22 22
    Table of Contents
... ...
@@ -142,7 +142,7 @@ modparam("acc_json", "acc_missed_flag", 3)
142 142
 
143 143
 3.3. acc_extra (integer)
144 144
 
145
-   Extra values to be added to the json dictionnary.
145
+   Extra values to be added to the json dictionary.
146 146
 
147 147
    Default value is NULL.
148 148
 
... ...
@@ -225,7 +225,7 @@ route[RUN_CDR_PUBLISH] {
225 225
 3.7. output_syslog (integer)
226 226
 
227 227
    Control if the output of acc json should be sent to syslog. This is not
228
-   dependent on Kamailio global logging settigns, we can use syslog even
228
+   dependent on Kamailio global logging settings, we can use syslog even
229 229
    if Kamailio is not daemonized and/or logging is done to sdtout stderr.
230 230
 
231 231
    Default value is not-set (no flag).
... ...
@@ -240,7 +240,7 @@ modparam("acc_json", "log_facility", "LOG_DAEMON")
240 240
 3.8. log_facility (integer)
241 241
 
242 242
    Log facility to which accounting messages are issued to syslog. This
243
-   allows to easily seperate the accounting specific logging from the
243
+   allows to easily separate the accounting specific logging from the
244 244
    other log messages.
245 245
 
246 246
    Default value is LOG_DAEMON.
... ...
@@ -87,8 +87,8 @@ Chapter 1. Admin Guide
87 87
 1. Overview
88 88
 
89 89
    The ALIAS_DB module can be used as an alternative for user aliases via
90
-   usrloc. The main feature is that it does not store all addiacent data
91
-   as for user location and always uses the database for search (no memory
90
+   usrloc. The main feature is that it does not store all adjacent data as
91
+   for user location and always uses the database for search (no memory
92 92
    caching). A common use case is to provide additional user aliases, i.e.
93 93
    to supplement the registration in the location database. Users are this
94 94
    way on a proxy reachable with several request URIs.
... ...
@@ -229,7 +229,7 @@ modparam("app_java", "java_options", "-Xdebug -verbose:gc,class,jni
229 229
 
230 230
 4.4. force_cmd_exec (int)
231 231
 
232
-   This parameter forces execution a kamailio comnmand with java native
232
+   This parameter forces execution a kamailio command with java native
233 233
    method “KamExec”. # Note: this is an untested yet feature, may cause
234 234
    (but may not) a memory leaks if used from embedded languages.
235 235
 
... ...
@@ -291,8 +291,8 @@ modparam("app_java", "force_cmd_exec", 1)
291 291
         Each parameter passed to function will be cast according to given signat
292 292
 ure.
293 293
 
294
-        Parameters are optional, ommitting a parameter meant the passed value is
295
- NULL.
294
+        Parameters are optional, omitting a parameter meant the passed value is
295
+NULL.
296 296
         Parameters count should be exactly the same as signature count.
297 297
         Note 1: Arrays representation (symbol '[') is not supported yet.
298 298
         Note 2: You shall use a correct signature, e.g. the following examples o
... ...
@@ -332,7 +332,7 @@ public int ExampleMethod(String param1, int param2);
332 332
 java_method_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml");
333 333
 
334 334
 # Java
335
-public int ExampleMethod(String SipMessageBuffer, int SipMessageLenght)
335
+public int ExampleMethod(String SipMessageBuffer, int SipMessageLength)
336 336
 {
337 337
     ... do something with buffer;
338 338
     return 1;
... ...
@@ -392,7 +392,7 @@ public static int ExampleMethod(String param1, int param2);
392 392
 java_staticmethod_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml");
393 393
 
394 394
 # Java
395
-public static int ExampleMethod(String SipMessageBuffer, int SipMessageLenght)
395
+public static int ExampleMethod(String SipMessageBuffer, int SipMessageLength)
396 396
 {
397 397
     ... do something with buffer;
398 398
     return 1;
... ...
@@ -453,7 +453,7 @@ java_s_method_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml");
453 453
 
454 454
 # Java
455 455
 public synchronized int ExampleMethod(String SipMessageBuffer, int SipMessageLen
456
-ght)
456
+gth)
457 457
 {
458 458
     ... do something with buffer;
459 459
     return 1;
... ...
@@ -516,7 +516,7 @@ java_s_staticmethod_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml");
516 516
 
517 517
 # Java
518 518
 public static synchronized int ExampleMethod(String SipMessageBuffer, int SipMes
519
-sageLenght)
519
+sageLength)
520 520
 {
521 521
     ... do something with buffer;
522 522
     return 1;
... ...
@@ -94,7 +94,7 @@ Chapter 1. Admin Guide
94 94
        Therefore jsdt_run() cannot execute functions from scripts loaded
95 95
        via jsdt_dofile() in config. This is kind of caching mode, avoiding
96 96
        reading file every time, but you must be sure you do not have
97
-       someting that is executed by default and requires access to SIP
97
+       something that is executed by default and requires access to SIP
98 98
        message. This environment is also used by KEMI framework for the
99 99
        config SIP routing functions.
100 100
 
... ...
@@ -113,7 +113,7 @@ Chapter 1. Admin Guide
113 113
    The following libraries or applications must be installed before
114 114
    running Kamailio with this module loaded:
115 115
      * libm - the math library (part of standard system libraries - it is
116
-       needed to complile embedded Duktape JS interpreter).
116
+       needed to compile embedded Duktape JS interpreter).
117 117
 
118 118
 3. Parameters
119 119
 
... ...
@@ -102,7 +102,7 @@ Chapter 1. Admin Guide
102 102
        Therefore lua_run() cannot execute functions from scripts loaded
103 103
        via lua_dofile() in config. This is kind of caching mode, avoiding
104 104
        reading file every time, but you must be sure you do not have
105
-       someting that is executed by default and requires access to SIP
105
+       something that is executed by default and requires access to SIP
106 106
        message.
107 107
 
108 108
 2. Dependencies
... ...
@@ -268,7 +268,7 @@ pemap"
268 268
    The Perl module has two interfaces: The perl side, and the Kamailio
269 269
    side. Once a Perl function is defined and loaded via the module
270 270
    parameters (see below), it may be called in Kamailio's configuration at
271
-   an arbitary point. E.g., you could write a function "ldap_alias" in
271
+   an arbitrary point. E.g., you could write a function "ldap_alias" in
272 272
    Perl, and then execute
273 273
 ...
274 274
 if (perl_exec("ldap_alias")) {
... ...
@@ -294,7 +294,7 @@ if (perl_exec("ldap_alias")) {
294 294
 4.1. Kamailio Modules
295 295
 
296 296
    The following modules must be loaded before this module:
297
-     * The "sl" module is needed for sending replies uppon fatal errors.
297
+     * The "sl" module is needed for sending replies upon fatal errors.
298 298
        All other modules can be accessed from the Perl module, though.
299 299
 
300 300
 4.2. External Libraries or Applications
... ...
@@ -343,7 +343,7 @@ if (perl_exec("ldap_alias")) {
343 343
 5.1. filename (string)
344 344
 
345 345
    This is the file name of your script. This may be set once only, but it
346
-   may include an arbitary number of functions and “use” as many Perl
346
+   may include an arbitrary number of functions and “use” as many Perl
347 347
    module as necessary.
348 348
 
349 349
    Must not be empty!
... ...
@@ -1065,9 +1065,9 @@ my $phonenumbers = new Kamailio::Utils::PhoneNumbers(
1065 1065
 $canonical = $phonenumbers->canonicalForm("07612034567");
1066 1066
 $number    = $phonenumbers->dialNumber("+497612034567");
1067 1067
 
1068
-   A telphone number starting with a plus sign and containing all dial
1069
-   prefixes is in canonical form. This is usally not the number to dial at
1070
-   any location, so the dialing number depends on the context of the
1068
+   A telephone number starting with a plus sign and containing all dial
1069
+   prefixes is in canonical form. This is usually not the number to dial
1070
+   at any location, so the dialing number depends on the context of the
1071 1071
    user/system.
1072 1072
 
1073 1073
    The idea to canonicalize numbers were taken from hylafax.
... ...
@@ -1083,7 +1083,7 @@ $number    = $phonenumbers->dialNumber("+497612034567");
1083 1083
    829. Then we add all the general dial prefixes - 49 (country) 761
1084 1084
    (area) 4514 (pbx) and 829, the number itself => +497614514829
1085 1085
 
1086
-   To get the dialing number from a canonical phone number, we substract
1086
+   To get the dialing number from a canonical phone number, we subtract
1087 1087
    all general prefixes until we have something
1088 1088
 
1089 1089
    As said before, the interpretation of a phone number depends on the
... ...
@@ -1140,8 +1140,8 @@ my $conf = new Kamailio::LDAPUtils::LDAPConf();
1140 1140
    used by other LDAP software, such as nsswitch.ldap and pam-ldap. The
1141 1141
    configuration is usualy stored in /etc/openldap/ldap.conf
1142 1142
 
1143
-   When used from an account with sufficient privilegs (e.g. root), the
1144
-   ldap manager passwort is also retrieved.
1143
+   When used from an account with sufficient privileges (e.g. root), the
1144
+   ldap manager password is also retrieved.
1145 1145
 
1146 1146
 6.1. Constructor new()
1147 1147
 
... ...
@@ -1162,14 +1162,14 @@ my $conf = new Kamailio::LDAPUtils::LDAPConf();
1162 1162
 6.5. Method uri()
1163 1163
 
1164 1164
    Returns an uri to contact the ldap server. When there is no ldap_uri in
1165
-   the configuration file, an ldap: uri is constucted from host and port.
1165
+   the configuration file, an ldap: uri is constructed from host and port.
1166 1166
 
1167 1167
 6.6. Method rootbindpw()
1168 1168
 
1169 1169
    Returns the ldap "root" password.
1170 1170
 
1171 1171
    Note that the rootbindpw is only available when the current account has
1172
-   sufficient privilegs to access /etc/openldap/ldap.secret.
1172
+   sufficient privileges to access /etc/openldap/ldap.secret.
1173 1173
 
1174 1174
 6.7. Method rootbinddn()
1175 1175
 
... ...
@@ -1233,8 +1233,8 @@ ou=de");
1233 1233
 7.2. Function/Method search( conf, filter, base, [requested_attributes ...])
1234 1234
 
1235 1235
    perform an ldap search, return the dn of the first matching directory
1236
-   entry, unless a specific attribute has been requested, in wich case the
1237
-   values(s) fot this attribute are returned.
1236
+   entry, unless a specific attribute has been requested, in which case
1237
+   the values(s) for this attribute are returned.
1238 1238
 
1239 1239
    When the first argument (conf) is a
1240 1240
    Kamailio::LDAPUtils::LDAPConnection, it will be used to perform the
... ...
@@ -1270,7 +1270,7 @@ ou=de");
1270 1270
    matching entries in the LDAP directory.
1271 1271
 
1272 1272
    When some requested_attributes are given, return an array with those
1273
-   attibutes. When multiple entries match the query, the attribute lists
1273
+   attributes. When multiple entries match the query, the attribute lists
1274 1274
    are concatenated.
1275 1275
 
1276 1276
 8. Kamailio::VDB
... ...
@@ -1371,7 +1371,7 @@ ou=de");
1371 1371
 
1372 1372
    This package handles virtual tables and is used by the Kamailio::VDB
1373 1373
    class to store information about valid tables. The package is not
1374
-   inteded for end user access.
1374
+   intended for end user access.
1375 1375
 
1376 1376
 17.1. new()
1377 1377
 
... ...
@@ -1622,7 +1622,7 @@ Chapter 3. Perl samples
1622 1622
    When processing SIP messages, you may want to use persistent data
1623 1623
    across multiple calls to your Perl functions. Your first option is to
1624 1624
    use global variables in your script. Unfortunately, these globals are
1625
-   not visible from the mulitple instances of Kamailio. You may want to
1625
+   not visible from the multiple instances of Kamailio. You may want to
1626 1626
    use a mechanism such as the IPC::Shareable shared memory access package
1627 1627
    to correct this.
1628 1628
 
... ...
@@ -119,8 +119,8 @@ modparam("app_python", "load", "/usr/local/etc/kamailio/myscript.py")
119 119
 
120 120
 3.3. mod_init_function (string)
121 121
 
122
-   The Python function to be executed by this module when it is initialied
123
-   by Kamailio.
122
+   The Python function to be executed by this module when it is
123
+   initialized by Kamailio.
124 124
 
125 125
    Default value is “mod_init”.
126 126
 
... ...
@@ -132,7 +132,7 @@ modparam("app_python", "mod_init_function", "my_mod_init")
132 132
 3.4. child_init_method (string)
133 133
 
134 134
    The Python function to be executed by this module when a new worker
135
-   process (child) is initialied by Kamailio.
135
+   process (child) is initialized by Kamailio.
136 136
 
137 137
    Default value is “child_init”.
138 138
 
... ...
@@ -135,8 +135,8 @@ modparam("app_python3", "load", "/usr/local/etc/kamailio/myscript.py")
135 135
 
136 136
 3.3. mod_init_function (string)
137 137
 
138
-   The Python function to be executed by this module when it is initialied
139
-   by Kamailio.
138
+   The Python function to be executed by this module when it is
139
+   initialized by Kamailio.
140 140
 
141 141
    Default value is “mod_init”.
142 142
 
... ...
@@ -148,7 +148,7 @@ modparam("app_python3", "mod_init_function", "my_mod_init")
148 148
 3.4. child_init_method (string)
149 149
 
150 150
    The Python function to be executed by this module when a new worker
151
-   process (child) is initialied by Kamailio.
151
+   process (child) is initialized by Kamailio.
152 152
 
153 153
    Default value is “child_init”.
154 154
 
... ...
@@ -1,4 +1,3 @@
1
-
2 1
 app_sqlang Module
3 2
 
4 3
 Daniel-Constantin Mierla
... ...
@@ -95,7 +94,7 @@ Chapter 1. Admin Guide
95 95
        Therefore sqlang_run() cannot execute functions from scripts loaded
96 96
        via sqlang_dofile() in config. This is kind of caching mode,
97 97
        avoiding reading file every time, but you must be sure you do not
98
-       have someting that is executed by default and requires access to
98
+       have something that is executed by default and requires access to
99 99
        SIP message. This environment is also used by KEMI framework for
100 100
        the config SIP routing functions.
101 101
 
... ...
@@ -317,7 +317,7 @@ modparam("auth", "qop", "auth")   # set qop=auth
317 317
    Note: nonce_count should be enabled only in stateful mode (a
318 318
    transaction should be created prior to the authentication check to
319 319
    absorb possible retransmissions and all the replies should be sent
320
-   statefuly, using t_reply()). If nonce_count and the authentication
320
+   statefully, using t_reply()). If nonce_count and the authentication
321 321
    checks are used in the stateless mode then all retransmissions will be
322 322
    challenged.
323 323
 
... ...
@@ -705,7 +705,7 @@ if (www_authenticate("realm", "subscriber")) {
705 705
 
706 706
 4.2. has_credentials(realm)
707 707
 
708
-   This function returns true of the request has Autorization or
708
+   This function returns true of the request has Authorization or
709 709
    Proxy-Authorization header with provided realm. The parameter can be
710 710
    string with pseudo-variables.
711 711
 
... ...
@@ -823,9 +823,9 @@ if (!auth_check("$fd", "subscriber", "1")) {
823 823
        to the user so he can decide what username and password to use.
824 824
        Usually this is domain of the host the server is running on.
825 825
        It must not be empty string “”. In case of REGISTER requests To
826
-       header field domain (e.g., varibale $td) can be used (because this
826
+       header field domain (e.g., variable $td) can be used (because this
827 827
        header field represents a user being registered), for all other
828
-       messages From header field domain can be used (e.g., varibale $fd).
828
+       messages From header field domain can be used (e.g., variable $fd).
829 829
        The string may contain pseudo variables.
830 830
      * passwd - the password to be used for authentication. Can contain
831 831
        config variables. The Username is taken from Auth header.
... ...
@@ -879,7 +879,7 @@ if (!pv_proxy_authenticate("$fd", "$avp(password)", "0")) {
879 879
 4.8.  pv_auth_check(realm, passwd, flags, checks)
880 880
 
881 881
    The function combines the functionalities of pv_www_authenticate and
882
-   pv_proxy_authenticate, first being exectuted if the SIP request is a
882
+   pv_proxy_authenticate, first being executed if the SIP request is a
883 883
    REGISTER, the second for the rest.
884 884
 
885 885
    Meaning of the first three parameters is the same as for
... ...
@@ -219,7 +219,7 @@ modparam("auth_db", "password_column_2", "ha1_2")
219 219
 3.6. calculate_ha1 (integer)
220 220
 
221 221
    This parameter tells the server whether it should use a pre-calculated
222
-   HA1 string or plaintext passwords for authentification.
222
+   HA1 string or plaintext passwords for authentication.
223 223
 
224 224
    If the parameter is set to 0 and the username parameter of credentials
225 225
    contains also “@domain” (some user agents append the domain to the
... ...
@@ -268,7 +268,7 @@ modparam("auth_db", "use_domain", 1)
268 268
 
269 269
    This parameter specifies of credentials to be fetch from database when
270 270
    the authentication is performed. The loaded credentials will be stored
271
-   in AVPs. If the AVP name is not specificaly given, it will be used a
271
+   in AVPs. If the AVP name is not specifically given, it will be used a
272 272
    NAME AVP with the same name as the column name.
273 273
 
274 274
    Parameter syntax:
... ...
@@ -276,7 +276,7 @@ modparam("auth_db", "use_domain", 1)
276 276
      * credential = (avp_specification '=' column_name) | (column_name)
277 277
      * avp_specification = '$avp(' + 'i:'ID | 's:'NAME | alias + ')'
278 278
 
279
-   Default value of this parameter is “NULL” (no credientials loaded).
279
+   Default value of this parameter is “NULL” (no credentials loaded).
280 280
 
281 281
    Example 1.8. load_credentials parameter usage
282 282
 ...
... ...
@@ -431,7 +431,7 @@ if (!proxy_authorize("$fd", "subscriber)) {
431 431
        user. All other requests: From header must match the authentication
432 432
        user. If bit 2 is set as well (flags==3), the ID check is skipped
433 433
        for INVITE, BYE, PRACK, UPDATE, MESSAGE - these requests can come
434
-       with anonymoys caller id.
434
+       with anonymous caller id.
435 435
        Additionally all domains in the checked URIs and the realm in the
436 436
        authentication header will be checked to match the provided realm
437 437
        parameter.
... ...
@@ -224,7 +224,7 @@ modparam("auth_ephemeral", "username_format", 0)
224 224
 
225 225
 3.3. sha_algorithm (integer)
226 226
 
227
-   The SHA algorhithm to be used for the Hash.
227
+   The SHA algorithm to be used for the Hash.
228 228
 
229 229
      * 0 - SHA1 (default, as per IETF/RFC)
230 230
      * 1 - SHA256
... ...
@@ -62,7 +62,7 @@ Phil Lavin
62 62
 
63 63
    List of Examples
64 64
 
65
-   1.1. “SIP-AVP” RADIUS AVP exmaples
65
+   1.1. “SIP-AVP” RADIUS AVP examples
66 66
    1.2. radius_config parameter usage
67 67
    1.3. service_type parameter usage
68 68
    1.4. auth_extra parameter usage
... ...
@@ -108,13 +108,13 @@ Chapter 1. Admin Guide
108 108
    to make sure that only well formed credentials will get to the server.
109 109
    We have implemented radius authentication according to
110 110
    draft-sterman-aaa-sip-00. This module requires the radiusclient-ng
111
-   library version 0.5.0 or higheer or freeradius-client which is
112
-   available from https://github.com/FreeRADIUS/freeradius-client/. You
113
-   can also install this library from distribution repositories.
111
+   library version 0.5.0 or higher or freeradius-client which is available
112
+   from https://github.com/FreeRADIUS/freeradius-client/. You can also
113
+   install this library from distribution repositories.
114 114
 
115 115
 2. Additional Credentials
116 116
 
117
-   When performing authentification, the RADIUS server may include
117
+   When performing authentication, the RADIUS server may include
118 118
    additional credentials in the response. This scheme is very useful in
119 119
    fetching additional user information from the RADIUS server without
120 120
    making extra queries.
... ...
@@ -130,7 +130,7 @@ Chapter 1. Admin Guide
130 130
 
131 131
    The RPID value may be fetch via this mechanism.
132 132
 
133
-   Example 1.1. “SIP-AVP” RADIUS AVP exmaples
133
+   Example 1.1. “SIP-AVP” RADIUS AVP examples
134 134
 ....
135 135
 "email:joe@yahoo.com"
136 136
     - STRING NAME AVP (email) with STRING VALUE (joe@yahoo.com)
... ...
@@ -156,7 +156,7 @@ Chapter 1. Admin Guide
156 156
 3.2. External Libraries or Applications
157 157
 
158 158
    The following libraries or applications must be installed before
159
-   compilling Kamailio with this module loaded:
159
+   compiling Kamailio with this module loaded:
160 160
 
161 161
    One of these libraries. Notice that development of radiusclient-ng has
162 162
    stopped, as the project merged with freeradius-client.
... ...
@@ -94,8 +94,8 @@ Chapter 1. Admin Guide
94 94
    of the new node. On large deployments, that can become rather complex.
95 95
    For example, as a replacement for IP trust relationships, the sender
96 96
    can hash the local IP with the secret shared key, add it in the header
97
-   and the receiver will check if the source ip hased with the key results
98
-   in the same value.
97
+   and the receiver will check if the source ip hashed with the key
98
+   results in the same value.
99 99
 
100 100
    Not being a challenge-reply mechanism, this can be used to authenticate
101 101
    SIP responses from trusted peers.
... ...
@@ -143,7 +143,7 @@ modparam("auth_xkeys", "xkey", "id=abc;name=xyz;value=secret;expires=72000")
143 143
 
144 144
 4.1.  auth_xkeys_add(hdr, kid, alg, data)
145 145
 
146
-   Add a header computed with the first key in the group kid, hasing with
146
+   Add a header computed with the first key in the group kid, hashing with
147 147
    algorithm alg over the content of parameter data. The parameters can
148 148
    include variables.
149 149
 
... ...
@@ -159,7 +159,7 @@ auth_xkeys_add("X-My-Key", "abc", "sha256", "$Ri:$fu:$ru:$hdr(CSeq)");
159 159
 4.2.  auth_xkeys_check(hdr, kid, alg, data)
160 160
 
161 161
    Check if the value of header hdr matches the value computed with the
162
-   first key in the group kid, hasing with algorithm alg over the content
162
+   first key in the group kid, hashing with algorithm alg over the content
163 163
    of parameter data. The parameters can include variables.
164 164
 
165 165
    The algorithm can be: sha256, sha384, sha512.
... ...
@@ -173,12 +173,12 @@ Chapter 1. Admin Guide
173 173
        all AVPs, regardless they have or not a script flag set (preserves
174 174
        the compatibility with the old naming schema).
175 175
      * avp_name = string | integer
176
-       string - might be any alphanumeric string, wich contain following
176
+       string - might be any alphanumeric string, which contain following
177 177
        characters: [a-z] [A-Z] [0-9] '_'
178 178
        integer - might be an unsigned integer, greater than zero, up to
179 179
        2^16-1
180 180
      * avp_alias = string
181
-       string - might be any alphanumeric string, wich contain following
181
+       string - might be any alphanumeric string, which contain following
182 182
        characters: [a-z] [A-Z] [0-9] '_'
183 183
 
184 184
    Example 1.1. AVP naming examples
... ...
@@ -374,7 +374,7 @@ modparam("avpops","db_scheme",
374 374
             'a' or 'A' means matching any of AVP name types ('i' and 's')
375 375
             (NOTE: matching_flags cannot be used with $db_scheme because
376 376
             the name of AVP to save in cannot be specified), the rest have
377
-            the meaning descriped in 'AVP naming format' chapter.
377
+            the meaning described in 'AVP naming format' chapter.
378 378
 
379 379
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
380 380
    BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
... ...
@@ -534,7 +534,7 @@ avp_pushto("$br","$avp(i:680)");
534 534
           + le - less or equal
535 535
           + gt - greater than
536 536
           + ge - greater or equal
537
-          + re - regexp (regular exression match)
537
+          + re - regexp (regular expression match)
538 538
           + fm - fast match (see: man fnmatch)
539 539
           + and - bitwise 'and'
540 540
           + or - bitwise 'or'
... ...
@@ -280,7 +280,7 @@ bm_log_timer("test");
280 280
 6.1. benchmark.enable_global
281 281
 
282 282
    Enables/disables the module. Parameter may be -1, 0 or 1. See
283
-   discription of "enable" parameter.
283
+   description of "enable" parameter.
284 284
 
285 285
 6.2. benchmark.enable_timer
286 286
 
... ...
@@ -137,13 +137,13 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
137 137
      * 0x04 - connect failed (TCP, TLS or SCTP).
138 138
      * 0x08 - ICMP error (not currently used).
139 139
      * 0x10 - SIP transaction timeout.
140
-     * 0x20 - 503 reply (statefull mode only). For more details see
140
+     * 0x20 - 503 reply (stateful mode only). For more details see
141 141
        tmblst_503.
142 142
 
143 143
 Note
144 144
 
145 145
    TCP and TLS send and connect errors are handled per connection and not
146
-   per message. The connection blacklist ignore flags are inherithed from
146
+   per message. The connection blacklist ignore flags are inherited from
147 147
    the message that caused the connection establishment.
148 148
 
149 149
    Example 1.5. blst_set_ignore usage
... ...
@@ -137,7 +137,7 @@ Chapter 1. Admin Guide
137 137
        to be used and it has to be started by engage_media_proxy() to be
138 138
        able to keep track of the call's dialog and end it on timeout.
139 139
        Even when mediaproxy is unable to end the dialog because it was not
140
-       started with engage_media_proxy(), the callcantrol application is
140
+       started with engage_media_proxy(), the callcontrol application is
141 141
        still able to detect calls that did timeout sending media, by
142 142
        looking in the radius accounting records for entries recorded by
143 143
        mediaproxy for calls that did timeout. These calls will also be
... ...
@@ -226,7 +226,7 @@ modparam("call_control", "socket_timeout", 500)
226 226
 
227 227
    This is used by the rating engine which finds the rates to apply to a
228 228
    call based on caller's SIP URI, caller's SIP domain or caller's IP
229
-   address (whichever yields a rate forst, in this order).
229
+   address (whichever yields a rate first, in this order).
230 230
 
231 231
    Default value is “$avp(s:signaling_ip)”.
232 232
 
... ...
@@ -237,13 +237,13 @@ Chapter 1. Admin Guide
237 237
    at Kamailio startup. It can uses one routing tree (for one carrier), or
238 238
    if needed for every user a different routing tree (unique for each
239 239
    carrier) for number prefix based routing. It supports several route
240
-   tree domains, e.g. for failback routes or different routing rules for
240
+   tree domains, e.g. for fallback routes or different routing rules for
241 241
    VoIP and PSTN targets.
242 242
 
243 243
    Based on the tree, the module decides which number prefixes are
244 244
    forwarded to which gateway. It can also distribute the traffic by ratio
245 245
    parameters. Furthermore, the requests can be distributed by a hash
246
-   funcion to predictable destinations. The hash source is configurable,
246
+   function to predictable destinations. The hash source is configurable,
247 247
    two different hash functions are available.
248 248
 
249 249
    This modules scales up to more than a few million users, and is able to
... ...
@@ -286,7 +286,7 @@ Chapter 1. Admin Guide
286 286
    Starting with version 3.1 , if you want to use this module in failure
287 287
    routes, it is not needed to call“append_branch()” after rewriting the
288 288
    request URI in order to relay the message to the new target. Its also
289
-   supportes the usage of database derived failure routing descisions with
289
+   supports the usage of database derived failure routing decisions with
290 290
    the carrierfailureroute table.
291 291
 
292 292
 2. Dependencies
... ...
@@ -459,9 +459,9 @@ modparam("carrierroute", "db_load_description", 0)
459 459
 3.12. match_mode (integer)
460 460
 
461 461
    The number of individual characters that are used for matching. Valid
462
-   values are 10 or 128. When you specifiy 10, only digits will be used
463
-   for matching, this operation mode is equivalent to the old behaviour.
464
-   When configured with 128, all standard ascii chars are available for
462
+   values are 10 or 128. When you specify 10, only digits will be used for
463
+   matching, this operation mode is equivalent to the old behaviour. When
464
+   configured with 128, all standard ascii chars are available for
465 465
    matching. Please be aware that memory requirements for storing the
466 466
    routing tree in shared memory will also increase by a factor of 12.8.
467 467
 
... ...
@@ -540,9 +540,9 @@ descavp)
540 540
    Request URI is rewritten using rewrite_user and the given hash source
541 541
    and algorithm. Returns -1 if there is no data found or an empty rewrite
542 542
    host on the longest match is found. On success also the description is
543
-   stored in the given AVP (if obmitted, nothing is stored in an AVP).
544
-   This is useful if you need some additional informations that belongs to
545
-   each gw, like the destination or the number of channels.
543
+   stored in the given AVP (if omitted, nothing is stored in an AVP). This
544
+   is useful if you need some additional informations that belongs to each
545
+   gw, like the destination or the number of channels.
546 546
 
547 547
    Depending on the value of the avoid_failed_destinations module
548 548
    parameter, the function pays special attention to the failurerouting
... ...
@@ -589,16 +589,16 @@ hash_source, descavp)
589 589
    Request URI is rewritten using rewrite_user and the given hash source
590 590
    and algorithm. Returns -1 if there is no data found or an empty rewrite
591 591
    host on the longest match is found. On success also the description is
592
-   stored in the given AVP (if obmitted, nothing is stored in an AVP).
593
-   This is useful if you need some additional informations that belongs to
594
-   each gw, like the destination or the number of channels. This function
595
-   is only usable with rewrite_user and prefix_matching containing a valid
592
+   stored in the given AVP (if omitted, nothing is stored in an AVP). This
593
+   is useful if you need some additional informations that belongs to each
594
+   gw, like the destination or the number of channels. This function is
595
+   only usable with rewrite_user and prefix_matching containing a valid
596 596
    string. This string needs to be numerical if the match_mode parameter
597 597
    is set to 10.
598 598
 
599 599
    It uses the standard CRC32 algorithm to calculate the hash values. In
600 600
    contrast to the normal cr_route function the backup rules of (now
601
-   obselete) cr_prime_route is used. This means not the configured
601
+   obsolete) cr_prime_route is used. This means not the configured
602 602
    probabilities will be used, only a fixed hash distribution. This makes
603 603
    sense to distribute incoming register requests e.g. to a bunch of
604 604
    registrar servers. If one of the hash targets is not available and
... ...
@@ -883,13 +883,13 @@ failure_route[1] {
883 883
    All traffic will be equally distributed between the hosts, both are
884 884
    active. The hash algorithm will working over the [1,2] set, messages
885 885
    hashed to one will go to the first host, the other to the second one.
886
-   Don't use a hash index value of zero. If you ommit the hash completly,
886
+   Don't use a hash index value of zero. If you omit the hash completely,
887 887
    the module gives them a autogenerated value, starting from one.
888 888
 
889 889
    Use the “NULL” prefix to specify an empty prefix in the config file.
890 890
    Please note that the prefix is matched against the request URI (or to
891 891
    URI), if they did not contain a valid (numerical) URI, no match is
892
-   possible. So for loadbalancing purposes e.g. for your registrars, you
892
+   possible. So for load-balancing purposes e.g. for your registrars, you
893 893
    should use an empty prefix.
894 894
 ...
895 895
 domain proxy {
... ...
@@ -989,9 +989,9 @@ domain register {
989 989
    section.
990 990
 
991 991
    This table provides also a “carrier 1” routing rule for the “49”
992
-   prefix, that is only choosen if some message flags are set. If this
992
+   prefix, that is only chosen if some message flags are set. If this
993 993
    flags are not set, the other two rules are used. The “strip”, “mask”
994
-   and “comment” colums are omitted for brevity.
994
+   and “comment” columns are omitted for brevity.
995 995
 
996 996
    Example 1.23. Example database content - simple carrierfailureroute
997 997
    table
... ...
@@ -1006,8 +1006,8 @@ domain register {
1006 1006
 
1007 1007
    This table contains two failure routes for the “gw.carrier1-1” and “-2”
1008 1008
    gateways. For any (failure) reply code the respective next domain is
1009
-   choosen. After that no more failure routes are available, an error will
1010
-   be returned from the “cr_next_domain” function. Not all table colums
1009
+   chosen. After that no more failure routes are available, an error will
1010
+   be returned from the “cr_next_domain” function. Not all table columns
1011 1011
    are show here for brevity.
1012 1012
 
1013 1013
    For each failure route domain and carrier that is added to the
... ...
@@ -1033,13 +1033,13 @@ domain register {
1033 1033
    for example that indicates that ringing has happened. If this flag is
1034 1034
    set, there will be no further forwarding, because next_domain is empty.
1035 1035
    In the second and third routes are certain gateway errors matched, if
1036
-   this errors have occurred, then the next domain will be choosen. Note
1036
+   this errors have occurred, then the next domain will be chosen. Note
1037 1037
    that the reply_code must be 3 characters wide, and only the "."
1038 1038
    character is accepted as wildcard.The last route does forwarding
1039 1039
    according some flags, e.g. the customer came from a certain carrier,
1040 1040
    and has call-forwarding deactivated. In order to use the routing that
1041 1041
    is specified above, a matching carrierroute table must be provided,
1042
-   that holds domain entries for this routing rules. Not all table colums
1042
+   that holds domain entries for this routing rules. Not all table columns
1043 1043
    are show here for brevity.
1044 1044
 
1045 1045
    Example 1.25. Example database content - carrier_name table
... ...
@@ -1072,7 +1072,7 @@ domain register {
1072 1072
 
1073 1073
    For a functional routing the “cr_preferred_carrier” column must be
1074 1074
    added to the subscriber table (or to the table and column that you
1075
-   specified as modul parameter) to choose the actual carrier for the
1075
+   specified as module parameter) to choose the actual carrier for the
1076 1076
    users.
1077 1077
 
1078 1078
    Example 1.27. Necessary extensions for the user table
... ...
@@ -1314,7 +1314,7 @@ modparam("carrierroute", "carrierfailureroute_domain_col", "domain")
1314 1314
 
1315 1315
 19. carrierfailureroute_scan_prefix_col (string)
1316 1316
 
1317
-   Name of column contains the the scan prefixes. Scan prexies define the
1317
+   Name of column contains the the scan prefixes. Scan prefixes define the
1318 1318
    matching portion of a phone number, e.g. we have the scan prefixes
1319 1319
    49721 and 49, the called number is 49721913740, it matches 49721,
1320 1320
    because the longest match is taken. If no prefix matches, the number is
... ...
@@ -246,7 +246,7 @@ modparam("cdp", "config_file", "/etc/kamailio/diametercfg.xml")
246 246
 
247 247
 4.2. latency_threshold (int)
248 248
 
249
-   The time in ms above which a log error is wrtten to log file for long
249
+   The time in ms above which a log error is written to log file for long
250 250
    CDP transactions.
251 251
 
252 252
    Default value is “500”.
... ...
@@ -292,7 +292,7 @@ modparam("cdp", "debug_heavy", 1)
292 292
    The method checks, if a specific peer is connected and ready.
293 293
 
294 294
    Meaning of the parameter is as follows:
295
-     * fqdn - the Fully qualified domai name of the peer, that should be
295
+     * fqdn - the Fully qualified domain name of the peer, that should be
296 296
        checked. The parameter may contain pseudovariables.
297 297
 
298 298
    Example 1.5. cdp_check_peer usage
... ...
@@ -358,8 +358,8 @@ if(!cdp_has_app("16777216")) {
358 358
 <!--
359 359
 
360 360
  DiameterPeer Parameters
361
-  - FQDN - FQDN of this peer, as it should apper in the Origin-Host AVP
362
-  - Realm - Realm of this peer, as it should apper in the Origin-Realm AVP
361
+  - FQDN - FQDN of this peer, as it should appear in the Origin-Host AVP
362
+  - Realm - Realm of this peer, as it should appear in the Origin-Realm AVP
363 363
   - Vendor_Id - Default Vendor-Id to appear in the Capabilities Exchange
364 364
   - Product_Name - Product Name to appear in the Capabilities Exchange
365 365
   - AcceptUnknownPeers - Whether to accept (1) or deny (0) connections from peer
... ...
@@ -419,8 +419,8 @@ easure meant to
419 419
         <!--
420 420
                 Definition of peers to connect to and accept connections from. F
421 421
 or each peer found in here
422
-                a dedicated receiver process will be forked. All other unkwnown
423
-peers will share a single
422
+                a dedicated receiver process will be forked. All other unknown p
423
+eers will share a single
424 424
                 receiver. NB: You must have a peer definition for each peer list
425 425
 ed in the realm routing section
426 426
         -->
... ...
@@ -477,13 +477,13 @@ CER/CEA in the
477 477
 tries will be used.
478 478
 
479 479
                 Note: In case a message already contains a Destination-Host AVP,
480
- Realm Routeing will not be
480
+ Realm Routing will not be
481 481
                 applied.
482 482
                 Note: Routing will only happen towards connected and application
483 483
  id supporting peers.
484 484
 
485
-                The metric is used to order the list of prefered peers, while lo
486
-oking for a connected and
485
+                The metric is used to order the list of preferred peers, while l
486
+ooking for a connected and
487 487
                 application id supporting peer. In the end, of course, just one
488 488
 peer will be selected.
489 489
         -->
... ...
@@ -916,7 +916,7 @@ searchType)
916 916
    Meaning of the parameters is as follows:
917 917
      * AAAResponseHandler_f *f - callback function to be called on
918 918
        incoming responses
919
-     * void *param - generic data to be bassed to callback function
919
+     * void *param - generic data to be passed to callback function
920 920
 
921 921
 Chapter 3. Frequently Asked Questions
922 922
 
... ...
@@ -74,7 +74,7 @@ Chapter 1. Admin Guide
74 74
 
75 75
 2. How it works
76 76
 
77
-   CDP AVP is a lightwieght helper module that doesn't really do much
77
+   CDP AVP is a lightweight helper module that doesn't really do much
78 78
    other than offer a set of AVP facilitating functions for various
79 79
    application uses. CDP AVP module is used in conjunction with CDP
80 80
    module.
... ...
@@ -101,7 +101,7 @@ Chapter 1. Admin Guide
101 101
 
102 102
 5. Functions
103 103
 
104
-   No functions available from configuraion. See API for internal
104
+   No functions available from configuration. See API for internal
105 105
    functions.
106 106
 
107 107
 Chapter 2. Developer Guide
... ...
@@ -100,7 +100,7 @@ modparam("cfg_db", "db_url", "mysql://SER:123@127.0.0.1:12345/SER");
100 100
    used. The default values are declared in record having group_name
101 101
    called <default>. The C-code "absolutely" default values ("cfg_var",
102 102
    "group_name", "name", "value"). The other keyword is asterisk * which
103
-   matches all parameters and will be used if parameter is not explicitely
103
+   matches all parameters and will be used if parameter is not explicitly
104 104
    mentioned.
105 105
 
106 106
 3.3. custom_tbl (string) := "cfg_custom"
... ...
@@ -89,7 +89,7 @@ Chapter 1. Admin Guide
89 89
    such as debug, tcp/sctp/dns attributes, without the need of restart.
90 90
 
91 91
    RPC connector modules, such as “ctl” or “xmlrpc”, although not a
92
-   dependecy, should be loaded in order to execute the RPC commands
92
+   dependency, should be loaded in order to execute the RPC commands
93 93
    exported by this module. When the ctl module is loaded, the tool
94 94
    'kamcmd' can be used to execute the RPC commands implemented in this
95 95
    module.
... ...
@@ -171,7 +171,8 @@ modparam("debugger", "cfgtest", 1)
171 171
    processed and the SIP messages sent during that process execution.
172 172
 
173 173
    The flow of the configuration routes is defined by an array of routes
174
-   with the content of the variables controled by “mask” module parameter.
174
+   with the content of the variables controlled by “mask” module
175
+   parameter.
175 176
 
176 177
    Each routename has a prefix as “start|”, “return|”, when the route
177 178
    finish its execution and “exit|” or “drop|” if the route finish its
... ...
@@ -52,7 +52,7 @@ Daniel-Constantin Mierla
52 52
         4. Functions
53 53
 
54 54
               4.1. rand_event()
55
-              4.2. rand_set_prob(probabiltiy)
55
+              4.2. rand_set_prob(probability)
56 56
               4.3. rand_reset_prob()
57 57
               4.4. rand_get_prob()
58 58
               4.5. sleep(time)
... ...
@@ -141,7 +141,7 @@ Chapter 1. Admin Guide
141 141
    4. Functions
142 142
 
143 143
         4.1. rand_event()
144
-        4.2. rand_set_prob(probabiltiy)
144
+        4.2. rand_set_prob(probability)
145 145
         4.3. rand_reset_prob()
146 146
         4.4. rand_get_prob()
147 147
         4.5. sleep(time)
... ...
@@ -291,7 +291,7 @@ modparam("cfgutils", "lock_set_size", 4)
291 291
 4. Functions
292 292
 
293 293
    4.1. rand_event()
294
-   4.2. rand_set_prob(probabiltiy)
294
+   4.2. rand_set_prob(probability)
295 295
    4.3. rand_reset_prob()
296 296
    4.4. rand_get_prob()
297 297
    4.5. sleep(time)
... ...
@@ -326,7 +326,7 @@ if (rand_event()) {
326 326
 # normal message processing follows
327 327
 ...
328 328
 
329
-4.2. rand_set_prob(probabiltiy)
329
+4.2. rand_set_prob(probability)
330 330
 
331 331
    Set the “probability” of the decision.
332 332
 
... ...
@@ -339,7 +339,7 @@ rand_set_prob("4");
339 339
 
340 340
 4.3. rand_reset_prob()
341 341
 
342
-   Reset the probability back to the inital value.
342
+   Reset the probability back to the initial value.
343 343
 
344 344
    Example 1.7. rand_reset_prob() usage
345 345
 ...
... ...
@@ -382,7 +382,7 @@ sleep("1");
382 382
 
383 383
    Example 1.10. usleep usage
384 384
 ...
385
-# wait 5 miliseconds
385
+# wait 5 milliseconds
386 386
 usleep("5000");
387 387
 ...
388 388
 
... ...
@@ -508,7 +508,7 @@ if(is_gflag("4"))
508 508
 
509 509
 4.15. lock(key)
510 510
 
511
-   Lock the key. Can be used to syncronize operations in config file, a
511
+   Lock the key. Can be used to synchronize operations in config file, a
512 512
    hash id is computed over the key and appropriate lock is set in the
513 513
    lock array controlled by parameter "lock_set_size". Do not use lock()
514 514
    after another lock() unless you are sure the keys hit different array
... ...
@@ -632,7 +632,7 @@ core_hash("$ci", "", 4);
632 632
    5.9. cfgutils.get_gflags
633 633
 
634 634
    Functions that check or change some global flags accepts one parameter
635
-   which is the flag bitmap/mask specifing the corresponding flags. It is
635
+   which is the flag bitmap/mask specifying the corresponding flags. It is
636 636
    not possible to specify directly the flag position that should be
637 637
    changed as in the functions available in the routing script.
638 638
 
... ...
@@ -650,7 +650,7 @@ $ kamcmd cfgutils.rand_set_prob 10
650 650
 
651 651
 5.2. cfgutils.rand_reset_prob
652 652
 
653
-   Reset the probability value to the inital start value.
653
+   Reset the probability value to the initial start value.
654 654
 
655 655
    This command don't need a parameter.
656 656
 
... ...
@@ -154,7 +154,7 @@ modparam("cnxcc", "redis", "addr=127.0.0.1;port=6379;db=1")
154 154
 3.2. credit_check_period (integer)
155 155
 
156 156
    Indicates how often the credit checking function should be called. It
157
-   is directly related to the precison of the module. The maximum
157
+   is directly related to the precision of the module. The maximum
158 158
    precision is 1, which means that every call is checked every one
159 159
    second.
160 160
 
... ...
@@ -177,7 +177,7 @@ modparam("cnxcc", "credit_check_period", 1)
177 177
 
178 178
    Associates the call with a customer id and sets the max credit, cost
179 179
    per second, initial pulse and final pulse. The discount is calculated
180
-   in pulses (30/6, 1/1, etc) and sustracted from the pool of credit.
180
+   in pulses (30/6, 1/1, etc) and subtracted from the pool of credit.
181 181
 
182 182
    The customer value can be provided as a string or a variable holding a
183 183
    string.
... ...
@@ -201,7 +201,7 @@ cnxcc_set_max_credit("john-doe", "100.5", "0.5", "20", "10");
201 201
 $var(customer) = "john-doe-premium"; # customer id
202 202
 $var(credit) = "100";       # max credit
203 203
 $var(cps)   = "2.00";       # cost per second
204
-$var(initial_p)   = 30;     # intial pulse
204
+$var(initial_p)   = 30;     # initial pulse
205 205
 $var(final_p)     = 6;      # final pulse
206 206
 cnxcc_set_max_credit("$var(customer)", "$var(credit)", "$var(cps)",
207 207
         "$var(initial_p)", "$var(final_p)");
... ...
@@ -462,7 +462,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
462 462
    After executing of this event route, if msg_avp was defined and set
463 463
    then its value is used for further processing, otherwise, original
464 464
    value of $mb is used. If message was received from remote host, then it
465
-   is parsed and proceeds to appropriate route. Oterhwise if message set
465
+   is parsed and proceeds to appropriate route. Otherwise if message set
466 466
    to send out, then is sent to remote host per configured SIP timers in
467 467
    config script.
468 468
 
... ...
@@ -493,7 +493,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
493 493
    proxy may be decrypted and sent to SIP application server at remote
494 494
    location unencrypted, where they are processed as normal. One the way
495 495
    back, the messages received from SIP application server at edge proxy
496
-   can be encrpyted before being sent to actual destination. The edge
496
+   can be encrypted before being sent to actual destination. The edge
497 497
    proxy can check whether received message came from end-user or SIP
498 498
    application server by using simple regular expressions.
499 499
 
... ...
@@ -513,9 +513,9 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
513 513
    device UUID along with ITV key, encrypted using RSA or AES256 with
514 514
    pre-shared secret, as first packet, which is set as cookie by server in
515 515
    e.g. memcache. This cookie is referred by client app in each next
516
-   packet, so server can retrive encyption key from cache and use that for
517
-   decryption. Same can be done for server at client app side, so messages
518
-   encrypted by server can be decrypted at client app.
516
+   packet, so server can retrieve encryption key from cache and use that
517
+   for decryption. Same can be done for server at client app side, so
518
+   messages encrypted by server can be decrypted at client app.
519 519
 
520 520
    Next is a basic usage example where encoding and decoding is done using
521 521
    PERL,
... ...
@@ -337,7 +337,7 @@ modparam("cpl-c","realm_prefix","sip.")
337 337
    value of the Final Response INVITE timeout - it's used by the TIMEOUT
338 338
    attribute from the PROXY tag.
339 339
 
340
-   NOTE: take care and syncronize this value with the similar parameters
340
+   NOTE: take care and synchronize this value with the similar parameters
341 341
    in TM module.
342 342
 
343 343
    Default value of this parameter is NULL.
... ...
@@ -228,7 +228,7 @@ modparam("ctl", "group", 100)
228 228
    Example 1.7. Set fifo parameter
229 229
 ...
230 230
 # old fifo support
231
-modparam("ctl", "fifo", "fifo:/tmp/ser_fifo")      # clasic fifo
231
+modparam("ctl", "fifo", "fifo:/tmp/ser_fifo")      # classic fifo
232 232
 modparam("ctl", "fifo", "/tmp/ser_fifo2")
233 233
 modparam("ctl", "fifo", "udp:*:2050")              # fifo protocol over udp
234 234
 modparam("ctl", "fifo", "tcp:*:2050")              # fifo over tcp
... ...
@@ -83,7 +83,7 @@ Chapter 1. Admin Guide
83 83
    "equal"/"non-equal" operator requires equality matching rule, the
84 84
    "greater"/"less" operator requires ordering matching rule. If required
85 85
    matching rule is missing the LDAP server silently returns empty result
86
-   set. In case of double filtering both at the LDAP servar and the LDAP
86
+   set. In case of double filtering both at the LDAP server and the LDAP
87 87
    module, e.g. multi-value and equal comparison, check the LDAP server
88 88
    matching rule satisfies your needs or use client_side_filtering
89 89
    feature.
... ...
@@ -185,7 +185,7 @@ filter = "(objectClass=digestAuthCredentials)"
185 185
 # Mapping of field names to LDAP attribute names and vice versa. Names are
186 186
 # delimited using ':', the first name is database field name as used in SER
187 187
 # modules, the second name (after :) is corresponding LDAP attribute name,
188
-# optionally preceeded with LDAP attribute syntax name in parentheses.
188
+# optionally preceded with LDAP attribute syntax name in parentheses.
189 189
 field_map = password : (Binary) digestPassword
190 190
 field_map = realm : digestRealm
191 191
 field_map = auth_username : digestUsername
... ...
@@ -206,7 +206,7 @@ tra_ops ]
206 206
 
207 207
    Executes query and in case of SELECT returns result via handle, seeks
208 208
    the first record and returns TRUE if table is not empty. The result is
209
-   accesible using @db.fetch select. See also declare_handle. Query_id
209
+   accessible using @db.fetch select. See also declare_handle. Query_id
210 210
    references to query declared using declare_query, handle references to
211 211
    query declared using declare_handle.
212 212
 
... ...
@@ -116,7 +116,7 @@ Chapter 1. Admin Guide
116 116
 3.1. auto_reload (integer)
117 117
 
118 118
    The auto-reload will close and reopen a Berkeley DB when the files
119
-   inode has changed. The operation occurs only duing a query. Other
119
+   inode has changed. The operation occurs only during a query. Other
120 120
    operations such as insert or delete, do not invoke auto_reload.
121 121
 
122 122
    Default value is 0 (1 - on / 0 - off).
... ...
@@ -177,7 +177,7 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
177 177
    Name: db_berkely.reload
178 178
 
179 179
    Parameters: tablename (or db_path); to reload a particular table
180
-   provide the tablename as the arguement (eg subscriber); to reload all
180
+   provide the tablename as the argument (eg subscriber); to reload all
181 181
    tables provide the db_path to the db files. The path can be found in
182 182
    kamctlrc DB_PATH variable.
183 183
 
... ...
@@ -193,7 +193,7 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
193 193
    compile in extra debug logs. However, it is not a recommended
194 194
    deployment to production servers.
195 195
 
196
-   Because the module dependes on an external library, the db_berkeley
196
+   Because the module depends on an external library, the db_berkeley
197 197
    module is not compiled and installed by default. You can use one of the
198 198
    next options.
199 199
      * edit the "Makefile" and remove "db_berkeley" from
... ...
@@ -264,7 +264,7 @@ lt none is loaded
264 264
    natural key. Consider an example where use_domain = 0. In table
265 265
    subscriber, the db will be keying on 'username|NULL' because the
266 266
    default value will be used when that key column is not provided. This
267
-   effectivly means that later queries must consistently use the username
267
+   effectively means that later queries must consistently use the username
268 268
    (w.o domain) in order to find a result to that particular subscriber
269 269
    query. The main point is 'use_domain' can not be changed once the
270 270
    db_berkeley is setup.
... ...
@@ -485,6 +485,6 @@ ast N files.
485 485
 
486 486
 14. Known Limitations
487 487
 
488
-   The Berkeley DB does not nativly support an autoincrement (or sequence)
489
-   mechanism. Consequently, this version does not support surragate keys
490
-   in dbschema. These are the id columns in the tables.
488
+   The Berkeley DB does not natively support an autoincrement (or
489
+   sequence) mechanism. Consequently, this version does not support
490
+   surrogate keys in dbschema. These are the id columns in the tables.
... ...
@@ -174,7 +174,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type';
174 174
 
175 175
 5. Installation
176 176
 
177
-   Because the db_cassandra module dependes on an external library, it is
177
+   Because the db_cassandra module depends on an external library, it is
178 178
    not compiled and installed by default. You can use one of these
179 179
    options:
180 180
      * - edit the "Makefile" and remove "db_cassandra" from
... ...
@@ -172,7 +172,7 @@ modparam("db_cluster", "max_query_length", 5)
172 172
    Practically, all the modules that want to use a cluster, have to set
173 173
    their db_url parameter to "cluster://clusterid".
174 174
 
175
-   Following rules apply when doing DB commands: the connecions with
175
+   Following rules apply when doing DB commands: the connections with
176 176
    highest priority are chosen first and the operations are performed
177 177
    according to the command mode. Note that for same priority, only one
178 178
    command mode is used (the one from the first connection with that
... ...
@@ -57,7 +57,7 @@ Chapter 1. Admin Guide
57 57
    information on sites with extremely high traffic. If MySQL is too slow
58 58
    or if you get a huge amount of accounting data then you can consider
59 59
    using this module. Please note that the acc module is the only module
60
-   that was tested with the flastore module.
60
+   that was tested with the flatstore module.
61 61
 
62 62
    The format of the files produced by this module is plain text. Each
63 63
    line consists of several fields, fields are separated by the "|"
... ...
@@ -77,7 +77,7 @@ modparam("acc", "db_url", "flatstore:/var/log/acc")
77 77
    Name of files in that directory will follow the following pattern:
78 78
 <table_name>_<process_name>.log
79 79
 
80
-   For example, entries writen by the Kamailio process 8 into the acc
80
+   For example, entries written by the Kamailio process 8 into the acc
81 81
    table would be written in file acc_8.log. For each table there will be
82 82
    several files, one file for every Kamailio process that wrote some data
83 83
    into that table. The main reason why there are several files for each
... ...
@@ -126,8 +126,8 @@ kamcmd flatstore.k_rotate
126 126
 
127 127
 2.2. encode_delimiter (integer)
128 128
 
129
-   Enable or disable encoding tof the escaped character using ""%" HEX
130
-   HEX" mechanism for escaping from RFC 2396
129
+   Enable or disable encoding of the escaped character using ""%" HEX HEX"
130
+   mechanism for escaping from RFC 2396
131 131
 
132 132
    Default value is 1. Default delimiter '|' is replaced with %7C if found
133 133
    in any string
... ...
@@ -67,7 +67,7 @@ Chapter 1. Admin Guide
67 67
 
68 68
 3. Remarks
69 69
 
70
-   Using this module as a database dirver may require additional settings
70
+   Using this module as a database driver may require additional settings
71 71
    for various modules. For example, you have to set module parameter
72 72
    'db_insert_null' to 1 for 'usrloc' module. If the module you are using
73 73
    with 'db_mongodb' fails, check its README for notes about using it with
... ...
@@ -90,7 +90,7 @@ Chapter 1. Admin Guide
90 90
 
91 91
    The following libraries or applications must be installed before
92 92
    running Kamailio with this module loaded:
93
-     * mysql - the development libraries forthe Mysql database. In some
93
+     * mysql - the development libraries for the MySQL database. In some
94 94
        Linux distributions named "libmysqlclient-dev".
95 95
 
96 96
 3. Parameters
... ...
@@ -116,7 +116,7 @@ modparam("db_mysql", "ping_interval", 600)
116 116
 
117 117
 3.2. server_timezone (integer)
118 118
 
119
-   Control if kamailio convers a time to string using the local timezone
119
+   Control if kamailio converts a time to string using the local timezone
120 120
    or if MySQL will convert it using FROM_UNIXTIME. This option is useful
121 121
    if kamailio and the database are configured for different timezones.
122 122
 
... ...
@@ -187,7 +187,7 @@ modparam("db_mysql", "update_affected_found", 1)
187 187
 
188 188
 5. Installation
189 189
 
190
-   Because it dependes on an external library, the mysql module is not
190
+   Because it depends on an external library, the mysql module is not
191 191
    compiled and installed by default. You can use one of these options.
192 192
      * - edit the "Makefile" and remove "db_mysql" from "excluded_modules"
193 193
        list. Then follow the standard procedure to install Kamailio: "make
... ...
@@ -135,7 +135,7 @@ modparam("db_oracle", "reconnect", 0.5)
135 135
 
136 136
 5. Installation
137 137
 
138
-   Because it dependes on an external library, the oracle module is not
138
+   Because it depends on an external library, the oracle module is not
139 139
    compiled and installed by default. You can use one of the next options.
140 140
      * - edit the "Makefile" and remove "db_oracle" from
141 141
        "excluded_modules" list. Then follow the standard procedure to
... ...
@@ -150,7 +150,7 @@ modparam("db_oracle", "reconnect", 0.5)
150 150
    command-line Oracle client (sqlplus) is not quite suitable for this, as
151 151
    it cannot align row width to real (received) data's (it always prints a
152 152
    cell width as described in the db scheme). This problem has been solved
153
-   by inclusion the utility openser_orasel, which formats printing
153
+   by inclusion the utility openser_oracle, which formats printing
154 154
    approximately in the same way as the 'mysql' client utility. In
155 155
    addition, this utility known about the "agreements and types" in DB
156 156
    that are used in Kamailio for the work with Oracle and formats printing
... ...
@@ -182,19 +182,19 @@ my $val = new Kamailio::VDB::Value(DB_STRING, "foobar");
182 182
    contains a column name (key). A new variable may be created with
183 183
 my $pair = new Kamailio::VDB::Pair("foo", DB_STRING, "bar");
184 184
 
185
-   where foo is the key and bar is the value. Additonally to the methods
185
+   where foo is the key and bar is the value. Additionally to the methods
186 186
    of the Value class, it contains a key() method to get or set the key
187 187
    attribute.
188 188
 
189 189
 3.3. Kamailio::VDB::ReqCond
190 190
 
191 191
    The ReqCond class is used for select condition and is derived from the
192
-   Pair class. It contains an addtional operator attribute. A new variable
193
-   may be created with
192
+   Pair class. It contains an additional operator attribute. A new
193
+   variable may be created with
194 194
 my $cond = new Kamailio::VDB::ReqCond("foo", ">", DB_INT, 5);
195 195
 
196 196
    where foo is the key, "greater" is the operator and 5 is the value to
197
-   compare. Additonally to the methods of the Pair class, it contains an
197
+   compare. Additionally to the methods of the Pair class, it contains an
198 198
    op() method to get or set the operator attribute.
199 199
 
200 200
 3.4. Kamailio::VDB::Column
... ...
@@ -274,7 +274,7 @@ my $cols = new Kamailio::VDB::Column(\@types, \@names);
274 274
        namespace.
275 275
 
276 276
      * Package/class. The defined class needs to have an init() function.
277
-       It will be called during the first call of that VTab. Addtionally,
277
+       It will be called during the first call of that VTab. Additionally,
278 278
        the package has to define the necessary functions insert, replace,
279 279
        update, delete and/or query. These functions will be called in a
280 280
        function context (first parameter is the class name).
... ...
@@ -88,11 +88,11 @@ Chapter 1. Admin Guide
88 88
 
89 89
 3.1. retries (integer)
90 90
 
91
-   How many retries to attept to reconnect if connection to Postgres
91
+   How many retries to attempt to reconnect if connection to Postgres
92 92
    server becomes broken.
93 93
 
94
-   Default value is 2 (that means three attepts to submit the query, first
95
-   will triger the connection error and two more (the value of this
94
+   Default value is 2 (that means three attempts to submit the query,
95
+   first will trigger the connection error and two more (the value of this
96 96
    parameter) after resetting the connection).
97 97
 
98 98
    Example 1.1. Set retries parameter
... ...
@@ -304,7 +304,7 @@ modparam("debugger", "step_loops", 100)
304 304
    levels per module (e.g., if its set to 4, internal hash table has 16
305 305
    slots). One must set it's value grater than 0 such that memory to be
306 306
    allocated to save the module specific debug levels or facility
307
-   configured by mod_level or mod_facility. This parameter is accesible
307
+   configured by mod_level or mod_facility. This parameter is accessible
308 308
    readonly via the Kamailio config framework.
309 309
 
310 310
    Default value is “0” - feature disabled.
... ...
@@ -634,7 +634,7 @@ P-Hint: My hint
634 634
    Resets the message sequence ($mi). Internally there is no real change.
635 635
    This can be useful for unit test cases in order to be able to replicate
636 636
    exactly the same kamailio output. You need to set the debugger
637
-   parameter reset_msgid to 1 to activate this functionallity.
637
+   parameter reset_msgid to 1 to activate this functionality.
638 638
 
639 639
    Name: dbg.reset_msgid
640 640
 
... ...
@@ -701,7 +701,7 @@ P-Hint: My hint
701 701
    A process blocked at a breakpoint is waiting for a command. Use 'dbg.bp
702 702
    next pid' to execute the current action and stop at the next one.
703 703
    'dbg.bp eval pid PV' can be used to retrieve the value of PV. Once you
704
-   are done and want to continue the execution of the config wihtout
704
+   are done and want to continue the execution of the config without
705 705
    interaction use 'dbg.bp move pid'.
706 706
 
707 707
    Example of a session:
... ...
@@ -1170,7 +1170,7 @@ modparam("dialog", "send_bye", 1)
1170 1170
 
1171 1171
 6.49. wait_ack (int)
1172 1172
 
1173
-   If set to 1, dialog will be keept a bit longer in memory in order to
1173
+   If set to 1, dialog will be kept a bit longer in memory in order to
1174 1174
    absorb the ACK negative replies of initial INVITE. If not, the dialog
1175 1175
    is destroyed when negative reply is sent out (less internal
1176 1176
    complexity).
... ...
@@ -1417,9 +1417,10 @@ if (is_in_profile("caller","XX")) {
1417 1417
    Returns the number of dialogs belonging to a profile. If the profile
1418 1418
    supports values, the check can be reinforced to take into account a
1419 1419
    specific value, i.e. how many dialogs were inserted into the profile
1420
-   with a specific value. If no value is passed, only the membersip of the
1421
-   dialog in the profile per se is checked. Note that if the profile does
1422
-   not support values, the value parameter will be silently discarded.
1420
+   with a specific value. If no value is passed, only the membership of
1421
+   the dialog in the profile per se is checked. Note that if the profile