Module: kamailio
Branch: 5.3
Commit: fec844e0f77bb96779c8380f40d8a842ec63a571
URL:
https://github.com/kamailio/kamailio/commit/fec844e0f77bb96779c8380f40d8a84…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2020-10-30T15:01:35+01:00
modules: readme files regenerated - modules ... [skip ci]
---
Modified: src/modules/registrar/README
Modified: src/modules/textops/README
---
Diff:
https://github.com/kamailio/kamailio/commit/fec844e0f77bb96779c8380f40d8a84…
Patch:
https://github.com/kamailio/kamailio/commit/fec844e0f77bb96779c8380f40d8a84…
---
diff --git a/src/modules/registrar/README b/src/modules/registrar/README
index 2a611ef564..796832b3a4 100644
--- a/src/modules/registrar/README
+++ b/src/modules/registrar/README
@@ -896,8 +896,9 @@ request_route {
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.
+ currently in the location database. As a side effect, also branch flags
+ are stored in usrloc. On an error, an error message will be sent with a
+ short description in reason phrase.
Meaning of the parameters is as follows:
* domain - Logical domain within the registrar. If a database is used
@@ -945,7 +946,8 @@ save("location", "0x00",
"sip:test@kamailio.org");
no such contacts, -1 will be returned. If there are such contacts,
Request-URI will be overwritten with the contact that has the highest q
value and optionally the rest will be appended to the message
- (depending on append_branches parameter value).
+ (depending on append_branches parameter value). As a side effect, also
+ branch flags are restored from usrloc.
If the method_filtering option is enabled and request is initial
request without to-tag, the lookup function will return only the
diff --git a/src/modules/textops/README b/src/modules/textops/README
index 32ed2c4d36..aafe390638 100644
--- a/src/modules/textops/README
+++ b/src/modules/textops/README
@@ -721,10 +721,13 @@ if (has_body("multipart/mixed")) {
4.23. append_to_reply(txt)
- Append txt as header to the reply.
+ Append txt as header to the reply that is going to be generated by
+ Kamailio (e.g., via sl_send_reply(...)).
Meaning of the parameters is as follows:
- * txt - String which may contains pseudo-variables.
+ * txt - String which may contains pseudo-variables. Note that the
+ value has to be ended with "\r\n" (end of header characters
+ sequence).
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE,
FAILURE_ROUTE, ERROR_ROUTE.
@@ -737,12 +740,14 @@ append_to_reply("Foo: $rm at $Ts\r\n");
4.24. append_hf(txt[, hdr])
- Appends 'txt' as header after first header field or after last 'hdr'
- header field.
+ Appends 'txt' as header at the end of the all headers, or after last
+ header named 'hdr' if the second parameter is provided.
Meaning of the parameters is as follows:
* txt - Header field to be appended. The value can contain
- pseudo-variables which will be replaced at run time.
+ pseudo-variables which will be replaced at run time. Note that the
+ value has to be ended with "\r\n" (end of header characters
+ sequence).
* hdr - Header name after which the 'txt' is appended.
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
@@ -756,12 +761,14 @@ append_hf("From-username: $fU\r\n", "Call-ID");
4.25. insert_hf(txt[, hdr])
- Inserts 'txt' as header before the first header field or before first
- 'hdr' header field if 'hdr' is given.
+ Inserts 'txt' as header before the first header field, or before first
+ header named 'hdr'if the second parameter is provided.
Meaning of the parameters is as follows:
* txt - Header field to be inserted. The value can contain
- pseudo-variables which will be replaced at run time.
+ pseudo-variables which will be replaced at run time. Note that the
+ value has to be ended with "\r\n" (end of header characters
+ sequence).
* hdr - Header name before which the 'txt' is inserted.
This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,