Module: kamailio
Branch: master
Commit: 56a257509aabb41e8eddc0f18347b0289aa0ab01
URL: https://github.com/kamailio/kamailio/commit/56a257509aabb41e8eddc0f18347b02…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2020-09-15T17:46:10+02:00
modules: readme files regenerated - registrar ... [skip ci]
---
Modified: src/modules/registrar/README
---
Diff: https://github.com/kamailio/kamailio/commit/56a257509aabb41e8eddc0f18347b02…
Patch: https://github.com/kamailio/kamailio/commit/56a257509aabb41e8eddc0f18347b02…
---
diff --git a/src/modules/registrar/README b/src/modules/registrar/README
index fe9c969ce9..f4f5ccae0d 100644
--- a/src/modules/registrar/README
+++ b/src/modules/registrar/README
@@ -254,21 +254,22 @@ Chapter 1. Admin Guide
If path support is enabled in the registrar module, a call to save(...)
stores the values of the Path Header(s) along with the contact into
usrloc. There are three modes regarding the reply to a REGISTER
- including one or more Path HFs:
+ including one or more Path header fields:
* off - stores the value of the Path headers into usrloc without
passing it back to the UAC in the reply.
* 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.
+ Path-support is indicated by the “path” param in the Supported
+ header field.
* strict - rejects the registration with “420 Bad Extension” if
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.
A call to lookup(...) always uses the path header if found, and inserts
- it as Route HF either in front of the first Route HF, or after the last
- Via HF if no Route is present. It also sets the destination uri to the
- first Path uri, thus overwriting the received-uri, because NAT has to
- be handled at the outbound-proxy of the UAC (the first hop after
- client's NAT).
+ it as Route header field either in front of the first Route header
+ field, or after the last Via header field if no Route is present. It
+ also sets the destination uri to the first Path uri, thus overwriting
+ the received-uri, because NAT has to be handled at the outbound-proxy
+ of the UAC (the first hop after client's NAT).
The whole process is transparent to the user, so no config changes are
required beside setting the registrar-parameters “use_path” and
@@ -341,10 +342,10 @@ Chapter 1. Admin Guide
3.1. default_expires (integer)
- If the processed message contains neither Expires HFs nor expires
- contact parameters, this value will be used for newly created usrloc
- 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
+ If the processed message contains neither Expires header fields nor
+ expires contact parameters, this value will be used for newly created
+ usrloc 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
“min_expires” parameter then it will be ignored. This parameter can be
modified via ser config framework. A random value in a specific
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
4.1. save(domain, [, flags [, uri]])
The function processes a REGISTER message. It can add, remove or modify
- location records (in usrloc) depending on Contact and Expires HFs in
- the REGISTER message. On success and when called from the
+ location records (in usrloc) depending on Contact and Expires header
+ fields in the REGISTER message. On success and when called from the
REQUEST_ROUTE, “200 OK” will be returned listing all contacts that are
currently in the location database. On an error, an error message will
be sent with a short description in reason phrase.
@@ -966,7 +967,7 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0
then this must be name of the table which stores the contacts.
* flags (optional) - the value may be a bitwise OR of the following
flags:
- + 0x01 - save the contacts only in memory cache without no DB
+ + 0x01 - save the contacts only in memory cache with no DB
operation;
+ 0x02 - do not generate a SIP reply to the current REGISTER
request. When used in ONREPLY_ROUTE, this parameter is
### Description
Use of acronym "HF" (header field) in the REGISTRAR is a bit obscure. It probably makes sense to experienced Kamailio admins, but it's not immediately apparent to beginners. Since there is little gained by using the acronym in this document it would be more friendly to use "header field".
Also, there is a double negative in section 4.1/flags/0x01:
```
0x01 - save the contacts only in memory cache without no DB operation;
```
The literal meaning of this sentence is that it performs a DB operation. This should be changed to "with no" or possibly just "without", or even "with no".
### Expected behavior
Use 'header field' instead of 'HF'. Use "with" instead of "without no".
#### Actual observed behavior
As indicated above
#### Debugging Data
Not applicable
#### Log Messages
Not applicable
#### SIP Traffic
Not applicable
### Possible Solutions
Use 'header field' instead of 'HF'. Use "with" instead of "without no".
### Additional Information
* **Kamailio Version** - output of `kamailio -v`
Exists in most recent code branch.
* **Operating System**:
Not applicable.
--
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/issues/2477
#### Pre-Submission Checklist
<!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply -->
<!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above-->
<!-- If you're unsure about any of these, don't hesitate to ask on sr-dev mailing list -->
- [X] Commit message has the format required by CONTRIBUTING guide
- [X] Commits are split per component (core, individual modules, libs, utils, ...)
- [X] Each component has a single commit (if not, squash them into one commit)
- [X] No commits to README files for modules (changes must be done to docbook files
in `doc/` subfolder, the README file is autogenerated)
#### Type Of Change
- [X] Small bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds new functionality)
- [ ] Breaking change (fix or feature that would change existing functionality)
#### Checklist:
<!-- Go over all points below, and after creating the PR, tick the checkboxes that apply -->
- [X] PR should be backported to stable branches
- [X] Tested changes locally
- [X] Related to issue #2477
#### Description
Minor doc changes to Registrar module as described in Issue #2477
You can view, comment on, or merge this pull request online at:
https://github.com/kamailio/kamailio/pull/2478
-- Commit Summary --
* registrar: Update documentation
* registrar: Update documentation
-- File Changes --
M src/modules/registrar/doc/registrar_admin.xml (14)
-- Patch Links --
https://github.com/kamailio/kamailio/pull/2478.patchhttps://github.com/kamailio/kamailio/pull/2478.diff
--
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/pull/2478
Module: kamailio
Branch: master
Commit: d936c6276b6d8e45efd87a4fc25a55b9c3ab1fce
URL: https://github.com/kamailio/kamailio/commit/d936c6276b6d8e45efd87a4fc25a55b…
Author: whosgonna <ben.whosgonna.com(a)gmail.com>
Committer: Henning Westerholt <hw(a)skalatan.de>
Date: 2020-09-15T17:41:40+02:00
registrar: Update documentation
- Replace all occurences of "HF" with "header field"
- Replace all occurences of "HFs" with "header fields"
---
Modified: src/modules/registrar/doc/registrar_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/d936c6276b6d8e45efd87a4fc25a55b…
Patch: https://github.com/kamailio/kamailio/commit/d936c6276b6d8e45efd87a4fc25a55b…
---
diff --git a/src/modules/registrar/doc/registrar_admin.xml b/src/modules/registrar/doc/registrar_admin.xml
index e3140965d4..bb2d8f8646 100644
--- a/src/modules/registrar/doc/registrar_admin.xml
+++ b/src/modules/registrar/doc/registrar_admin.xml
@@ -28,7 +28,7 @@
If path support is enabled in the registrar module, a call to save(...)
stores the values of the Path Header(s) along with the contact into usrloc.
There are three modes regarding the reply to a REGISTER including
- one or more Path HFs:
+ one or more Path header fields:
</para>
<itemizedlist>
<listitem>
@@ -42,7 +42,7 @@
<para>
<emphasis>lazy</emphasis> - stores the Path header and
passes it back to the UAC if Path-support is indicated
- by the <quote>path</quote> param in the Supported HF.
+ by the <quote>path</quote> param in the Supported header field.
</para>
</listitem>
<listitem>
@@ -56,8 +56,8 @@
</itemizedlist>
<para>
A call to lookup(...) always uses the path header if
- found, and inserts it as Route HF either in front of
- the first Route HF, or after the last Via HF if no
+ found, and inserts it as Route header field either in front of
+ the first Route header field, or after the last Via header field if no
Route is present. It also sets the destination uri to
the first Path uri, thus overwriting the received-uri,
because NAT has to be handled at the outbound-proxy of
@@ -131,7 +131,7 @@
<title><varname>default_expires</varname> (integer)</title>
<para>
If the processed message contains neither Expires
- <acronym>HFs</acronym> nor expires contact parameters, this value
+ header fields nor expires contact parameters, this value
will be used for newly created usrloc 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 <quote>min_expires</quote> parameter
@@ -1151,7 +1151,7 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0
</title>
<para>
The function processes a <emphasis>REGISTER</emphasis> message. It can add, remove or
- modify location records (in usrloc) depending on Contact and Expires HFs in the
+ modify location records (in usrloc) depending on Contact and Expires header fields in the
REGISTER message. On success and when called from the REQUEST_ROUTE,
<quote>200 OK</quote> will be returned listing all contacts that are currently in
the location database. On an error, an error message will be sent with a short
<!--
Kamailio Project uses GitHub Issues only for bugs in the code or feature requests. Please use this template only for feature requests.
If you have questions about using Kamailio or related to its configuration file, ask on sr-users mailing list:
* http://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users
If you have questions about developing extensions to Kamailio or its existing C code, ask on sr-dev mailing list:
* http://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev
Please try to fill this template as much as possible for any issue. It helps the developers to troubleshoot the issue.
If you submit a feature request (or enhancement) add the description of what you would like to be added.
If there is no content to be filled in a section, the entire section can be removed.
You can delete the comments from the template sections when filling.
You can delete next line and everything above before submitting (it is a comment).
-->
### Description
<!--
Explain what you did, what you expected to happen, and what actually happened.
-->
I'd like to reduce the number of contacts per AOR for certain UAs, while maintaining a default higher limit.
```
modparam("registrar", "max_contacts", 10)
modparam("registrar", "xavp_cfg", "reg")
route[REGISTRAR] {
if($ua=~"^Yealink") {
$xavp(reg=>max_contacts)=1;
}
if(!save("location")) {
sl_reply_error();
}
exit;
}
```
### Expected behavior
https://www.kamailio.org/docs/modules/stable/modules/registrar#registrar.p.… states:
* max_contacts - the number of maximum contacts to be stored for the current registration AoR. It **overwrites** the 'max_contacts' module parameter value.
I expect that the UA will register with the new contact and have all others removed.
#### Actual observed behavior
`$xavp(reg=>max_contacts)` set to a value lower than the `max_contacts` modparam does not achieve the **overwrites** expectation from the documentation.
#### Log Messages
<!--
Check the syslog file and if there are relevant log messages printed by Kamailio, add them next, or attach to issue, or provide a link to download them (e.g., to a pastebin site).
-->
```
INFO: registrar [save.c:619]: test_max_contacts(): too many contacts for AOR <user(a)example.com>
```
### Additional Information
* **Kamailio Version** - output of `kamailio -v`
```
version: kamailio 5.4.1-1.gite1d4ddcb6c.fc32 (x86_64/linux) 09fd6a
flags: USE_TCP, USE_TLS, USE_SCTP, TLS_HOOKS, USE_RAW_SOCKS, DISABLE_NAGLE, USE_MCAST, DNS_IP_HACK, SHM_MMAP, PKG_MALLOC, Q_MALLOC, F_MALLOC, TLSF_MALLOC, DBG_SR_MEMORY, USE_FUTEX, FAST_LOCK-ADAPTIVE_WAIT, USE_DNS_CACHE, USE_DNS_FAILOVER, USE_NAPTR, USE_DST_BLACKLIST, HAVE_RESOLV_RES, TLS_PTHREAD_MUTEX_SHARED
ADAPTIVE_WAIT_LOOPS 1024, MAX_RECV_BUFFER_SIZE 262144, MAX_URI_SIZE 1024, BUF_SIZE 65535, DEFAULT PKG_SIZE 8MB
poll method support: poll, epoll_lt, epoll_et, sigio_rt, select.
id: 09fd6a
compiled on 00:00:00 Sep 5 2020 with gcc 10.2.1
```
* **Operating System**:
<!--
Details about the operating system, the type: Linux (e.g.,: Debian 8.4, Ubuntu 16.04, CentOS 7.1, ...), MacOS, xBSD, Solaris, ...;
Kernel details (output of `uname -a`)
-->
```
Fedora 32, kernel-5.8.4-200.fc32.x86_64
```
--
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/issues/2471
Module: kamailio
Branch: master
Commit: 628d2d3fa7a6b61c85f0211838640bc5713ba3e7
URL: https://github.com/kamailio/kamailio/commit/628d2d3fa7a6b61c85f0211838640bc…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2020-09-15T07:46:18+02:00
modules: readme files regenerated - topos ... [skip ci]
---
Modified: src/modules/topos/README
---
Diff: https://github.com/kamailio/kamailio/commit/628d2d3fa7a6b61c85f0211838640bc…
Patch: https://github.com/kamailio/kamailio/commit/628d2d3fa7a6b61c85f0211838640bc…
---
diff --git a/src/modules/topos/README b/src/modules/topos/README
index b70fdd3737..72b1ae8b3f 100644
--- a/src/modules/topos/README
+++ b/src/modules/topos/README
@@ -98,17 +98,21 @@ Chapter 1. Admin Guide
1. Overview
- This module offers topology hiding by stripping the SIP routing headers
- that show topology details. The script interpreter gets the SIP
- messages with full content, so all existing functionality is preserved.
+ This module offers topology hiding for INVITE-based dialogs, by
+ stripping the SIP routing headers that show topology details . The
+ script interpreter gets the SIP messages with full content, so all
+ existing functionality is preserved.
The module is transparent for the configuration writer. It only needs
- to be loaded (tune the parameters if needed).
+ to be loaded (tune the module parameters if needed).
It also works for SIP MESSAGE or other requests that do not create a
- call dialog -- record_route() must be used for them as well, the
- headers are not going to be in the messages sent to the network, they
- are needed to know local addresses used to communicate with each side.
+ dialog -- record_route() must be used for them as well, the headers are
+ not going to be in the messages sent to the network, they are needed to
+ know local addresses used to communicate with each side. At this moment
+ it is not designed to work for presence (SUBSCRIBE-based) dialogs. The
+ REGISTER and PUBLISH requests are skipped from processing by this
+ module, expected to be terminated on a local SIP server.
2. Dependencies
Module: kamailio
Branch: master
Commit: 878971f2c0bc32233b6f18728f9b88537b3d19e8
URL: https://github.com/kamailio/kamailio/commit/878971f2c0bc32233b6f18728f9b885…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2020-09-15T07:33:00+02:00
topos: docs - more details about what SIP traffic is handled
---
Modified: src/modules/topos/doc/topos_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/878971f2c0bc32233b6f18728f9b885…
Patch: https://github.com/kamailio/kamailio/commit/878971f2c0bc32233b6f18728f9b885…
---
diff --git a/src/modules/topos/doc/topos_admin.xml b/src/modules/topos/doc/topos_admin.xml
index 46edd04a6c..973391430b 100644
--- a/src/modules/topos/doc/topos_admin.xml
+++ b/src/modules/topos/doc/topos_admin.xml
@@ -16,20 +16,23 @@
<section>
<title>Overview</title>
<para>
- This module offers topology hiding by stripping the SIP routing
- headers that show topology details.
+ This module offers topology hiding for INVITE-based dialogs, by stripping
+ the SIP routing headers that show topology details .
The script interpreter gets the SIP messages with full content,
so all existing functionality is preserved.
</para>
<para>
The module is transparent for the configuration writer. It only needs to be
- loaded (tune the parameters if needed).
+ loaded (tune the module parameters if needed).
</para>
<para>
It also works for SIP MESSAGE or other requests that do not create
- a call dialog -- record_route() must be used for them as well, the
+ a dialog -- record_route() must be used for them as well, the
headers are not going to be in the messages sent to the network, they
are needed to know local addresses used to communicate with each side.
+ At this moment it is not designed to work for presence (SUBSCRIBE-based)
+ dialogs. The REGISTER and PUBLISH requests are skipped from processing
+ by this module, expected to be terminated on a local SIP server.
</para>
</section>
<section>