Browse code

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

Kamailio Dev authored on 12/05/2020 08:31:19
Showing 1 changed files
... ...
@@ -426,14 +426,13 @@ Chapter 1. Admin Guide
426 426
    of nodes. There is no locking when setting the nodes enabled/disabled
427 427
    (to keep the memory access as fast as possible). Thus, problems related
428 428
    to node state might appear for concurrent processes that might set the
429
-   nodes enabled/disabled(e.g. by fifo command). This robustness problems
429
+   nodes enabled/disabled(e.g. by fifo command). These robustness problems
430 430
    are overcome as follows.
431 431
 
432 432
    If the current process sees the selected node as disabled, the node is
433
-   force tested before the current process actually takes the disabled
434
-   decision. If the test succeeds, the process will set the node as
435
-   enabled (but other concurrent process might still see it as disabled).
436
-   .
433
+   force tested before the current process actually accepts the disabled
434
+   state. If the test succeeds, the process will set the node as enabled
435
+   (but other concurrent process might still see it as disabled).
437 436
 
438 437
    If the current process sees the selected node as enabled, it does no
439 438
    additional checks and sends the command which will fail in case the
... ...
@@ -583,7 +582,7 @@ modparam("rtpengine", "rtpengine_disable_tout", 20)
583 582
    to all rtpengines, else no rtpengine will be queried until its
584 583
    rtpengine_disable_tout timeout passes.
585 584
 
586
-   Default value is “1”.
585
+   Default value is “1” (enabled).
587 586
 
588 587
    Can be set at runtime, e.g.:
589 588
                         $ kamcmd cfg.set_now_int rtpengine aggressive_redetectio
... ...
@@ -612,10 +611,10 @@ modparam("rtpengine", "rtpengine_tout_ms", 2000)
612 611
 
613 612
 4.5. rtpengine_allow_op (integer)
614 613
 
615
-   Enable this to allow finishing the current sessions while denying new
616
-   sessions for the manually deactivated nodes via kamctl command i.e.
617
-   "disabled(permanent)" nodes. Probably the manually deactivated machine
618
-   is still running(did not crash).
614
+   Enable this setting to allow finishing the current sessions while
615
+   denying new sessions for the manually deactivated nodes via kamctl
616
+   command i.e. "disabled(permanent)" nodes. Probably the manually
617
+   deactivated machine is still running(did not crash).
619 618
 
620 619
    This is useful when deactivating a node for maintenance and reject new
621 620
    sessions but allow current ones to finish.
... ...
@@ -624,7 +623,8 @@ modparam("rtpengine", "rtpengine_tout_ms", 2000)
624 623
    node is deleted from the table and the table reloaded (see
625 624
    nh_reload_rtpp) the node actually is disabled(permanent) and hidden for
626 625
    display. Next time the same node will be added in the table, and the
627
-   content reloaded, it will be updated and re-displayed.
626
+   database content reloaded, the re-activated node will be updated and
627
+   re-displayed.
628 628
 
629 629
    Default value is “0” to keep the current behaviour.
630 630
 
... ...
@@ -764,7 +764,9 @@ modparam("rtpengine", "rtp_inst_pvar", "$avp(RTP_INSTANCE)")
764 764
 
765 765
 4.14. hash_table_size (integer)
766 766
 
767
-   Size of the hash table. Default value is 256.
767
+   To maintain information about a selected rtp machine node for a given
768
+   call, entries are added in a hashtable of (callid, node) pairs. This
769
+   parameter sets the size of the hash table. Default value is 256.
768 770
 
769 771
    NOTE: If configured size is less than 1, the size will be defaulted to
770 772
    1.
... ...
@@ -779,11 +781,11 @@ modparam("rtpengine", "hash_table_size", 123)
779 781
    Number of seconds after an rtpengine hash table entry is marked for
780 782
    deletion. By default, this parameter is set to 3600 (seconds).
781 783
 
782
-   To maintain information about a selected rtp machine node, for a given
784
+   To maintain information about a selected rtp machine node for a given
783 785
    call, entries are added in a hashtable of (callid, node) pairs. When
784
-   command comes, lookup callid. If found, return chosen node. If not
785
-   found, choose a new node, insert it in the hastable and return the
786
-   chosen node.
786
+   command comes the callid is looked up in this table. If found, the
787
+   chosen node is used. If not found, choose a new node, insert the callid
788
+   in the hashtable and return the chosen node.
787 789
 
788 790
    NOTE: In the current implementation, the actual deletion happens on the
789 791
    fly, while insert/remove/lookup the hastable, only for the entries in
... ...
@@ -799,10 +801,11 @@ modparam("rtpengine", "hash_table_tout", 300)
799 801
 
800 802
 4.16. db_url (string)
801 803
 
802
-   The rtpengine datablase url. If present and valid, it activates
803
-   database mode. Node information is read from database, not from config.
804
+   The rtpengine database url. If present and valid, it activates database
805
+   mode. In this mode the node information is read from database, not from
806
+   configuration modparam parameters.
804 807
 
805
-   By default, the datablase url is NULL (not set).
808
+   By default, the database url is NULL (not set).
806 809
 
807 810
    Example 1.16. Set db_url parameter
808 811
 ...
... ...
@@ -812,7 +815,7 @@ modparam("rtpengine", "db_url", "mysql://pass@localhost/db")
812 815
 4.17. table_name (string)
813 816
 
814 817
    The rtpengine table name. If database mode is activated (i.e. valid
815
-   db_url), set the name of rtpengine table, on startup.
818
+   db_url), sets the name of the rtpengine table, on startup.
816 819
 
817 820
    By default, the rtpengine table name is "rtpengine".
818 821
 
... ...
@@ -853,9 +856,10 @@ mysql> select * from version;
853 856
 
854 857
 4.18. setid_col (string)
855 858
 
856
-   Column name in the rtpengine table. If database mode is activated (i.e.
857
-   valid db_url), set the setid of rtp nodes according to this column, on
858
-   startup. The MySQL value for this column should be INT UNSIGNED.
859
+   Column name for the "setid" in the rtpengine table. If database mode is
860
+   activated (i.e. valid db_url), set the setid of rtp nodes according to
861
+   this column, on startup. The MySQL value for this column should be INT
862
+   UNSIGNED.
859 863
 
