Browse code

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

Kamailio Dev authored on 15/09/2020 15:46:10
Showing 1 changed files
... ...
@@ -254,21 +254,22 @@ Chapter 1. Admin Guide
254 254
    If path support is enabled in the registrar module, a call to save(...)
255 255
    stores the values of the Path Header(s) along with the contact into
256 256
    usrloc. There are three modes regarding the reply to a REGISTER
257
-   including one or more Path HFs:
257
+   including one or more Path header fields:
258 258
      * off - stores the value of the Path headers into usrloc without
259 259
        passing it back to the UAC in the reply.
260 260
      * lazy - stores the Path header and passes it back to the UAC if
261
-       Path-support is indicated by the “path” param in the Supported HF.
261
+       Path-support is indicated by the “path” param in the Supported
262
+       header field.
262 263
      * strict - rejects the registration with “420 Bad Extension” if
263 264
        there's a Path header but no support for it is indicated by the
264 265
        UAC. Otherwise it's stored and passed back to the UAC.
265 266
 
266 267
    A call to lookup(...) always uses the path header if found, and inserts
267
-   it as Route HF either in front of the first Route HF, or after the last
268
-   Via HF if no Route is present. It also sets the destination uri to the
269
-   first Path uri, thus overwriting the received-uri, because NAT has to
270
-   be handled at the outbound-proxy of the UAC (the first hop after
271
-   client's NAT).
268
+   it as Route header field either in front of the first Route header
269
+   field, or after the last Via header field if no Route is present. It
270
+   also sets the destination uri to the first Path uri, thus overwriting
271
+   the received-uri, because NAT has to be handled at the outbound-proxy
272
+   of the UAC (the first hop after client's NAT).
272 273
 
273 274
    The whole process is transparent to the user, so no config changes are
274 275
    required beside setting the registrar-parameters “use_path” and
... ...
@@ -341,10 +342,10 @@ Chapter 1. Admin Guide
341 342
 
342 343
 3.1. default_expires (integer)
343 344
 
344
-   If the processed message contains neither Expires HFs nor expires
345
-   contact parameters, this value will be used for newly created usrloc
346
-   records. The parameter contains number of second to expire (for example
347
-   use 3600 for one hour). If it is set to a lower value than the
345
+   If the processed message contains neither Expires header fields nor
346
+   expires contact parameters, this value will be used for newly created
347
+   usrloc records. The parameter contains number of second to expire (for
348
+   example use 3600 for one hour). If it is set to a lower value than the
348 349
    “min_expires” parameter then it will be ignored. This parameter can be
349 350
    modified via ser config framework. A random value in a specific
350 351
    interval can be selected by using the default_expires_range parameter
... ...
@@ -955,8 +956,8 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0
955 956
 4.1.  save(domain, [, flags [, uri]])
956 957
 
957 958
    The function processes a REGISTER message. It can add, remove or modify
958
-   location records (in usrloc) depending on Contact and Expires HFs in
959
-   the REGISTER message. On success and when called from the
959
+   location records (in usrloc) depending on Contact and Expires header
960
+   fields in the REGISTER message. On success and when called from the
960 961
    REQUEST_ROUTE, “200 OK” will be returned listing all contacts that are
961 962
    currently in the location database. On an error, an error message will
962 963
    be sent with a short description in reason phrase.
... ...
@@ -966,7 +967,7 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0
966 967
        then this must be name of the table which stores the contacts.
967 968
      * flags (optional) - the value may be a bitwise OR of the following
968 969
        flags:
969
-          + 0x01 - save the contacts only in memory cache without no DB
970
+          + 0x01 - save the contacts only in memory cache with no DB
970 971
             operation;
971 972
           + 0x02 - do not generate a SIP reply to the current REGISTER
972 973
             request. When used in ONREPLY_ROUTE, this parameter is