Browse code

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

Kamailio Dev authored on 30/10/2020 14:01:35
Showing 2 changed files
... ...
@@ -896,8 +896,9 @@ request_route {
896 896
    location records (in usrloc) depending on Contact and Expires header
897 897
    fields in the REGISTER message. On success and when called from the
898 898
    REQUEST_ROUTE, “200 OK” will be returned listing all contacts that are
899
-   currently in the location database. On an error, an error message will
900
-   be sent with a short description in reason phrase.
899
+   currently in the location database. As a side effect, also branch flags
900
+   are stored in usrloc. On an error, an error message will be sent with a
901
+   short description in reason phrase.
901 902
 
902 903
    Meaning of the parameters is as follows:
903 904
      * domain - Logical domain within the registrar. If a database is used
... ...
@@ -945,7 +946,8 @@ save("location", "0x00", "sip:test@kamailio.org");
945 946
    no such contacts, -1 will be returned. If there are such contacts,
946 947
    Request-URI will be overwritten with the contact that has the highest q
947 948
    value and optionally the rest will be appended to the message
948
-   (depending on append_branches parameter value).
949
+   (depending on append_branches parameter value). As a side effect, also
950
+   branch flags are restored from usrloc.
949 951
 
950 952
    If the method_filtering option is enabled and request is initial
951 953
    request without to-tag, the lookup function will return only the
... ...
@@ -721,10 +721,13 @@ if (has_body("multipart/mixed")) {
721 721
 
722 722
 4.23.  append_to_reply(txt)
723 723
 
724
-   Append txt as header to the reply.
724
+   Append txt as header to the reply that is going to be generated by
725
+   Kamailio (e.g., via sl_send_reply(...)).
725 726
 
726 727
    Meaning of the parameters is as follows:
727
-     * txt - String which may contains pseudo-variables.
728
+     * txt - String which may contains pseudo-variables. Note that the
729
+       value has to be ended with "\r\n" (end of header characters
730
+       sequence).
728 731
 
729 732
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE,
730 733
    FAILURE_ROUTE, ERROR_ROUTE.
... ...
@@ -737,12 +740,14 @@ append_to_reply("Foo: $rm at $Ts\r\n");
737 740
 
738 741
 4.24.  append_hf(txt[, hdr])
739 742
 
740
-   Appends 'txt' as header after first header field or after last 'hdr'
741
-   header field.
743
+   Appends 'txt' as header at the end of the all headers, or after last
744
+   header named 'hdr' if the second parameter is provided.
742 745
 
743 746
    Meaning of the parameters is as follows:
744 747
      * txt - Header field to be appended. The value can contain
745
-       pseudo-variables which will be replaced at run time.
748
+       pseudo-variables which will be replaced at run time. Note that the
749
+       value has to be ended with "\r\n" (end of header characters
750
+       sequence).
746 751
      * hdr - Header name after which the 'txt' is appended.
747 752
 
748 753
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
... ...
@@ -756,12 +761,14 @@ append_hf("From-username: $fU\r\n", "Call-ID");
756 761
 
757 762
 4.25.  insert_hf(txt[, hdr])
758 763
 
759
-   Inserts 'txt' as header before the first header field or before first
760
-   'hdr' header field if 'hdr' is given.
764
+   Inserts 'txt' as header before the first header field, or before first
765
+   header named 'hdr'if the second parameter is provided.
761 766
 
762 767
    Meaning of the parameters is as follows:
763 768
      * txt - Header field to be inserted. The value can contain
764
-       pseudo-variables which will be replaced at run time.
769
+       pseudo-variables which will be replaced at run time. Note that the
770
+       value has to be ended with "\r\n" (end of header characters
771
+       sequence).
765 772
      * hdr - Header name before which the 'txt' is inserted.
766 773
 
767 774
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,