Browse code

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

Kamailio Dev authored on 21/09/2021 19:01:12
Showing 2 changed files
... ...
@@ -443,9 +443,9 @@ modparam("kazoo", "amqp_connection", "kazoo://guest:guest@otherhost:5672")
443 443
    handles control to the next sub-loop.
444 444
 ...
445 445
 while(true) // main  loop
446
- while(ACK or timeout)  // acknowledge from worker process
447
- while(SEND or timeout) // anything to send ?
448
- while(CONSUME or timeout) // any data on consumed exchanges ?
446
+while(ACK or timeout)  // acknowledge from worker process
447
+while(SEND or timeout) // anything to send ?
448
+while(CONSUME or timeout) // any data on consumed exchanges ?
449 449
 ...
450 450
 
451 451
 4.2.1. amqp_consumer_loop_count(int)
... ...
@@ -652,11 +652,11 @@ modparam("kazoo", "pua_mode", 0)
652 652
 
653 653
    Example 1.22. kazoo_publish usage
654 654
 ...
655
-$var(amqp_payload_request) = "{'Event-Category' : 'directory', 'Event-Name' : 'r
656
-eg_success', 'Contact' : '" + $var(fs_contact) + "', 'Call-ID' : '" + $ci + "',
657
-'Realm' : '" + $fd +"', 'Username' : '" + $fU + "', 'From-User' : '" + $fU + "',
658
- 'From-Host' : '" + $fd + "', 'To-User' : '" + $tU +"', 'To-Host' : '" + $td + "
659
-', 'User-Agent' : '" + $ua +"' ," + $var(register_contants)+ " }";
655
+$var(amqp_payload_request) = $_s({"Event-Category" : "directory", "Event-Name" :
656
+ "reg_success", "Contact" : "$(ct{s.escape.common}{s.replace,\','}{s.replace,$$,
657
+})", "Call-ID" : "$ci", "Realm" : "$fd", "Username" : "$fU", "From-User" : "$fU"
658
+, "From-Host" : "$fd", "To-User" : "$tU", "To-Host" : "$td", "User-Agent" : "$(u
659
+a{s.escape.common}{s.replace,\','}{s.replace,$$,})" });
660 660
 $var(amqp_routing_key) = "registration.success." + $(fd{kz.encode}) + "." + $fU;
661 661
 kazoo_publish("callmgr", $var(amqp_routing_key), $var(amqp_payload_request));
662 662
 ...
... ...
@@ -725,15 +725,20 @@ modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
725 725
    Defines the name of XAVP class to store runtime module config values.
726 726
    The values are stored as inner XAVPs, like $xavp(class=>attribute).
727 727
    Valid inner XAVP names:
728
-     * expires - the number of maximum contacts to be stored for the
729
-       current registration AoR. It overwrites the 'max_contacts' module
730
-       parameter value.
731
-     * q - the expires value, to overwrite the value from SIP headers.
728
+     * match_callid - filter contacts by callid. Used in registered().
729
+     * match_contact - filter contacts by contact. Used in registered().
730
+     * match_received - filter contacts by received. Used in registered().
731
+     * rlf_bflags - filter contacts by branch flags. Used in lookup().
732
+     * q - q value of contact (integer 0-1000). It overrides q value given
733
+       in contact header and default_q parameter. Used in save().
734
+     * expires - the expires value, to overwrite the value from SIP
735
+       headers. Used in save().
732 736
      * max_contacts - the number of maximum contacts to be stored for the
733 737
        current registration AoR. It overwrites the 'max_contacts' module
734
-       parameter value.
738
+       parameter value. Used in save().
735 739
      * socket - the string representing the socket on which the register
736
-       request was received, as alternative to using the sock_hdr.
740
+       request was received, as alternative to using the sock_hdr. Used in
741
+       save().
737 742
 
738 743
    For example. if this parameter is set to 'reg', then the number of
739 744
    maximum contacts can be set in $xavp(reg=>max_contacts).
... ...
@@ -1120,7 +1125,7 @@ lookup_branches("location");
1120 1125
      * uri (optional) - SIP URI to do be used instead of Request/To-URI.
1121 1126
        It can be a dynamic string with pseudo-variables.
1122 1127
      * match_option (optional) - flag parameter to restrict contact
1123
-       search. use reg_xavp_cfg to set the values to compare to.
1128
+       search. use xavp_cfg to set the values to compare to.
1124 1129
        flag values is as follows:
1125 1130
           + 1 - match_callid
1126 1131
           + 2 - match_received