Browse code

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

Kamailio Dev authored on 15/09/2020 16:01:38
Showing 1 changed files
... ...
@@ -245,21 +245,22 @@ Chapter 1. Admin Guide
245 245
    If path support is enabled in the registrar module, a call to save(...)
246 246
    stores the values of the Path Header(s) along with the contact into
247 247
    usrloc. There are three modes regarding the reply to a REGISTER
248
-   including one or more Path HFs:
248
+   including one or more Path header fields:
249 249
      * off - stores the value of the Path headers into usrloc without
250 250
        passing it back to the UAC in the reply.
251 251
      * lazy - stores the Path header and passes it back to the UAC if
252
-       Path-support is indicated by the “path” param in the Supported HF.
252
+       Path-support is indicated by the “path” param in the Supported
253
+       header field.
253 254
      * strict - rejects the registration with “420 Bad Extension” if
254 255
        there's a Path header but no support for it is indicated by the
255 256
        UAC. Otherwise it's stored and passed back to the UAC.
256 257
 
257 258
    A call to lookup(...) always uses the path header if found, and inserts
258
-   it as Route HF either in front of the first Route HF, or after the last
259
-   Via HF if no Route is present. It also sets the destination uri to the
260
-   first Path uri, thus overwriting the received-uri, because NAT has to
261
-   be handled at the outbound-proxy of the UAC (the first hop after
262
-   client's NAT).
259
+   it as Route header field either in front of the first Route header
260
+   field, or after the last Via header field if no Route is present. It
261
+   also sets the destination uri to the first Path uri, thus overwriting
262
+   the received-uri, because NAT has to be handled at the outbound-proxy
263
+   of the UAC (the first hop after client's NAT).
263 264
 
264 265
    The whole process is transparent to the user, so no config changes are
265 266
    required beside setting the registrar-parameters “use_path” and
... ...
@@ -329,10 +330,10 @@ Chapter 1. Admin Guide
329 330
 
330 331
 3.1. default_expires (integer)
331 332
 
332
-   If the processed message contains neither Expires HFs nor expires
333
-   contact parameters, this value will be used for newly created usrloc
334
-   records. The parameter contains number of second to expire (for example
335
-   use 3600 for one hour). If it is set to a lower value than the
333
+   If the processed message contains neither Expires header fields nor
334
+   expires contact parameters, this value will be used for newly created
335
+   usrloc records. The parameter contains number of second to expire (for
336
+   example use 3600 for one hour). If it is set to a lower value than the
336 337
    “min_expires” parameter then it will be ignored. This parameter can be
337 338
    modified via ser config framework. A random value in a specific
338 339
    interval can be selected by using the default_expires_range parameter
... ...
@@ -892,8 +893,8 @@ request_route {
892 893
 4.1.  save(domain, [, flags [, uri]])
893 894
 
894 895
    The function processes a REGISTER message. It can add, remove or modify
895
-   location records (in usrloc) depending on Contact and Expires HFs in
896
-   the REGISTER message. On success and when called from the
896
+   location records (in usrloc) depending on Contact and Expires header
897
+   fields in the REGISTER message. On success and when called from the
897 898
    REQUEST_ROUTE, “200 OK” will be returned listing all contacts that are
898 899
    currently in the location database. On an error, an error message will
899 900
    be sent with a short description in reason phrase.
... ...
@@ -903,7 +904,7 @@ request_route {
903 904
        then this must be name of the table which stores the contacts.
904 905
      * flags (optional) - the value may be a bitwise OR of the following
905 906
        flags:
906
-          + 0x01 - save the contacts only in memory cache without no DB
907
+          + 0x01 - save the contacts only in memory cache with no DB
907 908
             operation;
908 909
           + 0x02 - do not generate a SIP reply to the current REGISTER
909 910
             request. When used in ONREPLY_ROUTE, this parameter is