From dd6bae27eac161832f9315560b45ebe20188f373 Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Wed, 4 Dec 2019 12:11:33 +0100 Subject: [PATCH] modules: readme files regenerated - acc_json ... [skip ci] --- src/modules/acc_json/README | 167 ++++++++++++++++++++++++++++++---- src/modules/cfgt/README | 38 ++++++-- src/modules/dispatcher/README | 12 ++- src/modules/kex/README | 10 +- src/modules/nathelper/README | 33 +++++-- src/modules/presence/README | 51 +++++++---- src/modules/rtpengine/README | 59 +++++++++--- src/modules/rtpproxy/README | 44 ++++----- src/modules/tm/README | 5 + 9 files changed, 324 insertions(+), 95 deletions(-) diff --git a/src/modules/acc_json/README b/src/modules/acc_json/README index c43928583be..22605f285de 100644 --- a/src/modules/acc_json/README +++ b/src/modules/acc_json/README @@ -38,8 +38,14 @@ Julien Chavanton 3.5. acc_time_format (str) 3.6. output_mqueue (integer) 3.7. output_syslog (integer) - 3.8. log_facility (integer) - 3.9. log_level (integer) + 3.8. acc_log_facility (integer) + 3.9. acc_log_level (integer) + 3.10. cdr_enable (str) + 3.11. cdr_extra (str) + 3.12. cdr_expired_dlg_enable (str) + 3.13. cdr_output_mqueue (integer) + 3.14. cdr_log_facility (integer) + 3.15. cdr_log_level (integer) List of Examples @@ -50,8 +56,14 @@ Julien Chavanton 1.5. acc_time_format example 1.6. output_mqueue usage example 1.7. output_syslog example - 1.8. log_facility example - 1.9. log_level example + 1.8. acc_log_facility example + 1.9. acc_log_level example + 1.10. cdr_enable example + 1.11. cdr_extra example + 1.12. cdr_expired_dlg_enable example + 1.13. cdr_output_mqueue usage example + 1.14. cdr_log_facility example + 1.15. cdr_log_level example Chapter 1. Admin Guide @@ -72,8 +84,14 @@ Chapter 1. Admin Guide 3.5. acc_time_format (str) 3.6. output_mqueue (integer) 3.7. output_syslog (integer) - 3.8. log_facility (integer) - 3.9. log_level (integer) + 3.8. acc_log_facility (integer) + 3.9. acc_log_level (integer) + 3.10. cdr_enable (str) + 3.11. cdr_extra (str) + 3.12. cdr_expired_dlg_enable (str) + 3.13. cdr_output_mqueue (integer) + 3.14. cdr_log_facility (integer) + 3.15. cdr_log_level (integer) 1. Overview @@ -113,8 +131,14 @@ Chapter 1. Admin Guide 3.5. acc_time_format (str) 3.6. output_mqueue (integer) 3.7. output_syslog (integer) - 3.8. log_facility (integer) - 3.9. log_level (integer) + 3.8. acc_log_facility (integer) + 3.9. acc_log_level (integer) + 3.10. cdr_enable (str) + 3.11. cdr_extra (str) + 3.12. cdr_expired_dlg_enable (str) + 3.13. cdr_output_mqueue (integer) + 3.14. cdr_log_facility (integer) + 3.15. cdr_log_level (integer) 3.1. acc_flag (integer) @@ -240,11 +264,11 @@ ts), "$var(nsq_res)"); Example 1.7. output_syslog example ... modparam("acc_json", "output_syslog", 1) -modparam("acc_json", "log_level", 2) -modparam("acc_json", "log_facility", "LOG_DAEMON") +modparam("acc_json", "acc_log_level", 2) +modparam("acc_json", "acc_log_facility", "LOG_DAEMON") ... -3.8. log_facility (integer) +3.8. acc_log_facility (integer) Log facility to which accounting messages are issued to syslog. This allows to easily separate the accounting specific logging from the @@ -252,9 +276,9 @@ modparam("acc_json", "log_facility", "LOG_DAEMON") Default value is LOG_DAEMON. - Example 1.8. log_facility example + Example 1.8. acc_log_facility example ... -modparam("acc_json", "log_facility", "LOG_LOCAL0") +modparam("acc_json", "acc_log_facility", "LOG_LOCAL0") # modify you syslog/rsyslog config # /etc/rsyslog.d/default.conf @@ -264,13 +288,124 @@ modparam("acc_json", "log_facility", "LOG_LOCAL0") # local0.* /var/log/json_acc.log ... -3.9. log_level (integer) +3.9. acc_log_level (integer) Log level at which accounting messages are issued to syslog. Default value is 1 (L_NOTICE). - Example 1.9. log_level example + Example 1.9. acc_log_level example ... -modparam("acc_json", "log_level", 2) # Set log_level to 2 (L_INFO) +modparam("acc_json", "acc_log_level", 2) # Set acc_log_level to 2 (L_INFO) +... + +3.10. cdr_enable (str) + + Enable Call Data Record generation. + + Default value is 0 (disabled). + + Example 1.10. cdr_enable example +... +modparam("acc_json", "cdr_enable", 1) +... + +3.11. cdr_extra (str) + + Set of pseudo-variables defining custom CDR fields. + + Default value is NULL. + + Example 1.11. cdr_extra example +... +modparam("acc_json", "cdr_extra", "ci=$dlg_var(call_id);ft=$dlg_var(from_tag)") +... + +3.12. cdr_expired_dlg_enable (str) + + Should CDR-based logging be enabled in case of expired dialogs? + + 0 - off (default). 1 - on. + + Example 1.12. cdr_expired_dlg_enable example +... +modparam("acc_json", "cdr_expired_dlg_enable", 1) +... + +3.13. cdr_output_mqueue (integer) + + Requires the mqueue module. The acc module will queue json cdr events + in the specified mqueue. Using a rtimer module exec you can access the + queue and process them. + + You can also fetch the cdr events using mqueue.fetch over JSON-RPC. + + Default value is not-set mqueue will not be required. + + Example 1.13. cdr_output_mqueue usage example +... +# example using json_mqueue/http_client to publish to NSQD +modparam("mqueue", "mqueue", "name=cdr_events;size=100000") +modparam("acc_json", "cdr_enable", 1) +modparam("acc_json", "cdr_output_mqueue", "cdr_events") +modparam("acc_json", "cdr_extra", "ci=$dlg_var(call_id)") +modparam("rtimer", "timer", "name=nsqt;interval=1;mode=1;") +modparam("rtimer", "exec", "timer=nsqt;route=RUN_CDR_PUBLISH") +modparam("http_client", "keep_connections", 1) +modparam("http_client", "httpcon", "nsqd=>http://localhost:4151/pub?topic=acc") + +route[RUN_CDR_PUBLISH] { + $var(count) = 0; + while (mq_fetch("cdr_events")) { + $var(q_size) = mq_size("cdr_events"); + $var(count) = $var(count) + 1; + xinfo("[RUN_CDR_PUBLISH][$var(q_size)][$var(count)][$mqk(cdr_events)][$mqv +(cdr_events)]\n"); + $var(res) = http_connect_raw("nsqd", "", "application/json", $mqv(cdr_even +ts), "$var(nsq_res)"); + if ($var(res) < 0) { + xerr("[RUN_CDR_PUBLISH][$var(res)] http_connect_raw: timeout or error ! +\n"); + mq_add("cdr_events", "cdr_key", "$mqv(cdr_events)"); + } else if ($var(res) < 200 || $var(res) > 299) { + xerr("[RUN_CDR_PUBLISH][$var(res)] http unexpected response code !\n"); + mq_add("cdr_dead_letter_queue", "cdr_key", "$mqv(cdr_events)"); + return; + } + } + if ($var(count) > 0 ) { + xinfo("[RUN_CDR_PUBLISH]done count[$var(count)]\n"); + } +} +... + +3.14. cdr_log_facility (integer) + + Log facility to which accounting messages are issued to syslog. This + allows to easily separate the accounting specific logging from the + other log messages. + + Default value is LOG_DAEMON. + + Example 1.14. cdr_log_facility example +... +modparam("acc_json", "cdr_log_facility", "LOG_LOCAL0") + +# modify you syslog/rsyslog config +# /etc/rsyslog.d/default.conf +# remove local0 from default log file +# *.*;local0,auth,authpriv.none /var/log/syslog +# add local0 to another log file +# local0.* /var/log/json_cdr.log +... + +3.15. cdr_log_level (integer) + + Log level at which accounting messages are issued to syslog. + + Default value is 1 (L_NOTICE). + + Example 1.15. cdr_log_level example +... +modparam("acc_json", "cdr_log_level", 2) # Set cdr_log_level to 2 (L_INFO) ... diff --git a/src/modules/cfgt/README b/src/modules/cfgt/README index 0003aa59694..0db7b5ed265 100644 --- a/src/modules/cfgt/README +++ b/src/modules/cfgt/README @@ -29,8 +29,12 @@ Victor Seva 3.2. mask (int) 3.3. callid_prefix (string) - 4. Usage - 5. Report format + 4. RPC Commands + + 4.1. cfgt.mask + + 5. Usage + 6. Report format List of Examples @@ -54,8 +58,12 @@ Chapter 1. Admin Guide 3.2. mask (int) 3.3. callid_prefix (string) - 4. Usage - 5. Report format + 4. RPC Commands + + 4.1. cfgt.mask + + 5. Usage + 6. Report format 1. Overview @@ -133,7 +141,25 @@ modparam("cfgt", "mask", 12) modparam("cfgt", "callid_prefix", "TEST-ID%") ... -4. Usage +4. RPC Commands + + 4.1. cfgt.mask + +4.1. cfgt.mask + + Sets mask module parameter. + + Name: cfgt.mask + + Parameters: + * mask : int value + + Example: +... +kamcmd cfgt.mask 32 +... + +5. Usage This module is used by the debugger module, so it must be loaded first. To enable the generation of the reports, the debugger module must be @@ -160,7 +186,7 @@ modparam("debugger", "cfgtest", 1) #!endif ... -5. Report format +6. Report format cfgt generates a json file per request processed. The files are created at //.json. The “message_id” is a sequence diff --git a/src/modules/dispatcher/README b/src/modules/dispatcher/README index a460ffff60f..6929bfaf846 100644 --- a/src/modules/dispatcher/README +++ b/src/modules/dispatcher/README @@ -517,17 +517,21 @@ Note * grp - the set id (group id). * uri - the URI address. * sock - the socket pointer. + * socket - the socket string - it is added only if xavp_dst_mode has + bit 2 set (value 2). * dstid - the destination unique id (in case of call load distribution algorithm). * attrs - the attributes - they are added if xavp_dst_mode does not - have the bit 1 set. + have the bit 1 set (value 1). Default value is “0” (add all fields). Example 1.12. Set the “xavp_dst_mode” parameter - ... - modparam("dispatcher", "xavp_dst_mode", 1) - ... +... + modparam("dispatcher", "xavp_dst_mode", 1) +... + modparam("dispatcher", "xavp_dst_mode", 2) +... 3.13. xavp_ctx (str) diff --git a/src/modules/kex/README b/src/modules/kex/README index 318f48e3fb2..1f4681a44fa 100644 --- a/src/modules/kex/README +++ b/src/modules/kex/README @@ -15,8 +15,6 @@ Daniel-Constantin Mierla -Edited by - Ovidiu Sas @@ -66,7 +64,7 @@ Ovidiu Sas 4.9. core.ps 4.10. core.psx 4.11. core.pwd - 4.12. core.shmem + 4.12. core.shmmem 4.13. core.sockets_list 4.14. core.tcp_info 4.15. core.tcp_list @@ -144,7 +142,7 @@ Chapter 1. Admin Guide 4.9. core.ps 4.10. core.psx 4.11. core.pwd - 4.12. core.shmem + 4.12. core.shmmem 4.13. core.sockets_list 4.14. core.tcp_info 4.15. core.tcp_list @@ -446,7 +444,7 @@ resetdebug(); 4.9. core.ps 4.10. core.psx 4.11. core.pwd - 4.12. core.shmem + 4.12. core.shmmem 4.13. core.sockets_list 4.14. core.tcp_info 4.15. core.tcp_list @@ -540,7 +538,7 @@ kamcmd core.kill kamcmd core.pwd ... -4.12. core.shmem +4.12. core.shmmem Returns shared memory info. It has an optional parameter that specifies the measuring unit: b - bytes (default), k or kb, m or mb, g or gb. diff --git a/src/modules/nathelper/README b/src/modules/nathelper/README index 048372ae96f..9be10359d15 100644 --- a/src/modules/nathelper/README +++ b/src/modules/nathelper/README @@ -67,6 +67,7 @@ Ovidiu Sas 5.7. add_contact_alias([ip_addr, port, proto]) 5.8. handle_ruri_alias() 5.9. set_contact_alias() + 5.10. set_alias_to_pv(target_avp) 6. Exported Pseudo Variables @@ -109,10 +110,11 @@ Ovidiu Sas 1.22. add_contact_alias usage 1.23. handle_ruri_alias usage 1.24. set_contact_alias usage - 1.25. $rr_count usage - 1.26. $rr_top_count usage - 1.27. nathelper.enable_ping usage - 1.28. @nathelper.rewrite_contact usage + 1.25. set_alias_to_pv usage + 1.26. $rr_count usage + 1.27. $rr_top_count usage + 1.28. nathelper.enable_ping usage + 1.29. @nathelper.rewrite_contact usage Chapter 1. Admin Guide @@ -154,6 +156,7 @@ Chapter 1. Admin Guide 5.7. add_contact_alias([ip_addr, port, proto]) 5.8. handle_ruri_alias() 5.9. set_contact_alias() + 5.10. set_alias_to_pv(target_avp) 6. Exported Pseudo Variables @@ -469,6 +472,7 @@ modparam("nathelper", "filter_server_id", 1) 5.7. add_contact_alias([ip_addr, port, proto]) 5.8. handle_ruri_alias() 5.9. set_contact_alias() + 5.10. set_alias_to_pv(target_avp) 5.1. fix_nated_contact() @@ -690,6 +694,19 @@ if(is_rfc1918("$rd")) { }; ... +5.10. set_alias_to_pv(target_avp) + + Reads “;alias=ip~port~transport” from Contact header then writes to + target pseudo-variable as a sip uri. + + This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, + BRANCH_ROUTE, and FAILURE_ROUTE. + + Example 1.25. set_alias_to_pv usage +... + set_alias_to_pv("$avp(aliasuri)"); +... + 6. Exported Pseudo Variables 6.1. $rr_count @@ -699,7 +716,7 @@ if(is_rfc1918("$rd")) { Number of Record Routes in received SIP request or reply. - Example 1.25. $rr_count usage + Example 1.26. $rr_count usage ... $avp(rr_count) = $rr_count; ... @@ -711,7 +728,7 @@ if(is_rfc1918("$rd")) { value of $rr_top_count is 1. If there is no Record Route(s), value of $rr_top_count is 0. - Example 1.26. $rr_top_count usage + Example 1.27. $rr_top_count usage ... if ($rr_count == $avp(rr_count) + $rr_top_count) { route(ADD_CONTACT_ALIAS); @@ -729,7 +746,7 @@ if(is_rfc1918("$rd")) { The function takes only one parameter - a number in decimal format. - Example 1.27. nathelper.enable_ping usage + Example 1.28. nathelper.enable_ping usage ... $ kamcmd nathelper.enable_ping 1 ... @@ -744,7 +761,7 @@ $ kamcmd nathelper.enable_ping 1 counted from 1. Only IP:port is rewritten, remaining part are left unchanged. Full nameaddr is supported. - Example 1.28. @nathelper.rewrite_contact usage + Example 1.29. @nathelper.rewrite_contact usage ... $c = @nathelper.rewrite_contact[1]; ... diff --git a/src/modules/presence/README b/src/modules/presence/README index 2b8269ebf0b..a298c0b332b 100644 --- a/src/modules/presence/README +++ b/src/modules/presence/README @@ -66,6 +66,7 @@ Juha Heinanen 3.33. retrieve_order_by (str) 3.34. sip_uri_match (int) 3.35. enable_dmq (integer) + 3.36. pres_subs_mode (integer) 4. Functions @@ -152,15 +153,16 @@ Juha Heinanen 1.33. Set retrieve_order_by parameter 1.34. Set sip_uri_match parameter 1.35. Set enable_dmq parameter - 1.36. handle_publish usage - 1.37. handle_subscribe usage - 1.38. pres_auth_status usage - 1.39. pres_has_subscribers usage - 1.40. pres_refresh_watchers usage - 1.41. pres_update_watchers usage - 1.42. $subs(name) usage - 1.43. $notify_reply(name) usage + 1.36. Set pres_subs_mode parameter + 1.37. handle_publish usage + 1.38. handle_subscribe usage + 1.39. pres_auth_status usage + 1.40. pres_has_subscribers usage + 1.41. pres_refresh_watchers usage + 1.42. pres_update_watchers usage + 1.43. $subs(name) usage 1.44. $notify_reply(name) usage + 1.45. $notify_reply(name) usage 2.1. presence_api_t structure Chapter 1. Admin Guide @@ -210,6 +212,7 @@ Chapter 1. Admin Guide 3.33. retrieve_order_by (str) 3.34. sip_uri_match (int) 3.35. enable_dmq (integer) + 3.36. pres_subs_mode (integer) 4. Functions @@ -318,6 +321,7 @@ Chapter 1. Admin Guide 3.33. retrieve_order_by (str) 3.34. sip_uri_match (int) 3.35. enable_dmq (integer) + 3.36. pres_subs_mode (integer) 3.1. db_url(str) @@ -852,6 +856,19 @@ modparam("presence", "sip_uri_match", 1) modparam("presence", "enable_dmq", 1) ... +3.36. pres_subs_mode (integer) + + Allow disabling cloning subscription structure for pv $subs(...), + saving the pkg memory and copy operations for all its fields. If 1 the + cloning is done; if 0, no cloning and $subs(...) returns $null. + + Default value is 1. + + Example 1.36. Set pres_subs_mode parameter +... +modparam("presence", "pres_subs_mode", 0) +... + 4. Functions 4.1. handle_publish([sender_uri]) @@ -881,7 +898,7 @@ modparam("presence", "enable_dmq", 1) The module sends an appropriate stateless reply in all cases. - Example 1.36. handle_publish usage + Example 1.37. handle_publish usage ... if(is_method("PUBLISH")) { @@ -912,7 +929,7 @@ modparam("presence", "enable_dmq", 1) The module sends an appropriate stateless reply in all cases. - Example 1.37. handle_subscribe usage + Example 1.38. handle_subscribe usage ... if(method=="SUBSCRIBE") handle_subscribe(); @@ -931,7 +948,7 @@ if(method=="SUBSCRIBE") This function can be used from REQUEST_ROUTE. - Example 1.38. pres_auth_status usage + Example 1.39. pres_auth_status usage ... if (method=="MESSAGE") { pres_auth_status("$fu", $ru"); @@ -949,7 +966,7 @@ if (method=="MESSAGE") { This function can be used from ANY_ROUTE. - Example 1.39. pres_has_subscribers usage + Example 1.40. pres_has_subscribers usage ... if(pres_has_subscribers($var(uri), "message-summary")) # do something...; @@ -979,7 +996,7 @@ if(pres_has_subscribers($var(uri), "message-summary")) This function can be used from ANY_ROUTE. - Example 1.40. pres_refresh_watchers usage + Example 1.41. pres_refresh_watchers usage ... pres_refresh_watchers("sip:test@kamailio.org", "presence", 1); ... @@ -997,7 +1014,7 @@ pres_refresh_watchers("sip:test@kamailio.org", "presence", 1); This function can be used from ANY_ROUTE. - Example 1.41. pres_update_watchers usage + Example 1.42. pres_update_watchers usage ... pres_update_watchers("sip:test@kamailio.org", "presence"); ... @@ -1106,7 +1123,7 @@ kamcmd presence.updateWatchers sip:alice@domain.com presence * flags * user_agent - Example 1.42. $subs(name) usage + Example 1.43. $subs(name) usage ... if(handle_subscription()) { @@ -1122,7 +1139,7 @@ if(handle_subscription()) The “attr” can be any pseudo var that accesses attributes of msg - Example 1.43. $notify_reply(name) usage + Example 1.44. $notify_reply(name) usage ... event_route[presence:notify-reply] { @@ -1138,7 +1155,7 @@ event_route[presence:notify-reply] Fired after notify reply is received or timeout. - Example 1.44. $notify_reply(name) usage + Example 1.45. $notify_reply(name) usage ... event_route[presence:notify-reply] { diff --git a/src/modules/rtpengine/README b/src/modules/rtpengine/README index 53bec114a2f..aec5603807c 100644 --- a/src/modules/rtpengine/README +++ b/src/modules/rtpengine/README @@ -142,6 +142,7 @@ Richard Fuchs 5.15. stop_forwarding([flags]) 5.16. play_media([flags]) 5.17. stop_media([flags]) + 5.18. play_dtmf([flags]) 6. Exported Pseudo Variables @@ -249,12 +250,13 @@ Richard Fuchs 1.88. stop_forwarding usage 1.89. play_media usage 1.90. stop_media usage - 1.91. $rtpstat Usage - 1.92. rtpengine.reload usage - 1.93. rtpengine.enable usage - 1.94. rtpengine.show usage - 1.95. rtpengine.ping usage - 1.96. rtpengine.get_hash_total usage + 1.91. play_dtmf usage + 1.92. $rtpstat Usage + 1.93. rtpengine.reload usage + 1.94. rtpengine.enable usage + 1.95. rtpengine.show usage + 1.96. rtpengine.ping usage + 1.97. rtpengine.get_hash_total usage Chapter 1. Admin Guide @@ -361,6 +363,7 @@ Chapter 1. Admin Guide 5.15. stop_forwarding([flags]) 5.16. play_media([flags]) 5.17. stop_media([flags]) + 5.18. play_dtmf([flags]) 6. Exported Pseudo Variables @@ -1828,6 +1831,7 @@ modparam("rtpengine", "hash_algo", "1") 5.15. stop_forwarding([flags]) 5.16. play_media([flags]) 5.17. stop_media([flags]) + 5.18. play_dtmf([flags]) 5.1. set_rtpengine_set(setid[, setid]) @@ -2403,6 +2407,37 @@ stop_media(); stop_media("from-tag=5yqaeriguhxcikxj"); ... +5.18. play_dtmf([flags]) + + Injects a DTMF event into the media stream. Depending on which codecs + were negotiated, this either injects an RFC 2833/4733 DTMF event, or an + in-band PCM DTMF tone into the audio stream. The flag “inject DTMF” + must have been present in both offer and answer messages when the call + was established, which forces all audio to go through rtpengine's + transcoding engine. + + Usage is similar to “play_media” with the following exceptions. The + selected party is not the party that will receive the DTMF event, but + rather the party which is generating the event. This is to support DTMF + events that are carried in SIP INFO messages. Instead of specifying a + media file, a DTMF event code must be specified, as well as optionally + a duration and the volume. The “code” can be a number 0 through 15, or + a DTMF digit (0-9, A-D, *, #). The “duration” is specified in + milliseconds and defaults to 250, within a range of 100-5000. The + “volume” is specified in absolute decibels, with a default of -8 db. + + Multiple consecutive DTMF events can be queued up by calling this + function multiple times consecutively. Rtpengine will play out the DTMF + events in sequence, separated by a default pause of 100 ms. An + alternative pause length can be given through the “pause” option, + between 100 and 5000 ms. + + Example 1.91. play_dtmf usage +... +play_dtmf("from-tag=5yqaeriguhxcikxj code=#"); +play_dtmf("code=1 volume=5 duration=300 pause=150"); +... + 6. Exported Pseudo Variables 6.1. $rtpstat @@ -2414,7 +2449,7 @@ stop_media("from-tag=5yqaeriguhxcikxj"); packet counters. The statistics must be retrieved before the session is deleted (before rtpengine_delete()). - Example 1.91. $rtpstat Usage + Example 1.92. $rtpstat Usage ... append_hf("X-RTP-Statistics: $rtpstat\r\n"); ... @@ -2437,7 +2472,7 @@ stop_media("from-tag=5yqaeriguhxcikxj"); is enabled, the sessions are still allowed to finish for the hidden old nodes. - Example 1.92. rtpengine.reload usage + Example 1.93. rtpengine.reload usage ... $ kamcmd rtpengine.reload ... @@ -2468,7 +2503,7 @@ $ kamcmd rtpengine.reload NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to escape the :: from the IPv6 address. See the example below. - Example 1.93. rtpengine.enable usage + Example 1.94. rtpengine.enable usage ... $ kamcmd rtpengine.enable udp:192.168.2.133:8081 0 $ kamcmd rtpengine.enable ::udp6:fe80::9a90:96ff:fea8:fd99:9999 1 @@ -2491,7 +2526,7 @@ $ kamcmd rtpengine.enable all 1 NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to escape the :: from the IPv6 address. See the example below. - Example 1.94. rtpengine.show usage + Example 1.95. rtpengine.show usage ... $ kamcmd rtpengine.show udp:192.168.2.133:8081 $ kamcmd rtpengine.show ::udp6:fe80::9a90:96ff:fea8:fd99:9999 @@ -2511,7 +2546,7 @@ $ kamcmd rtpengine.show all NOTE: When specify the IPv6 RTP proxy url one must prefix it with :: to escape the :: from the IPv6 address. See the example below. - Example 1.95. rtpengine.ping usage + Example 1.96. rtpengine.ping usage ... $ kamcmd rtpengine.ping udp:192.168.2.133:8081 $ kamcmd rtpengine.ping ::udp6:fe80::9a90:96ff:fea8:fd99:9999 @@ -2523,7 +2558,7 @@ $ kamcmd rtpengine.ping all Print the total number of hash entries in the hash table at a given moment. - Example 1.96. rtpengine.get_hash_total usage + Example 1.97. rtpengine.get_hash_total usage ... $ kamcmd rtpengine.get_hash_total ... diff --git a/src/modules/rtpproxy/README b/src/modules/rtpproxy/README index 9b7aa5a8188..ea6fe92e3a9 100644 --- a/src/modules/rtpproxy/README +++ b/src/modules/rtpproxy/README @@ -12,20 +12,12 @@ Edited by Maxim Sobolev -Edited by - Bogdan-Andrei Iancu -Edited by - Juha Heinanen -Edited by - Sas Ovidiu -Edited by - Carsten Bock ng-voice GmbH @@ -802,35 +794,35 @@ Chapter 2. Frequently Asked Questions 2.1. - What happened with “rtpproxy_disable” parameter? + What happened with “rtpproxy_disable” parameter? - It was removed as it became obsolete - now “rtpproxy_sock” can take - empty value to disable the rtpproxy functionality. + It was removed as it became obsolete - now “rtpproxy_sock” can take + empty value to disable the rtpproxy functionality. 2.2. - Where can I find more about Kamailio? + Where can I find more about Kamailio? - Take a look at https://www.kamailio.org/. + Take a look at https://www.kamailio.org/. 2.3. - Where can I post a question about this module? + Where can I post a question about this module? - First at all check if your question was already answered on one of our - mailing lists: - * User Mailing List - - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users - * Developer Mailing List - - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev + First at all check if your question was already answered on one of our + mailing lists: + * User Mailing List - + https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users + * Developer Mailing List - + https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev - E-mails regarding any stable Kamailio release should be sent to - and e-mails regarding development - versions should be sent to . + E-mails regarding any stable Kamailio release should be sent to + and e-mails regarding development + versions should be sent to . 2.4. - How can I report a bug? + How can I report a bug? - Please follow the guidelines provided at: - https://github.com/kamailio/kamailio/issues. + Please follow the guidelines provided at: + https://github.com/kamailio/kamailio/issues. diff --git a/src/modules/tm/README b/src/modules/tm/README index 76e48d86d93..3607b3969b5 100644 --- a/src/modules/tm/README +++ b/src/modules/tm/README @@ -1937,6 +1937,11 @@ branch_route[1] { the only way a script can add a new transaction in an atomic way. Typically, it is used to deploy a UAS. + Note that any flag operations (e.g. for accounting) after this function + has been called will be ignored. You can use the the tmx module + function t_flush_flags() to flush the altered flags to the already + created transaction. + Example 1.56. t_newtran usage ... if (t_newtran()) {