860 864
    By default, the column name is "setid".
861 865
 
... ...
@@ -866,9 +870,10 @@ modparam("rtpengine", "setid_col", "setid_column_name")
866 870
 
867 871
 4.19. url_col (string)
868 872
 
869
-   Column name in the rtpengine table. If database mode is activated (i.e.
870
-   valid db_url), set the url of rtp nodes according to this column, on
871
-   startup. The MySQL value for this column should be VARCHAR.
873
+   Column name for the url in the rtpengine table. If database mode is
874
+   activated (i.e. valid db_url), set the url of rtp nodes according to
875
+   this column, on startup. The MySQL value for this column should be
876
+   VARCHAR.
872 877
 
873 878
    By default, the column name is "url".
874 879
 
... ...
@@ -879,10 +884,10 @@ modparam("rtpengine", "url_col", "url_column_name")
879 884
 
880 885
 4.20. weight_col (string)
881 886
 
882
-   Column name in the rtpengine table. If database mode is activated (i.e.
883
-   valid db_url), set the weight of rtp nodes according to this column, on
884
-   startup. The column value has priority over the URL weight. The MySQL
885
-   value for this column should be INT UNSIGNED.
887
+   Column name for weight in the rtpengine table. If database mode is
888
+   activated (i.e. valid db_url), set the weight of rtp nodes according to
889
+   this column, on startup. The column value has priority over the URL
890
+   weight. The MySQL value for this column should be INT UNSIGNED.
886 891
 
887 892
    By default, the column name is "weight".
888 893
 
... ...
@@ -1799,12 +1804,12 @@ modparam("rtpengine", "control_cmd_tos", 144)
1799 1804
 4.72. hash_algo (integer)
1800 1805
 
1801 1806
    Hashing algorithm to be used in node selection algorithm. Now there are
1802
-   2 possibilities: legacy alogrithm - 0(very basic hash over callid) or
1807
+   2 possibilities: legacy algorithm - 0(very basic hash over callid) or
1803 1808
    SHA1 - 1(apply sha1 over the callid and calculate hash).
1804 1809
 
1805 1810
    Default value is 0, legacy algorithm.
1806 1811
 
1807
-   The values not falling into the range “0-1” .
1812
+   The values not falling into the range “0-1” are ignored.
1808 1813
 
1809 1814
    Example 1.73. Set control_cmd_tos parameter
1810 1815
 ...
... ...
@@ -2084,7 +2089,7 @@ rtpengine_offer();
2084 2089
             encoding can be added in this manner. More details about this
2085 2090
             are found in the rtpengine README.
2086 2091
           + codec-strip=... - strips given codec from sdp
2087
-          + codec-offer=... - offer given codec from sdp.More details
2092
+          + codec-offer=... - offer given codec from sdp. More details
2088 2093
             about this are found in the rtpengine README.
2089 2094
           + codec-mask=... - Similar to strip except that codecs listed
2090 2095
             here will still be accepted and used for transcoding on the
... ...
@@ -2166,7 +2171,7 @@ ranscode=PCMA"))
2166 2171
 5.4.  rtpengine_info([flags])
2167 2172
 
2168 2173
    Send an updated offer to rtpengine. This is meant to be used when
2169
-   processing Tricke ICE SDP Fragments that are carried in SIP INFO
2174
+   processing Trickle ICE SDP Fragments that are carried in SIP INFO
2170 2175
    messages and are proxied to endpoints that do not support ICE. With a
2171 2176
    matching content type, the SDP fragment is used to update rtpengine's
2172 2177
    list of ICE candidates. No new SDP is returned and so the SIP INFO
... ...
@@ -2184,7 +2189,7 @@ rtpengine_info();
2184 2189
 
2185 2190
 5.5.  rtpengine_delete([flags])
2186 2191
 
2187
-   Tears down the RTPProxy session for the current call. This populates
2192
+   Tears down the RTP proxy session for the current call. This populates
2188 2193
    the statistics pseudovariables (such “mos_min_pv” etc).
2189 2194
 
2190 2195
    See rtpengine_offer() function description above for the meaning of the
... ...
@@ -2436,7 +2441,7 @@ stop_media("from-tag=5yqaeriguhxcikxj");
2436 2441
    “volume” is specified in absolute decibels, with a default of -8 db.
2437 2442
 
2438 2443
    Multiple consecutive DTMF events can be queued up by calling this
2439
-   function multiple times consecutively. Rtpengine will play out the DTMF
2444
+   function multiple times consecutively. RTPengine will play out the DTMF
2440 2445
    events in sequence, separated by a default pause of 100 ms. An
2441 2446
    alternative pause length can be given through the “pause” option,
2442 2447
    between 100 and 5000 ms.
... ...
@@ -2506,11 +2511,11 @@ $ kamcmd rtpengine.reload
2506 2511
    recheck_ticks are grater than 0, the proxy is considered disabled
2507 2512
    temporary, and it is not taken into consideration for sending data.
2508 2513
    When the recheck_ticks are 0, the proxy is retested when trying to send
2509
-   data(not automatically retested), and data can be send to it on
2514
+   data (not automatically retested), and data can be send to it on
2510 2515
    success.
2511 2516
 
2512
-   NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
2513
-   escape the :: from the IPv6 address. See the example below.
2517
+   NOTE: If you specify an IPv6 RTP, the proxy url must be prefixed with
2518
+   :: to escape the :: from the IPv6 address. See the example below.
2514 2519
 
2515 2520
    Example 1.94.  rtpengine.enable usage
2516 2521
 ...
Browse code

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

Kamailio Dev authored on 27/04/2020 12:31:15
Showing 1 changed files
... ...
@@ -1926,13 +1926,6 @@ rtpengine_offer();
1926 1926
             “direction=external” respectively. Useful for brevity or as
1927 1927
             legacy option if the RTP proxy only supports two network
1928 1928
             interfaces instead of multiple, arbitrarily named ones.
