Browse code

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

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