1929
-          + auto-bridge - this flag an alternative to the “internal” and
1930
-            “external” flags in order to do automatic bridging between
1931
-            IPv4 on the "internal network" and IPv6 on the "external
1932
-            network". Instead of explicitly instructing the RTP proxy to
1933
-            select a particular address family, the distinction is done by
1934
-            the given IP in the SDP body by the RTP proxy itself. Not
1935
-            supported by Sipwise rtpengine.
1936 1929
           + address-family=... - instructs the RTP proxy that the
1937 1930
             recipient of this SDP body expects to see addresses of a
1938 1931
             particular family. Possible values are “IP4” and “IP6”. For
Browse code

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

Kamailio Dev authored on 25/03/2020 14:01:15
Showing 1 changed files
... ...
@@ -2097,6 +2097,18 @@ rtpengine_offer();
2097 2097
             here will still be accepted and used for transcoding on the
2098 2098
             offering side.Useful only in combination with codec-transcode.
2099 2099
             all keyword can be used to mask all offered codecs
2100
+          + T.38=decode - If the offered SDP contains a media section
2101
+            advertising T.38 over UDPTL, translate it to a regular audio
2102
+            media section over RTP. By default, PCMU and PCMA will be used
2103
+            as audio codecs, but that can be overriden using the codec
2104
+            options described above. Other transport protocols (e.g. SRTP)
2105
+            can also be selected in the same way. If the offered SDP does
2106
+            not contain a T.38 section, then this flag has no effect.
2107
+          + T.38=force - Any audio media section (over RTP) in the offered
2108
+            SDP will be translated into a T.38 section over UDPTL.
2109
+          + T.38=stop - Stops a previously established T.38 to audio
2110
+            gateway and reverts the session back to media passthrough.
2111
+            This is useful when handling a rejected T.38 offer.
2100 2112
        Check also the documentation of RTPEngine, these flags are
2101 2113
        documented there as well: https://github.com/sipwise/rtpengine.
2102 2114
 
Browse code

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

Kamailio Dev authored on 23/02/2020 11:31:14
Showing 1 changed files
... ...
@@ -2210,7 +2210,7 @@ rtpengine_query();
2210 2210
 
2211 2211
 5.7.  rtpengine_manage([flags])
2212 2212
 
2213
-   Manage the RTPProxy session - it combines the functionality of
2213
+   Manage the RTPEngine session - it combines the functionality of
2214 2214
    rtpengine_offer(), rtpengine_answer() and rtpengine_delete(), detecting
2215 2215
    internally based on message type and method which one to execute.
2216 2216
 
... ...
@@ -2229,7 +2229,9 @@ rtpengine_query();
2229 2229
        resuming a suspended transaction (e.g., after t_continue()),
2230 2230
        because the context of executed route is FAILURE ROUTE (in other
2231 2231
        words, rtpengine_manage() in the route block of t_continue() does
2232
-       the same as in failure_route).
2232
+       the same as in failure_route; use a branch route to engage
2233
+       rtpengine for a forwarded branch after resuming the transaction).
2234
+     * It does nothing if used inside event_route[tm:branch-failure:...]
2233 2235
      * If reply to INVITE with code >= 300 do rtpengine_delete()
2234 2236
      * If reply with SDP to INVITE having code 1xx and 2xx, then do
2235 2237
        rtpengine_answer() if the request had SDP or tm is not loaded,
Browse code

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

Kamailio Dev authored on 28/01/2020 19:01:10
Showing 1 changed files
... ...
@@ -1882,20 +1882,22 @@ rtpengine_offer();
1882 1882
             “Via” header; “auto” - use the first “Via” header if this is a
1883 1883
             request, or the second one if this is a reply; “extra” - don't
1884 1884
             take the value from a header, but instead use the value of the
1885
-            “extra_id_pv” variable; “next” - use the value of the
1886
-            “Via/branch” tag that Kamailio will generate for the next
1887
-            branch. This can be used to create one media session per
1888
-            branch on the RTP proxy. When sending a subsequent “delete”
1889
-            command to the RTP proxy, you can then stop just the session
1890
-            for a specific branch when passing the flag '1' or '2' in the
1891
-            “rtpengine_delete”, or stop all sessions for a call when not
1892
-            passing one of those two flags there. This is especially
1893
-            useful if you have serially forked call scenarios where the
1894
-            RTP proxy gets an “offer” command for a new branch, and then a
1895
-            “delete” command for the previous branch, which would
1896
-            otherwise delete the full call, breaking the subsequent
1897
-            “answer” for the new branch. This flag is only supported by
1898
-            the Sipwise rtpengine RTP proxy at the moment!
1885
+            “extra_id_pv” variable; “next” - use the branch ID generated
1886
+            by Kamailio for the next outgoing branch; “auto-next” - use
1887
+            “next” in requests and “1” in replies; “auto-extra” - use
1888
+            “extra” in requests and “1” in replies. This can be used to
1889
+            create one media session per branch on the RTP proxy. When
1890
+            sending a subsequent “delete” command to the RTP proxy, you
1891
+            can then stop just the session for a specific branch when
1892
+            passing the flag '1' or '2' in the “rtpengine_delete”, or stop
1893
+            all sessions for a call when not passing one of those two
1894
+            flags there. This is especially useful if you have serially
1895
+            forked call scenarios where the RTP proxy gets an “offer”
1896
+            command for a new branch, and then a “delete” command for the
1897
+            previous branch, which would otherwise delete the full call,
1898
+            breaking the subsequent “answer” for the new branch. This flag
1899
+            is only supported by the Sipwise rtpengine RTP proxy at the
1900
+            moment!
1899 1901
           + asymmetric - flags that UA from which message is received
1900 1902
             doesn't support symmetric RTP. Disables learning of endpoint
1901 1903
             addresses in the Sipwise rtpengine proxy.
Browse code

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

Kamailio Dev authored on 09/12/2019 18:31:12
Showing 1 changed files
... ...
@@ -771,7 +771,7 @@ modparam("rtpengine", "rtp_inst_pvar", "$avp(RTP_INSTANCE)")
771 771
 
772 772
    Example 1.14. Set hash_table_size parameter
773 773
 ...
774
-modparam("rtpengine", "hash_table_size", "123")
774
+modparam("rtpengine", "hash_table_size", 123)
775 775
 ...
776 776
 
777 777
 4.15. hash_table_tout (integer)
... ...
@@ -794,7 +794,7 @@ modparam("rtpengine", "hash_table_size", "123")
794 794
 
795 795
    Example 1.15. Set hash_table_tout parameter
796 796
 ...
797
-modparam("rtpengine", "hash_table_tout", "300")
797
+modparam("rtpengine", "hash_table_tout", 300)
798 798
 ...
799 799
 
800 800
 4.16. db_url (string)
... ...
@@ -1793,7 +1793,7 @@ modparam("rtpengine", "mos_average_samples_B_pv", "$avp(mos_average_samples_B)")
1793 1793
 
1794 1794
    Example 1.72. Set control_cmd_tos parameter
1795 1795
 ...
1796
-modparam("rtpengine", "control_cmd_tos", "144")
1796
+modparam("rtpengine", "control_cmd_tos", 144)
1797 1797
 ...
1798 1798
 
1799 1799
 4.72. hash_algo (integer)
... ...
@@ -1809,7 +1809,7 @@ modparam("rtpengine", "control_cmd_tos", "144")
1809 1809
    Example 1.73. Set control_cmd_tos parameter
1810 1810
 ...
1811 1811
 ### use SHA1 instead of legacy algorithm
1812
-modparam("rtpengine", "hash_algo", "1")
1812
+modparam("rtpengine", "hash_algo", 1)
1813 1813
 ...
1814 1814
 
1815 1815
 5. Functions
Browse code

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

Kamailio Dev authored on 04/12/2019 11:11:33
Showing 1 changed files
... ...
@@ -142,6 +142,7 @@ Richard Fuchs
142 142
               5.15. stop_forwarding([flags])
143 143
               5.16. play_media([flags])
144 144
               5.17. stop_media([flags])
145
+              5.18. play_dtmf([flags])
145 146
 
146 147
         6. Exported Pseudo Variables
147 148
 
... ...
@@ -249,12 +250,13 @@ Richard Fuchs
249 250
    1.88. stop_forwarding usage
250 251
    1.89. play_media usage
251 252
    1.90. stop_media usage
252
-   1.91. $rtpstat Usage
253
-   1.92. rtpengine.reload usage
254
-   1.93. rtpengine.enable usage
255
-   1.94. rtpengine.show usage
256
-   1.95. rtpengine.ping usage
257
-   1.96. rtpengine.get_hash_total usage
253
+   1.91. play_dtmf usage
254
+   1.92. $rtpstat Usage
255
+   1.93. rtpengine.reload usage
256
+   1.94. rtpengine.enable usage
257
+   1.95. rtpengine.show usage
258
+   1.96. rtpengine.ping usage
259
+   1.97. rtpengine.get_hash_total usage
258 260
 
259 261
 Chapter 1. Admin Guide
260 262
 
... ...
@@ -361,6 +363,7 @@ Chapter 1. Admin Guide
361 363
         5.15. stop_forwarding([flags])
362 364
         5.16. play_media([flags])
363 365
         5.17. stop_media([flags])
366
+        5.18. play_dtmf([flags])
364 367
 
365 368
    6. Exported Pseudo Variables
366 369
 
... ...
@@ -1828,6 +1831,7 @@ modparam("rtpengine", "hash_algo", "1")
1828 1831
    5.15. stop_forwarding([flags])
1829 1832
    5.16. play_media([flags])
1830 1833
    5.17. stop_media([flags])
1834
+   5.18. play_dtmf([flags])
1831 1835
 
1832 1836
 5.1.  set_rtpengine_set(setid[, setid])
1833 1837
 
... ...
@@ -2403,6 +2407,37 @@ stop_media();
2403 2407
 stop_media("from-tag=5yqaeriguhxcikxj");
2404 2408
 ...
2405 2409
 
2410
+5.18.  play_dtmf([flags])
2411
+
2412
+   Injects a DTMF event into the media stream. Depending on which codecs
2413
+   were negotiated, this either injects an RFC 2833/4733 DTMF event, or an
2414
+   in-band PCM DTMF tone into the audio stream. The flag “inject DTMF”
2415
+   must have been present in both offer and answer messages when the call
2416
+   was established, which forces all audio to go through rtpengine's
2417
+   transcoding engine.
2418
+
2419
+   Usage is similar to “play_media” with the following exceptions. The
2420
+   selected party is not the party that will receive the DTMF event, but
2421
+   rather the party which is generating the event. This is to support DTMF
2422
+   events that are carried in SIP INFO messages. Instead of specifying a
2423
+   media file, a DTMF event code must be specified, as well as optionally
2424
+   a duration and the volume. The “code” can be a number 0 through 15, or
2425
+   a DTMF digit (0-9, A-D, *, #). The “duration” is specified in
2426
+   milliseconds and defaults to 250, within a range of 100-5000. The
2427
+   “volume” is specified in absolute decibels, with a default of -8 db.
2428
+
2429
+   Multiple consecutive DTMF events can be queued up by calling this
2430
+   function multiple times consecutively. Rtpengine will play out the DTMF
2431
+   events in sequence, separated by a default pause of 100 ms. An
2432
+   alternative pause length can be given through the “pause” option,
2433
+   between 100 and 5000 ms.
2434
+
2435
+   Example 1.91. play_dtmf usage
2436
+...
2437
+play_dtmf("from-tag=5yqaeriguhxcikxj code=#");
2438
+play_dtmf("code=1 volume=5 duration=300 pause=150");
2439
+...
2440
+
2406 2441
 6. Exported Pseudo Variables
2407 2442
 
2408 2443
    6.1. $rtpstat
... ...
@@ -2414,7 +2449,7 @@ stop_media("from-tag=5yqaeriguhxcikxj");
2414 2449
    packet counters. The statistics must be retrieved before the session is
2415 2450
    deleted (before rtpengine_delete()).
2416 2451
 
2417
-   Example 1.91. $rtpstat Usage
2452
+   Example 1.92. $rtpstat Usage
2418 2453
 ...
2419 2454
     append_hf("X-RTP-Statistics: $rtpstat\r\n");
2420 2455
 ...
... ...
@@ -2437,7 +2472,7 @@ stop_media("from-tag=5yqaeriguhxcikxj");
2437 2472
    is enabled, the sessions are still allowed to finish for the hidden old
2438 2473
    nodes.
2439 2474
 
2440
-   Example 1.92.  rtpengine.reload usage
2475
+   Example 1.93.  rtpengine.reload usage
2441 2476
 ...
2442 2477
 $ kamcmd rtpengine.reload
2443 2478
 ...
... ...
@@ -2468,7 +2503,7 @@ $ kamcmd rtpengine.reload
2468 2503
    NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
2469 2504
    escape the :: from the IPv6 address. See the example below.
2470 2505
 
2471
-   Example 1.93.  rtpengine.enable usage
2506
+   Example 1.94.  rtpengine.enable usage
2472 2507
 ...
2473 2508
 $ kamcmd rtpengine.enable udp:192.168.2.133:8081 0
2474 2509
 $ kamcmd rtpengine.enable ::udp6:fe80::9a90:96ff:fea8:fd99:9999 1
... ...
@@ -2491,7 +2526,7 @@ $ kamcmd rtpengine.enable all 1
2491 2526
    NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
2492 2527
    escape the :: from the IPv6 address. See the example below.
2493 2528
 
2494
-   Example 1.94.  rtpengine.show usage
2529
+   Example 1.95.  rtpengine.show usage
2495 2530
 ...
2496 2531
 $ kamcmd rtpengine.show udp:192.168.2.133:8081
2497 2532
 $ kamcmd rtpengine.show ::udp6:fe80::9a90:96ff:fea8:fd99:9999
... ...
@@ -2511,7 +2546,7 @@ $ kamcmd rtpengine.show all
2511 2546
    NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
2512 2547
    escape the :: from the IPv6 address. See the example below.
2513 2548
 
2514
-   Example 1.95.  rtpengine.ping usage
2549
+   Example 1.96.  rtpengine.ping usage
2515 2550
 ...
2516 2551
 $ kamcmd rtpengine.ping udp:192.168.2.133:8081
2517 2552
 $ kamcmd rtpengine.ping ::udp6:fe80::9a90:96ff:fea8:fd99:9999
... ...
@@ -2523,7 +2558,7 @@ $ kamcmd rtpengine.ping all
2523 2558
    Print the total number of hash entries in the hash table at a given
2524 2559
    moment.
2525 2560
 
2526
-   Example 1.96.  rtpengine.get_hash_total usage
2561
+   Example 1.97.  rtpengine.get_hash_total usage
2527 2562
 ...
2528 2563
 $ kamcmd rtpengine.get_hash_total
2529 2564
 ...
Browse code

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

Kamailio Dev authored on 28/06/2019 14:10:09
Showing 1 changed files
... ...
@@ -12,26 +12,16 @@ Edited by
12 12
 
13 13
 Maxim Sobolev
14 14
 
15
-Edited by
16
-
17 15
 Bogdan-Andrei Iancu
18 16
 
19
-Edited by
20
-
21 17
 Juha Heinanen
22 18
 
23
-Edited by
24
-
25 19
 Sas Ovidiu
26 20
 
27
-Edited by
28
-
29 21
 Carsten Bock
30 22
 
31 23
    ng-voice GmbH
32 24
 
33
-Edited by
34
-
35 25
 Richard Fuchs
36 26
 
37 27
    Sipwise GmbH
... ...
@@ -131,6 +121,7 @@ Richard Fuchs
131 121
               4.69. mos_average_roundtrip_B_pv (string)
132 122
               4.70. mos_average_samples_B_pv (string)
133 123
               4.71. control_cmd_tos (integer)
124
+              4.72. hash_algo (integer)
134 125
 
135 126
         5. Functions
136 127
 
... ...
@@ -240,29 +231,30 @@ Richard Fuchs
240 231
    1.70. Set mos_average_roundtrip_B_pv parameter
241 232
    1.71. Set mos_average_samples_B_pv parameter
242 233
    1.72. Set control_cmd_tos parameter
243
-   1.73. set_rtpengine_set usage
244
-   1.74. rtpengine_offer usage
245
-   1.75. rtpengine_answer usage
246
-   1.76. rtpengine_info usage
247
-   1.77. rtpengine_delete usage
248
-   1.78. rtpengine_query usage
249
-   1.79. rtpengine_manage usage
250
-   1.80. start_recording usage
251
-   1.81. stop_recording usage
252
-   1.82. block_dtmf usage
253
-   1.83. unblock_dtmf usage
254
-   1.84. block_media usage
255
-   1.85. unblock_media usage
256
-   1.86. start_forwarding usage
257
-   1.87. stop_forwarding usage
258
-   1.88. play_media usage
259
-   1.89. stop_media usage
260
-   1.90. $rtpstat Usage
261
-   1.91. rtpengine.reload usage
262
-   1.92. rtpengine.enable usage
263
-   1.93. rtpengine.show usage
264
-   1.94. rtpengine.ping usage
265
-   1.95. rtpengine.get_hash_total usage
234
+   1.73. Set control_cmd_tos parameter
235
+   1.74. set_rtpengine_set usage
236
+   1.75. rtpengine_offer usage
237
+   1.76. rtpengine_answer usage
238
+   1.77. rtpengine_info usage
239
+   1.78. rtpengine_delete usage
240
+   1.79. rtpengine_query usage
241
+   1.80. rtpengine_manage usage
242
+   1.81. start_recording usage
243
+   1.82. stop_recording usage
244
+   1.83. block_dtmf usage
245
+   1.84. unblock_dtmf usage
246
+   1.85. block_media usage
247
+   1.86. unblock_media usage
248
+   1.87. start_forwarding usage
249
+   1.88. stop_forwarding usage
250
+   1.89. play_media usage
251
+   1.90. stop_media usage
252
+   1.91. $rtpstat Usage
253
+   1.92. rtpengine.reload usage
254
+   1.93. rtpengine.enable usage
255
+   1.94. rtpengine.show usage
256
+   1.95. rtpengine.ping usage
257
+   1.96. rtpengine.get_hash_total usage
266 258
 
267 259
 Chapter 1. Admin Guide
268 260
 
... ...
@@ -348,6 +340,7 @@ Chapter 1. Admin Guide
348 340
         4.69. mos_average_roundtrip_B_pv (string)
349 341
         4.70. mos_average_samples_B_pv (string)
350 342
         4.71. control_cmd_tos (integer)
343
+        4.72. hash_algo (integer)
351 344
 
352 345
    5. Functions
353 346
 
... ...
@@ -540,6 +533,7 @@ Chapter 1. Admin Guide
540 533
    4.69. mos_average_roundtrip_B_pv (string)
541 534
    4.70. mos_average_samples_B_pv (string)
542 535
    4.71. control_cmd_tos (integer)
536
+   4.72. hash_algo (integer)
543 537
 
544 538
 4.1. rtpengine_sock (string)
545 539
 
... ...
@@ -1799,6 +1793,22 @@ modparam("rtpengine", "mos_average_samples_B_pv", "$avp(mos_average_samples_B)")
1799 1793
 modparam("rtpengine", "control_cmd_tos", "144")
1800 1794
 ...
1801 1795
 
1796
+4.72. hash_algo (integer)
1797
+
1798
+   Hashing algorithm to be used in node selection algorithm. Now there are
1799
+   2 possibilities: legacy alogrithm - 0(very basic hash over callid) or
1800
+   SHA1 - 1(apply sha1 over the callid and calculate hash).
1801
+
1802
+   Default value is 0, legacy algorithm.
1803
+
1804
+   The values not falling into the range “0-1” .
1805
+
1806
+   Example 1.73. Set control_cmd_tos parameter
1807
+...
1808
+### use SHA1 instead of legacy algorithm
1809
+modparam("rtpengine", "hash_algo", "1")
1810
+...
1811
+
1802 1812
 5. Functions
1803 1813
 
1804 1814
    5.1. set_rtpengine_set(setid[, setid])
... ...
@@ -1841,7 +1851,7 @@ modparam("rtpengine", "control_cmd_tos", "144")
1841 1851
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
1842 1852
    BRANCH_ROUTE.
1843 1853
 
1844
-   Example 1.73. set_rtpengine_set usage
1854
+   Example 1.74. set_rtpengine_set usage
1845 1855
 ...
1846 1856
 set_rtpengine_set("2");
1847 1857
 rtpengine_offer();
... ...
@@ -2086,7 +2096,7 @@ rtpengine_offer();
2086 2096
 
2087 2097
    This function can be used from ANY_ROUTE.
2088 2098
 
2089
-   Example 1.74. rtpengine_offer usage
2099
+   Example 1.75. rtpengine_offer usage
2090 2100
 route {
2091 2101
 ...
2092 2102
     if (is_method("INVITE")) {
... ...
@@ -2138,7 +2148,7 @@ ranscode=PCMA"))
2138 2148
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
2139 2149
    FAILURE_ROUTE, BRANCH_ROUTE.
2140 2150
 
2141
-   Example 1.75. rtpengine_answer usage
2151
+   Example 1.76. rtpengine_answer usage
2142 2152
 
2143 2153
    See rtpengine_offer() function example above for example.
2144 2154
 
... ...
@@ -2156,7 +2166,7 @@ ranscode=PCMA"))
2156 2166
 
2157 2167
    This function can be used from ANY_ROUTE.
2158 2168
 
2159
-   Example 1.76. rtpengine_info usage
2169
+   Example 1.77. rtpengine_info usage
2160 2170
 ...
2161 2171
 rtpengine_info();
2162 2172
 ...
... ...
@@ -2171,7 +2181,7 @@ rtpengine_info();
2171 2181
 
2172 2182
    This function can be used from ANY_ROUTE.
2173 2183
 
2174
-   Example 1.77. rtpengine_delete usage
2184
+   Example 1.78. rtpengine_delete usage
2175 2185
 ...
2176 2186
 rtpengine_delete();
2177 2187
 ...
... ...
@@ -2187,7 +2197,7 @@ rtpengine_delete();
2187 2197
 
2188 2198
    This function can be used from ANY_ROUTE.
2189 2199
 
2190
-   Example 1.78. rtpengine_query usage
2200
+   Example 1.79. rtpengine_query usage
2191 2201
 ...
2192 2202
 rtpengine_query();
2193 2203
 ...
... ...
@@ -2221,7 +2231,7 @@ rtpengine_query();
2221 2231
 
2222 2232
    This function can be used from ANY_ROUTE.
2223 2233
 
2224
-   Example 1.79. rtpengine_manage usage
2234
+   Example 1.80. rtpengine_manage usage
2225 2235
 ...
2226 2236
 rtpengine_manage();
2227 2237
 ...
... ...
@@ -2240,7 +2250,7 @@ rtpengine_manage();
2240 2250
 
2241 2251
    This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.
2242 2252
 
2243
-   Example 1.80. start_recording usage
2253
+   Example 1.81. start_recording usage
2244 2254
 ...
2245 2255
 start_recording();
2246 2256
 ...
... ...
@@ -2259,7 +2269,7 @@ start_recording();
2259 2269
 
2260 2270
    This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.
2261 2271
 
2262
-   Example 1.81. stop_recording usage
2272
+   Example 1.82. stop_recording usage
2263 2273
 ...
2264 2274
 stop_recording();
2265 2275
 ...
... ...
@@ -2283,7 +2293,7 @@ stop_recording();
2283 2293
 
2284 2294
    This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.
2285 2295
 
2286
-   Example 1.82. block_dtmf usage
2296
+   Example 1.83. block_dtmf usage
2287 2297
 ...
2288 2298
 block_dtmf();
2289 2299
 block_dtmf("directional");
... ...
@@ -2299,7 +2309,7 @@ block_dtmf("address=192.168.42.42");
2299 2309
    unblocking DTMF events for the entire call (i.e. no flags given) will
2300 2310
    not remove these blocks. The flag “all” can be used to achieve this.
2301 2311
 
2302
-   Example 1.83. unblock_dtmf usage
2312
+   Example 1.84. unblock_dtmf usage
2303 2313
 ...
2304 2314
 unblock_dtmf();
2305 2315
 unblock_dtmf("all");
... ...
@@ -2313,7 +2323,7 @@ unblock_dtmf("all");
2313 2323
 
2314 2324
    See “block_dtmf” for a description of the flags that can be used.
2315 2325
 
2316
-   Example 1.84. block_media usage
2326
+   Example 1.85. block_media usage
2317 2327
 ...
2318 2328
 block_media();
2319 2329
 block_media("directional");
... ...
@@ -2327,7 +2337,7 @@ block_media("address=192.168.42.42");
2327 2337
 
2328 2338
    See “unblock_dtmf” for a description of the flags that can be used.
2329 2339
 
2330
-   Example 1.85. unblock_media usage
2340
+   Example 1.86. unblock_media usage
2331 2341
 ...
2332 2342
 unblock_media();
2333 2343
 unblock_media("all");
... ...
@@ -2342,7 +2352,7 @@ unblock_media("all");
2342 2352
 
2343 2353
    See “block_dtmf” for a description of the flags that can be used.
2344 2354
 
2345
-   Example 1.86. start_forwarding usage
2355
+   Example 1.87. start_forwarding usage
2346 2356
 ...
2347 2357
 start_forwarding();
2348 2358
 start_forwarding("directional");
... ...
@@ -2356,7 +2366,7 @@ start_forwarding("address=192.168.42.42");
2356 2366
 
2357 2367
    See “unblock_dtmf” for a description of the flags that can be used.
2358 2368
 
2359
-   Example 1.87. stop_forwarding usage
2369
+   Example 1.88. stop_forwarding usage
2360 2370
 ...
2361 2371
 stop_forwarding();
2362 2372
 stop_forwarding("all");
... ...
@@ -2375,7 +2385,7 @@ stop_forwarding("all");
2375 2385
    the duration of the media being played, expressed in milliseconds. If
2376 2386
    the length of the media could not be determined, it's set to -1.
2377 2387
 
2378
-   Example 1.88. play_media usage
2388
+   Example 1.89. play_media usage
2379 2389
 ...
2380 2390
 play_media("file=/use/share/media/hello.wav");
2381 2391
 play_media("from-tag=tfugklbildfydrtuykgfv db-id=12345");
... ...
@@ -2387,7 +2397,7 @@ play_media("from-tag=tfugklbildfydrtuykgfv db-id=12345");
2387 2397
    playback is automatically stopped when the end of the media file is
2388 2398
    reached, so this function is only useful to prematurely stop playback.
2389 2399
 
2390
-   Example 1.89. stop_media usage
2400
+   Example 1.90. stop_media usage
2391 2401
 ...
2392 2402
 stop_media();
2393 2403
 stop_media("from-tag=5yqaeriguhxcikxj");
... ...
@@ -2404,7 +2414,7 @@ stop_media("from-tag=5yqaeriguhxcikxj");
2404 2414
    packet counters. The statistics must be retrieved before the session is
2405 2415
    deleted (before rtpengine_delete()).
2406 2416
 
2407
-   Example 1.90. $rtpstat Usage
2417
+   Example 1.91. $rtpstat Usage
2408 2418
 ...
2409 2419
     append_hf("X-RTP-Statistics: $rtpstat\r\n");
2410 2420
 ...
... ...
@@ -2427,7 +2437,7 @@ stop_media("from-tag=5yqaeriguhxcikxj");
2427 2437
    is enabled, the sessions are still allowed to finish for the hidden old
2428 2438
    nodes.
2429 2439
 
2430
-   Example 1.91.  rtpengine.reload usage
2440
+   Example 1.92.  rtpengine.reload usage
2431 2441
 ...
2432 2442
 $ kamcmd rtpengine.reload
2433 2443
 ...
... ...
@@ -2458,7 +2468,7 @@ $ kamcmd rtpengine.reload
2458 2468
    NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
2459 2469
    escape the :: from the IPv6 address. See the example below.
2460 2470
 
2461
-   Example 1.92.  rtpengine.enable usage
2471
+   Example 1.93.  rtpengine.enable usage
2462 2472
 ...
2463 2473
 $ kamcmd rtpengine.enable udp:192.168.2.133:8081 0
2464 2474
 $ kamcmd rtpengine.enable ::udp6:fe80::9a90:96ff:fea8:fd99:9999 1
... ...
@@ -2481,7 +2491,7 @@ $ kamcmd rtpengine.enable all 1
2481 2491
    NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
2482 2492
    escape the :: from the IPv6 address. See the example below.
2483 2493
 
2484
-   Example 1.93.  rtpengine.show usage
2494
+   Example 1.94.  rtpengine.show usage
2485 2495
 ...
2486 2496
 $ kamcmd rtpengine.show udp:192.168.2.133:8081
2487 2497
 $ kamcmd rtpengine.show ::udp6:fe80::9a90:96ff:fea8:fd99:9999
... ...
@@ -2501,7 +2511,7 @@ $ kamcmd rtpengine.show all
2501 2511
    NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to
2502 2512
    escape the :: from the IPv6 address. See the example below.
2503 2513
 
2504
-   Example 1.94.  rtpengine.ping usage
2514
+   Example 1.95.  rtpengine.ping usage
2505 2515
 ...
2506 2516
 $ kamcmd rtpengine.ping udp:192.168.2.133:8081
2507 2517
 $ kamcmd rtpengine.ping ::udp6:fe80::9a90:96ff:fea8:fd99:9999
... ...
@@ -2513,7 +2523,7 @@ $ kamcmd rtpengine.ping all
2513 2523
    Print the total number of hash entries in the hash table at a given
2514 2524
    moment.
2515 2525
 
2516
-   Example 1.95.  rtpengine.get_hash_total usage
2526
+   Example 1.96.  rtpengine.get_hash_total usage
2517 2527
 ...
2518 2528
 $ kamcmd rtpengine.get_hash_total
2519 2529
 ...
Browse code

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

Kamailio Dev authored on 08/03/2019 21:16:42
Showing 1 changed files
... ...
@@ -82,54 +82,55 @@ Richard Fuchs
82 82
               4.20. weight_col (string)
83 83
               4.21. disabled_col (string)
84 84
               4.22. setid_default (integer)
85
-              4.23. mos_min_pv (string)
86
-              4.24. mos_min_at_pv (string)
87
-              4.25. mos_min_packetloss_pv (string)
88
-              4.26. mos_min_jitter_pv (string)
89
-              4.27. mos_min_roundtrip_pv (string)
90
-              4.28. mos_max_pv (string)
91
-              4.29. mos_max_at_pv (string)
92
-              4.30. mos_max_packetloss_pv (string)
93
-              4.31. mos_max_jitter_pv (string)
94
-              4.32. mos_max_roundtrip_pv (string)
95
-              4.33. mos_average_pv (string)
96
-              4.34. mos_average_packetloss_pv (string)
97
-              4.35. mos_average_jitter_pv (string)
98
-              4.36. mos_average_roundtrip_pv (string)
99
-              4.37. mos_average_samples_pv (string)
100
-              4.38. mos_A_label_pv (string)
101
-              4.39. mos_min_A_pv (string)
102
-              4.40. mos_min_at_A_pv (string)
103
-              4.41. mos_min_packetloss_A_pv (string)
104
-              4.42. mos_min_jitter_A_pv (string)
105
-              4.43. mos_min_roundtrip_A_pv (string)
106
-              4.44. mos_max_A_pv (string)
107
-              4.45. mos_max_at_A_pv (string)
108
-              4.46. mos_max_packetloss_A_pv (string)
109
-              4.47. mos_max_jitter_A_pv (string)
110
-              4.48. mos_max_roundtrip_A_pv (string)
111
-              4.49. mos_average_A_pv (string)
112
-              4.50. mos_average_packetloss_A_pv (string)
113
-              4.51. mos_average_jitter_A_pv (string)
114
-              4.52. mos_average_roundtrip_A_pv (string)
115
-              4.53. mos_average_samples_A_pv (string)
116
-              4.54. mos_B_label_pv (string)
117
-              4.55. mos_min_B_pv (string)
118
-              4.56. mos_min_at_B_pv (string)
119
-              4.57. mos_min_packetloss_B_pv (string)
120
-              4.58. mos_min_jitter_B_pv (string)
121
-              4.59. mos_min_roundtrip_B_pv (string)
122
-              4.60. mos_max_B_pv (string)
123
-              4.61. mos_max_at_B_pv (string)
124
-              4.62. mos_max_packetloss_B_pv (string)
125
-              4.63. mos_max_jitter_B_pv (string)
126
-              4.64. mos_max_roundtrip_B_pv (string)
127
-              4.65. mos_average_B_pv (string)
128
-              4.66. mos_average_packetloss_B_pv (string)
129
-              4.67. mos_average_jitter_B_pv (string)
130
-              4.68. mos_average_roundtrip_B_pv (string)
131
-              4.69. mos_average_samples_B_pv (string)
132
-              4.70. control_cmd_tos (integer)
85
+              4.23. media_duration (string)
86
+              4.24. mos_min_pv (string)
87
+              4.25. mos_min_at_pv (string)
88
+              4.26. mos_min_packetloss_pv (string)
89
+              4.27. mos_min_jitter_pv (string)
90
+              4.28. mos_min_roundtrip_pv (string)
91
+              4.29. mos_max_pv (string)
92
+              4.30. mos_max_at_pv (string)
93
+              4.31. mos_max_packetloss_pv (string)
94
+              4.32. mos_max_jitter_pv (string)
95
+              4.33. mos_max_roundtrip_pv (string)
96
+              4.34. mos_average_pv (string)
97
+              4.35. mos_average_packetloss_pv (string)
98
+              4.36. mos_average_jitter_pv (string)
99
+              4.37. mos_average_roundtrip_pv (string)
100
+              4.38. mos_average_samples_pv (string)
101
+              4.39. mos_A_label_pv (string)
102
+              4.40. mos_min_A_pv (string)
103
+              4.41. mos_min_at_A_pv (string)
104
+              4.42. mos_min_packetloss_A_pv (string)
105
+              4.43. mos_min_jitter_A_pv (string)
106
+              4.44. mos_min_roundtrip_A_pv (string)
107
+              4.45. mos_max_A_pv (string)
108
+              4.46. mos_max_at_A_pv (string)
109
+              4.47. mos_max_packetloss_A_pv (string)
110
+              4.48. mos_max_jitter_A_pv (string)
111
+              4.49. mos_max_roundtrip_A_pv (string)
112
+              4.50. mos_average_A_pv (string)
113
+              4.51. mos_average_packetloss_A_pv (string)
114
+              4.52. mos_average_jitter_A_pv (string)
115
+              4.53. mos_average_roundtrip_A_pv (string)
116
+              4.54. mos_average_samples_A_pv (string)
117
+              4.55. mos_B_label_pv (string)
118
+              4.56. mos_min_B_pv (string)
119
+              4.57. mos_min_at_B_pv (string)
120
+              4.58. mos_min_packetloss_B_pv (string)
121
+              4.59. mos_min_jitter_B_pv (string)
122
+              4.60. mos_min_roundtrip_B_pv (string)
123
+              4.61. mos_max_B_pv (string)
124
+              4.62. mos_max_at_B_pv (string)
125
+              4.63. mos_max_packetloss_B_pv (string)
126
+              4.64. mos_max_jitter_B_pv (string)
127
+              4.65. mos_max_roundtrip_B_pv (string)
128
+              4.66. mos_average_B_pv (string)
129
+              4.67. mos_average_packetloss_B_pv (string)
130
+              4.68. mos_average_jitter_B_pv (string)
131
+              4.69. mos_average_roundtrip_B_pv (string)
132
+              4.70. mos_average_samples_B_pv (string)