From 8316e1d38e117bbd4fdb3ae2aacedc03e02d5c20 Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Tue, 30 Jul 2019 13:16:57 +0200 Subject: [PATCH] modules: readme files regenerated - tm ... [skip ci] --- src/modules/tm/README | 735 ++++++++++++++++++++---------------------- 1 file changed, 358 insertions(+), 377 deletions(-) diff --git a/src/modules/tm/README b/src/modules/tm/README index bc6c1a7ad92..0e01e3247c3 100644 --- a/src/modules/tm/README +++ b/src/modules/tm/README @@ -32,50 +32,49 @@ Daniel-Constantin Mierla 3.3. max_inv_lifetime (integer) 3.4. max_noninv_lifetime (integer) 3.5. wt_timer (integer) - 3.6. delete_timer (integer) - 3.7. retr_timer1 (integer) - 3.8. retr_timer2 (integer) - 3.9. noisy_ctimer (integer) - 3.10. restart_fr_on_each_reply (integer) - 3.11. auto_inv_100 (integer) - 3.12. auto_inv_100_reason (string) - 3.13. unix_tx_timeout (integer) - 3.14. aggregate_challenges (integer) - 3.15. reparse_invite (integer) - 3.16. ac_extra_hdrs (string) - 3.17. blst_503 (integer) - 3.18. blst_503_def_timeout (integer) - 3.19. blst_503_min_timeout (integer) - 3.20. blst_503_max_timeout (integer) - 3.21. blst_methods_add (unsigned integer) - 3.22. blst_methods_lookup (unsigned integer) - 3.23. cancel_b_method (integer) - 3.24. reparse_on_dns_failover (integer) - 3.25. on_sl_reply (string) - 3.26. contacts_avp (string) - 3.27. contact_flows_avp (string) - 3.28. fr_timer_avp (string) - 3.29. fr_inv_timer_avp (string) - 3.30. unmatched_cancel (string) - 3.31. ruri_matching (integer) - 3.32. via1_matching (integer) - 3.33. callid_matching (integer) - 3.34. pass_provisional_replies (integer) - 3.35. default_code (integer) - 3.36. default_reason (string) - 3.37. disable_6xx_block (integer) - 3.38. local_ack_mode (integer) - 3.39. failure_reply_mode (integer) - 3.40. faked_reply_prio (integer) - 3.41. local_cancel_reason (boolean) - 3.42. e2e_cancel_reason (boolean) - 3.43. remap_503_500 (boolean) - 3.44. failure_exec_mode (boolean) - 3.45. dns_reuse_rcv_socket (boolean) - 3.46. xavp_contact (string) - 3.47. event_callback (str) - 3.48. relay_100 (str) - 3.49. rich_redirect (int) + 3.6. retr_timer1 (integer) + 3.7. retr_timer2 (integer) + 3.8. noisy_ctimer (integer) + 3.9. restart_fr_on_each_reply (integer) + 3.10. auto_inv_100 (integer) + 3.11. auto_inv_100_reason (string) + 3.12. unix_tx_timeout (integer) + 3.13. aggregate_challenges (integer) + 3.14. reparse_invite (integer) + 3.15. ac_extra_hdrs (string) + 3.16. blst_503 (integer) + 3.17. blst_503_def_timeout (integer) + 3.18. blst_503_min_timeout (integer) + 3.19. blst_503_max_timeout (integer) + 3.20. blst_methods_add (unsigned integer) + 3.21. blst_methods_lookup (unsigned integer) + 3.22. cancel_b_method (integer) + 3.23. reparse_on_dns_failover (integer) + 3.24. on_sl_reply (string) + 3.25. contacts_avp (string) + 3.26. contact_flows_avp (string) + 3.27. fr_timer_avp (string) + 3.28. fr_inv_timer_avp (string) + 3.29. unmatched_cancel (string) + 3.30. ruri_matching (integer) + 3.31. via1_matching (integer) + 3.32. callid_matching (integer) + 3.33. pass_provisional_replies (integer) + 3.34. default_code (integer) + 3.35. default_reason (string) + 3.36. disable_6xx_block (integer) + 3.37. local_ack_mode (integer) + 3.38. failure_reply_mode (integer) + 3.39. faked_reply_prio (integer) + 3.40. local_cancel_reason (boolean) + 3.41. e2e_cancel_reason (boolean) + 3.42. remap_503_500 (boolean) + 3.43. failure_exec_mode (boolean) + 3.44. dns_reuse_rcv_socket (boolean) + 3.45. xavp_contact (string) + 3.46. event_callback (str) + 3.47. relay_100 (str) + 3.48. rich_redirect (int) 4. Functions @@ -179,100 +178,99 @@ Daniel-Constantin Mierla 1.3. Set max_inv_lifetime parameter 1.4. Set max_noninv_lifetime parameter 1.5. Set wt_timer parameter - 1.6. Set delete_timer parameter - 1.7. Set retr_timer1 parameter - 1.8. Set retr_timer2 parameter - 1.9. Set noisy_ctimer parameter - 1.10. Set restart_fr_on_each_reply parameter - 1.11. Set auto_inv_100 parameter - 1.12. Set auto_inv_100_reason parameter - 1.13. Set unix_tx_timeout parameter - 1.14. Set aggregate_challenges parameter - 1.15. Set reparse_invite parameter - 1.16. Set ac_extra_hdrs parameter - 1.17. Set blst_503 parameter - 1.18. Set blst_503_def_timeout parameter - 1.19. Set blst_503_min_timeout parameter - 1.20. Set blst_503_max_timeout parameter - 1.21. Set blst_methods_add parameter - 1.22. Set blst_methods_lookup parameter - 1.23. Set cancel_b_method parameter - 1.24. Set reparse_on_dns_failover parameter - 1.25. Set on_sl_reply parameter - 1.26. Set contacts_avp parameter - 1.27. Set contact_flows_avp parameter - 1.28. Set fr_timer_avp parameter - 1.29. Set fr_inv_timer_avp parameter - 1.30. Set unmatched_cancel parameter - 1.31. Set ruri_matching parameter - 1.32. Set via1_matching parameter - 1.33. Set callid_matching parameter - 1.34. Set pass_provisional_replies parameter - 1.35. Set default_code parameter - 1.36. Set default_reason parameter - 1.37. Set disable_6xx_block parameter - 1.38. Set local_ack_mode parameter - 1.39. Set failure_reply_mode parameter - 1.40. Set faked_reply_prio parameter - 1.41. Set local_cancel_reason parameter - 1.42. Set e2e_cancel_reason parameter - 1.43. Set remap_503_500 parameter - 1.44. Set failure_exec_mode parameter - 1.45. Set dns_reuse_rcv_socket parameter - 1.46. Set xavp_contact parameter - 1.47. Set event_callback parameter - 1.48. Set relay_100 parameter - 1.49. rich_redirect example - 1.50. t_relay usage - 1.51. t_relay_to_udp usage - 1.52. t_on_failure usage - 1.53. t_on_branch_failure usage - 1.54. t_on_reply usage - 1.55. t_on_branch usage - 1.56. t_newtran usage - 1.57. t_reply usage - 1.58. t_send_reply usage - 1.59. t_lookup_request usage - 1.60. t_retransmit_reply usage - 1.61. t_release usage - 1.62. t_forward_nonack usage - 1.63. t_set_fr usage - 1.64. t_reset_fr usage - 1.65. t_set_max_lifetime usage - 1.66. t_reset_max_lifetime usage - 1.67. t_set_retr usage - 1.68. t_reset_retr usage - 1.69. t_set_auto_inv_100 usage - 1.70. t_branch_timeout usage - 1.71. t_branch_replied usage - 1.72. t_any_timeout usage - 1.73. t_any_replied usage - 1.74. t_grep_status usage - 1.75. t_is_canceled usage - 1.76. t_is_expired usage - 1.77. t_relay_cancel usage - 1.78. t_lookup_cancel usage - 1.79. t_drop_replies() usage - 1.80. t_save_lumps() usage - 1.81. t_load_contacts usage - 1.82. t_next_contacts usage - 1.83. t_next_contact_flow usage - 1.84. t_check_status usage - 1.85. t_check_trans usage - 1.86. t_set_disable_6xx usage - 1.87. t_set_disable_failover usage - 1.88. t_set_disable_internal_reply usage - 1.89. t_replicate usage - 1.90. t_relay_to usage - 1.91. t_set_no_e2e_cancel_reason usage - 1.92. t_replicate usage - 1.93. t_use_uac_headers usage - 1.94. t_is_retr_async_reply usage - 1.95. t_uac_send usage - 1.96. t_get_status_code usage - 1.97. event_route[tm:branch-failure] usage - 1.98. event_route[tm:local-request] usage - 1.99. event_route[tm:local-response] usage + 1.6. Set retr_timer1 parameter + 1.7. Set retr_timer2 parameter + 1.8. Set noisy_ctimer parameter + 1.9. Set restart_fr_on_each_reply parameter + 1.10. Set auto_inv_100 parameter + 1.11. Set auto_inv_100_reason parameter + 1.12. Set unix_tx_timeout parameter + 1.13. Set aggregate_challenges parameter + 1.14. Set reparse_invite parameter + 1.15. Set ac_extra_hdrs parameter + 1.16. Set blst_503 parameter + 1.17. Set blst_503_def_timeout parameter + 1.18. Set blst_503_min_timeout parameter + 1.19. Set blst_503_max_timeout parameter + 1.20. Set blst_methods_add parameter + 1.21. Set blst_methods_lookup parameter + 1.22. Set cancel_b_method parameter + 1.23. Set reparse_on_dns_failover parameter + 1.24. Set on_sl_reply parameter + 1.25. Set contacts_avp parameter + 1.26. Set contact_flows_avp parameter + 1.27. Set fr_timer_avp parameter + 1.28. Set fr_inv_timer_avp parameter + 1.29. Set unmatched_cancel parameter + 1.30. Set ruri_matching parameter + 1.31. Set via1_matching parameter + 1.32. Set callid_matching parameter + 1.33. Set pass_provisional_replies parameter + 1.34. Set default_code parameter + 1.35. Set default_reason parameter + 1.36. Set disable_6xx_block parameter + 1.37. Set local_ack_mode parameter + 1.38. Set failure_reply_mode parameter + 1.39. Set faked_reply_prio parameter + 1.40. Set local_cancel_reason parameter + 1.41. Set e2e_cancel_reason parameter + 1.42. Set remap_503_500 parameter + 1.43. Set failure_exec_mode parameter + 1.44. Set dns_reuse_rcv_socket parameter + 1.45. Set xavp_contact parameter + 1.46. Set event_callback parameter + 1.47. Set relay_100 parameter + 1.48. rich_redirect example + 1.49. t_relay usage + 1.50. t_relay_to_udp usage + 1.51. t_on_failure usage + 1.52. t_on_branch_failure usage + 1.53. t_on_reply usage + 1.54. t_on_branch usage + 1.55. t_newtran usage + 1.56. t_reply usage + 1.57. t_send_reply usage + 1.58. t_lookup_request usage + 1.59. t_retransmit_reply usage + 1.60. t_release usage + 1.61. t_forward_nonack usage + 1.62. t_set_fr usage + 1.63. t_reset_fr usage + 1.64. t_set_max_lifetime usage + 1.65. t_reset_max_lifetime usage + 1.66. t_set_retr usage + 1.67. t_reset_retr usage + 1.68. t_set_auto_inv_100 usage + 1.69. t_branch_timeout usage + 1.70. t_branch_replied usage + 1.71. t_any_timeout usage + 1.72. t_any_replied usage + 1.73. t_grep_status usage + 1.74. t_is_canceled usage + 1.75. t_is_expired usage + 1.76. t_relay_cancel usage + 1.77. t_lookup_cancel usage + 1.78. t_drop_replies() usage + 1.79. t_save_lumps() usage + 1.80. t_load_contacts usage + 1.81. t_next_contacts usage + 1.82. t_next_contact_flow usage + 1.83. t_check_status usage + 1.84. t_check_trans usage + 1.85. t_set_disable_6xx usage + 1.86. t_set_disable_failover usage + 1.87. t_set_disable_internal_reply usage + 1.88. t_replicate usage + 1.89. t_relay_to usage + 1.90. t_set_no_e2e_cancel_reason usage + 1.91. t_replicate usage + 1.92. t_use_uac_headers usage + 1.93. t_is_retr_async_reply usage + 1.94. t_uac_send usage + 1.95. t_get_status_code usage + 1.96. event_route[tm:branch-failure] usage + 1.97. event_route[tm:local-request] usage + 1.98. event_route[tm:local-response] usage Chapter 1. Admin Guide @@ -287,50 +285,49 @@ Chapter 1. Admin Guide 3.3. max_inv_lifetime (integer) 3.4. max_noninv_lifetime (integer) 3.5. wt_timer (integer) - 3.6. delete_timer (integer) - 3.7. retr_timer1 (integer) - 3.8. retr_timer2 (integer) - 3.9. noisy_ctimer (integer) - 3.10. restart_fr_on_each_reply (integer) - 3.11. auto_inv_100 (integer) - 3.12. auto_inv_100_reason (string) - 3.13. unix_tx_timeout (integer) - 3.14. aggregate_challenges (integer) - 3.15. reparse_invite (integer) - 3.16. ac_extra_hdrs (string) - 3.17. blst_503 (integer) - 3.18. blst_503_def_timeout (integer) - 3.19. blst_503_min_timeout (integer) - 3.20. blst_503_max_timeout (integer) - 3.21. blst_methods_add (unsigned integer) - 3.22. blst_methods_lookup (unsigned integer) - 3.23. cancel_b_method (integer) - 3.24. reparse_on_dns_failover (integer) - 3.25. on_sl_reply (string) - 3.26. contacts_avp (string) - 3.27. contact_flows_avp (string) - 3.28. fr_timer_avp (string) - 3.29. fr_inv_timer_avp (string) - 3.30. unmatched_cancel (string) - 3.31. ruri_matching (integer) - 3.32. via1_matching (integer) - 3.33. callid_matching (integer) - 3.34. pass_provisional_replies (integer) - 3.35. default_code (integer) - 3.36. default_reason (string) - 3.37. disable_6xx_block (integer) - 3.38. local_ack_mode (integer) - 3.39. failure_reply_mode (integer) - 3.40. faked_reply_prio (integer) - 3.41. local_cancel_reason (boolean) - 3.42. e2e_cancel_reason (boolean) - 3.43. remap_503_500 (boolean) - 3.44. failure_exec_mode (boolean) - 3.45. dns_reuse_rcv_socket (boolean) - 3.46. xavp_contact (string) - 3.47. event_callback (str) - 3.48. relay_100 (str) - 3.49. rich_redirect (int) + 3.6. retr_timer1 (integer) + 3.7. retr_timer2 (integer) + 3.8. noisy_ctimer (integer) + 3.9. restart_fr_on_each_reply (integer) + 3.10. auto_inv_100 (integer) + 3.11. auto_inv_100_reason (string) + 3.12. unix_tx_timeout (integer) + 3.13. aggregate_challenges (integer) + 3.14. reparse_invite (integer) + 3.15. ac_extra_hdrs (string) + 3.16. blst_503 (integer) + 3.17. blst_503_def_timeout (integer) + 3.18. blst_503_min_timeout (integer) + 3.19. blst_503_max_timeout (integer) + 3.20. blst_methods_add (unsigned integer) + 3.21. blst_methods_lookup (unsigned integer) + 3.22. cancel_b_method (integer) + 3.23. reparse_on_dns_failover (integer) + 3.24. on_sl_reply (string) + 3.25. contacts_avp (string) + 3.26. contact_flows_avp (string) + 3.27. fr_timer_avp (string) + 3.28. fr_inv_timer_avp (string) + 3.29. unmatched_cancel (string) + 3.30. ruri_matching (integer) + 3.31. via1_matching (integer) + 3.32. callid_matching (integer) + 3.33. pass_provisional_replies (integer) + 3.34. default_code (integer) + 3.35. default_reason (string) + 3.36. disable_6xx_block (integer) + 3.37. local_ack_mode (integer) + 3.38. failure_reply_mode (integer) + 3.39. faked_reply_prio (integer) + 3.40. local_cancel_reason (boolean) + 3.41. e2e_cancel_reason (boolean) + 3.42. remap_503_500 (boolean) + 3.43. failure_exec_mode (boolean) + 3.44. dns_reuse_rcv_socket (boolean) + 3.45. xavp_contact (string) + 3.46. event_callback (str) + 3.47. relay_100 (str) + 3.48. rich_redirect (int) 4. Functions @@ -659,50 +656,49 @@ failure_route["serial"] 3.3. max_inv_lifetime (integer) 3.4. max_noninv_lifetime (integer) 3.5. wt_timer (integer) - 3.6. delete_timer (integer) - 3.7. retr_timer1 (integer) - 3.8. retr_timer2 (integer) - 3.9. noisy_ctimer (integer) - 3.10. restart_fr_on_each_reply (integer) - 3.11. auto_inv_100 (integer) - 3.12. auto_inv_100_reason (string) - 3.13. unix_tx_timeout (integer) - 3.14. aggregate_challenges (integer) - 3.15. reparse_invite (integer) - 3.16. ac_extra_hdrs (string) - 3.17. blst_503 (integer) - 3.18. blst_503_def_timeout (integer) - 3.19. blst_503_min_timeout (integer) - 3.20. blst_503_max_timeout (integer) - 3.21. blst_methods_add (unsigned integer) - 3.22. blst_methods_lookup (unsigned integer) - 3.23. cancel_b_method (integer) - 3.24. reparse_on_dns_failover (integer) - 3.25. on_sl_reply (string) - 3.26. contacts_avp (string) - 3.27. contact_flows_avp (string) - 3.28. fr_timer_avp (string) - 3.29. fr_inv_timer_avp (string) - 3.30. unmatched_cancel (string) - 3.31. ruri_matching (integer) - 3.32. via1_matching (integer) - 3.33. callid_matching (integer) - 3.34. pass_provisional_replies (integer) - 3.35. default_code (integer) - 3.36. default_reason (string) - 3.37. disable_6xx_block (integer) - 3.38. local_ack_mode (integer) - 3.39. failure_reply_mode (integer) - 3.40. faked_reply_prio (integer) - 3.41. local_cancel_reason (boolean) - 3.42. e2e_cancel_reason (boolean) - 3.43. remap_503_500 (boolean) - 3.44. failure_exec_mode (boolean) - 3.45. dns_reuse_rcv_socket (boolean) - 3.46. xavp_contact (string) - 3.47. event_callback (str) - 3.48. relay_100 (str) - 3.49. rich_redirect (int) + 3.6. retr_timer1 (integer) + 3.7. retr_timer2 (integer) + 3.8. noisy_ctimer (integer) + 3.9. restart_fr_on_each_reply (integer) + 3.10. auto_inv_100 (integer) + 3.11. auto_inv_100_reason (string) + 3.12. unix_tx_timeout (integer) + 3.13. aggregate_challenges (integer) + 3.14. reparse_invite (integer) + 3.15. ac_extra_hdrs (string) + 3.16. blst_503 (integer) + 3.17. blst_503_def_timeout (integer) + 3.18. blst_503_min_timeout (integer) + 3.19. blst_503_max_timeout (integer) + 3.20. blst_methods_add (unsigned integer) + 3.21. blst_methods_lookup (unsigned integer) + 3.22. cancel_b_method (integer) + 3.23. reparse_on_dns_failover (integer) + 3.24. on_sl_reply (string) + 3.25. contacts_avp (string) + 3.26. contact_flows_avp (string) + 3.27. fr_timer_avp (string) + 3.28. fr_inv_timer_avp (string) + 3.29. unmatched_cancel (string) + 3.30. ruri_matching (integer) + 3.31. via1_matching (integer) + 3.32. callid_matching (integer) + 3.33. pass_provisional_replies (integer) + 3.34. default_code (integer) + 3.35. default_reason (string) + 3.36. disable_6xx_block (integer) + 3.37. local_ack_mode (integer) + 3.38. failure_reply_mode (integer) + 3.39. faked_reply_prio (integer) + 3.40. local_cancel_reason (boolean) + 3.41. e2e_cancel_reason (boolean) + 3.42. remap_503_500 (boolean) + 3.43. failure_exec_mode (boolean) + 3.44. dns_reuse_rcv_socket (boolean) + 3.45. xavp_contact (string) + 3.46. event_callback (str) + 3.47. relay_100 (str) + 3.48. rich_redirect (int) 3.1. fr_timer (integer) @@ -816,33 +812,18 @@ modparam("tm", "max_noninv_lifetime", 30000) modparam("tm", "wt_timer", 1000) ... -3.6. delete_timer (integer) - - Time after which a to-be-deleted transaction currently ref-ed by a - process will be tried to be deleted again (in milliseconds). - - Note: this parameter is obsolete for SER 2.1 (in 2.1 the transaction is - deleted the moment it's not referenced anymore). - - Default value is 200 milliseconds. - - Example 1.6. Set delete_timer parameter -... -modparam("tm", "delete_timer", 100) -... - -3.7. retr_timer1 (integer) +3.6. retr_timer1 (integer) Initial retransmission period (in milliseconds). Default value is 500 milliseconds. - Example 1.7. Set retr_timer1 parameter + Example 1.6. Set retr_timer1 parameter ... modparam("tm", "retr_timer1", 1000) ... -3.8. retr_timer2 (integer) +3.7. retr_timer2 (integer) Maximum retransmission period (in milliseconds). The retransmission interval starts with retr_timer1 and increases until it reaches this @@ -850,12 +831,12 @@ modparam("tm", "retr_timer1", 1000) Default value is 4000 milliseconds. - Example 1.8. Set retr_timer2 parameter + Example 1.7. Set retr_timer2 parameter ... modparam("tm", "retr_timer2", 2000) ... -3.9. noisy_ctimer (integer) +3.8. noisy_ctimer (integer) If set, INVITE transactions that time-out (FR INV timer) will be always replied. If it's not set, the transaction has only one branch and no @@ -870,12 +851,12 @@ modparam("tm", "retr_timer2", 2000) Default value is 1 (on). - Example 1.9. Set noisy_ctimer parameter + Example 1.8. Set noisy_ctimer parameter ... modparam("tm", "noisy_ctimer", 1) ... -3.10. restart_fr_on_each_reply (integer) +3.9. restart_fr_on_each_reply (integer) If set (default), the fr_inv_timer for an INVITE transaction will be restarted for each provisional reply received (rfc3261 mandated @@ -892,12 +873,12 @@ modparam("tm", "noisy_ctimer", 1) See also: fr_inv_timer, max_inv_lifetime. - Example 1.10. Set restart_fr_on_each_reply parameter + Example 1.9. Set restart_fr_on_each_reply parameter ... modparam("tm", "restart_fr_on_each_reply", 0) ... -3.11. auto_inv_100 (integer) +3.10. auto_inv_100 (integer) If set (default) tm will automatically send and 100 reply to INVITEs. @@ -912,12 +893,12 @@ modparam("tm", "restart_fr_on_each_reply", 0) See also: t_set_auto_inv_100() auto_inv_100_reason. - Example 1.11. Set auto_inv_100 parameter + Example 1.10. Set auto_inv_100 parameter ... modparam("tm", "auto_inv_100", 0) ... -3.12. auto_inv_100_reason (string) +3.11. auto_inv_100_reason (string) Set reason text of the automatically sent 100 to an INVITE. @@ -925,12 +906,12 @@ modparam("tm", "auto_inv_100", 0) See also: auto_inv_100. - Example 1.12. Set auto_inv_100_reason parameter + Example 1.11. Set auto_inv_100_reason parameter ... modparam("tm", "auto_inv_100_reason", "Trying") ... -3.13. unix_tx_timeout (integer) +3.12. unix_tx_timeout (integer) Unix socket transmission timeout, in milliseconds. @@ -940,12 +921,12 @@ modparam("tm", "auto_inv_100_reason", "Trying") The default value is 500 milliseconds. - Example 1.13. Set unix_tx_timeout parameter + Example 1.12. Set unix_tx_timeout parameter ... modparam("tm", "unix_tx_timeout", 250) ... -3.14. aggregate_challenges (integer) +3.13. aggregate_challenges (integer) If set (default) and the final response is a 401 or a 407 and more than one branch received a 401 or 407, then all the WWW-Authenticate and @@ -959,12 +940,12 @@ modparam("tm", "unix_tx_timeout", 250) Default value is 1 (required by RFC 3261). - Example 1.14. Set aggregate_challenges parameter + Example 1.13. Set aggregate_challenges parameter ... modparam("tm", "aggregate_challenges", 0) ... -3.15. reparse_invite (integer) +3.14. reparse_invite (integer) If set (default), the CANCEL and negative ACK requests are constructed from the INVITE message which was sent out instead of building them @@ -985,12 +966,12 @@ modparam("tm", "aggregate_challenges", 0) Default value is 1. - Example 1.15. Set reparse_invite parameter + Example 1.14. Set reparse_invite parameter ... modparam("tm", "reparse_invite", 0) ... -3.16. ac_extra_hdrs (string) +3.15. ac_extra_hdrs (string) Header fields prefixed by this parameter value are included in the CANCEL and negative ACK messages if they were present in the outgoing @@ -1003,12 +984,12 @@ modparam("tm", "reparse_invite", 0) Default value is "". - Example 1.16. Set ac_extra_hdrs parameter + Example 1.15. Set ac_extra_hdrs parameter ... modparam("tm", "ac_extra_hdrs", "myfavoriteheaders-") ... -3.17. blst_503 (integer) +3.16. blst_503 (integer) If set and the Kamailio blacklist support is enabled, every 503 reply source is added to the blacklist. The initial blacklist timeout (or @@ -1021,12 +1002,12 @@ modparam("tm", "ac_extra_hdrs", "myfavoriteheaders-") The default value is 0 (disabled due to the reasons above). - Example 1.17. Set blst_503 parameter + Example 1.16. Set blst_503 parameter ... modparam("tm", "blst_503", 1) ... -3.18. blst_503_def_timeout (integer) +3.17. blst_503_def_timeout (integer) Blacklist interval in seconds for a 503 reply with no "Retry-After" header. See also blst_503, blst_503_min_timeout and @@ -1036,12 +1017,12 @@ modparam("tm", "blst_503", 1) present, the 503 reply source will not be blacklisted (RFC 3261 conformant behaviour). - Example 1.18. Set blst_503_def_timeout parameter + Example 1.17. Set blst_503_def_timeout parameter ... modparam("tm", "blst_503_def_timeout", 120) ... -3.19. blst_503_min_timeout (integer) +3.18. blst_503_min_timeout (integer) Minimum blacklist interval in seconds for a 503 reply with a "Retry-After" header. It will be used if the "Retry-After" value is @@ -1051,12 +1032,12 @@ modparam("tm", "blst_503_def_timeout", 120) The default value is 0 - Example 1.19. Set blst_503_min_timeout parameter + Example 1.18. Set blst_503_min_timeout parameter ... modparam("tm", "blst_503_min_timeout", 30) ... -3.20. blst_503_max_timeout (integer) +3.19. blst_503_max_timeout (integer) Maximum blacklist interval in seconds for a 503 reply with a "Retry-After header". It will be used if the "Retry-After" value is @@ -1066,12 +1047,12 @@ modparam("tm", "blst_503_min_timeout", 30) The default value is 3600 - Example 1.20. Set blst_503_max_timeout parameter + Example 1.19. Set blst_503_max_timeout parameter ... modparam("tm", "blst_503_max_timeout", 604800) ... -3.21. blst_methods_add (unsigned integer) +3.20. blst_methods_add (unsigned integer) Bitmap of method types that trigger blacklisting on transaction timeouts. (This setting has no effect on blacklisting because of send @@ -1090,13 +1071,13 @@ modparam("tm", "blst_503_max_timeout", 604800) The default value is 1, only INVITEs trigger blacklisting - Example 1.21. Set blst_methods_add parameter + Example 1.20. Set blst_methods_add parameter ... # INVITEs and REGISTERs trigger blacklisting modparam("tm", "blst_methods_add", 33) ... -3.22. blst_methods_lookup (unsigned integer) +3.21. blst_methods_lookup (unsigned integer) Bitmap of method types that are looked-up in the blacklist before being forwarded statefully. See also blst_methods_add @@ -1104,13 +1085,13 @@ modparam("tm", "blst_methods_add", 33) The default value is 4294967287, every method type except BYE. (We try to deliver BYEs no matter what) - Example 1.22. Set blst_methods_lookup parameter + Example 1.21. Set blst_methods_lookup parameter ... # lookup only INVITEs modparam("tm", "blst_methods_lookup", 1) ... -3.23. cancel_b_method (integer) +3.22. cancel_b_method (integer) Method used when attempting to CANCEL an unreplied transaction branch (a branch where no response was received). The possible values are 0, @@ -1143,12 +1124,12 @@ modparam("tm", "blst_methods_lookup", 1) The default value is 1. - Example 1.23. Set cancel_b_method parameter + Example 1.22. Set cancel_b_method parameter ... modparam("tm", "cancel_b_method", 1) ... -3.24. reparse_on_dns_failover (integer) +3.23. reparse_on_dns_failover (integer) If set to 1, the SIP message after a DNS failover is constructed from the outgoing message buffer of the failed branch instead of from the @@ -1171,19 +1152,19 @@ modparam("tm", "cancel_b_method", 1) Default value is 1. - Example 1.24. Set reparse_on_dns_failover parameter + Example 1.23. Set reparse_on_dns_failover parameter ... modparam("tm", "reparse_on_dns_failover", 0) ... -3.25. on_sl_reply (string) +3.24. on_sl_reply (string) Sets reply route block, to which control is passed when a reply is received that has no associated transaction. The reply is passed to the core for stateless forwarding after the route block execution unless it returns 0. - Example 1.25. Set on_sl_reply parameter + Example 1.24. Set on_sl_reply parameter ... modparam("tm", "on_sl_reply", "stateless_replies") ... @@ -1193,7 +1174,7 @@ onreply_route["stateless_replies"] { return 0; } -3.26. contacts_avp (string) +3.25. contacts_avp (string) This is the name of an XAVP that the t_load_contacts() function uses to store contacts of the destination set and that t_next_contacts() @@ -1202,12 +1183,12 @@ onreply_route["stateless_replies"] { Default value is "NULL" (t_load_contacts()/t_next_contacts() functions are disabled). - Example 1.26. Set contacts_avp parameter + Example 1.25. Set contacts_avp parameter ... modparam("tm", "contacts_avp", "tm_contacts") ... -3.27. contact_flows_avp (string) +3.26. contact_flows_avp (string) This is the name of an XAVP that the t_next_contacts() function uses to store contacts (if any) that it skipped, because they contained same @@ -1217,12 +1198,12 @@ modparam("tm", "contacts_avp", "tm_contacts") Default value is "NULL". This parameter MUST be set if variable contacts_avp is set. - Example 1.27. Set contact_flows_avp parameter + Example 1.26. Set contact_flows_avp parameter ... modparam("tm", "contact_flows_avp", "tm_contact_flows") ... -3.28. fr_timer_avp (string) +3.27. fr_timer_avp (string) The value of fr_timer timer can be overriden on per-transaction basis. The administrator can provide a value to be used for a particular @@ -1247,7 +1228,7 @@ Note the parameter must be the name of an AVP in pseudo-variable format: $avp(name). In SER compatibility mode it must be just AVP name. - Example 1.28. Set fr_timer_avp parameter + Example 1.27. Set fr_timer_avp parameter ... # Kamailio mode modparam("tm", "fr_timer_avp", "$avp(i:708)") @@ -1255,7 +1236,7 @@ modparam("tm", "fr_timer_avp", "$avp(i:708)") modparam("tm", "fr_timer_avp", "i:708") ... -3.29. fr_inv_timer_avp (string) +3.28. fr_inv_timer_avp (string) The value of fr_inv_timer timer can be overriden on per-transaction basis. The administrator can provide a value to be used for a @@ -1281,7 +1262,7 @@ Note the parameter must be the name of an AVP in pseudo-variable format: $avp(name). In SER compatibility mode it must by just AVP name. - Example 1.29. Set fr_inv_timer_avp parameter + Example 1.28. Set fr_inv_timer_avp parameter ... # Kamailio mode modparam("tm", "fr_inv_timer_avp", "$avp(my_fr_inv_timer)") @@ -1289,7 +1270,7 @@ modparam("tm", "fr_inv_timer_avp", "$avp(my_fr_inv_timer)") modparam("tm", "fr_inv_timer_avp", "my_fr_inv_timer") ... -3.30. unmatched_cancel (string) +3.29. unmatched_cancel (string) This parameter selects between forwarding CANCELs that do not match any transaction statefully (0, default value), statelessly (1) or dropping @@ -1304,12 +1285,12 @@ modparam("tm", "fr_inv_timer_avp", "my_fr_inv_timer") Default value is 0. - Example 1.30. Set unmatched_cancel parameter + Example 1.29. Set unmatched_cancel parameter ... modparam("tm", "unmatched_cancel", "2") ... -3.31. ruri_matching (integer) +3.30. ruri_matching (integer) If set the TM module will try to match the request URI when doing SIP 1.0 (pre-RFC 3261) transaction matching (the "Via" header branch @@ -1323,12 +1304,12 @@ modparam("tm", "unmatched_cancel", "2") Can be set at runtime, e.g.: $ kamcmd cfg.set_now_int tm ruri_matching 0 - Example 1.31. Set ruri_matching parameter + Example 1.30. Set ruri_matching parameter ... modparam("tm", "ruri_matching", 1) ... -3.32. via1_matching (integer) +3.31. via1_matching (integer) If set the TM module will try to match the topmost "Via" header when doing SIP 1.0 (pre-RFC 3261) transaction matching (the "Via" header @@ -1342,12 +1323,12 @@ modparam("tm", "ruri_matching", 1) Can be set at runtime, e.g.: $ kamcmd cfg.set_now_int tm via1_matching 0 - Example 1.32. Set via1_matching parameter + Example 1.31. Set via1_matching parameter ... modparam("tm", "via1_matching", 1) ... -3.33. callid_matching (integer) +3.32. callid_matching (integer) If set the TM module will try to match the callid when doing transaction matching. @@ -1363,12 +1344,12 @@ modparam("tm", "via1_matching", 1) Can be set at runtime, e.g.: $ kamcmd cfg.set_now_int tm callid_matching 0 - Example 1.33. Set callid_matching parameter + Example 1.32. Set callid_matching parameter ... modparam("tm", "callid_matching", 1) ... -3.34. pass_provisional_replies (integer) +3.33. pass_provisional_replies (integer) If set, TMCB_LOCAL_RESPONSE_OUT tm registered callbacks will be called also for provisional replies. @@ -1378,12 +1359,12 @@ modparam("tm", "callid_matching", 1) Can be set at runtime, e.g.: $ kamcmd cfg.set_now_int tm pass_provisional_replies 1 - Example 1.34. Set pass_provisional_replies parameter + Example 1.33. Set pass_provisional_replies parameter ... modparam("tm", "pass_provisional_replies", 1) ... -3.35. default_code (integer) +3.34. default_code (integer) Default response code sent by t_reply() if it cannot retrieve its parameters (e.g. inexistent avp). Valid values are between 400 and 699. @@ -1393,12 +1374,12 @@ modparam("tm", "pass_provisional_replies", 1) Can be set at runtime, e.g.: $ kamcmd cfg.set_now_int tm default_code 505 - Example 1.35. Set default_code parameter + Example 1.34. Set default_code parameter ... modparam("tm", "default_code", 501) ... -3.36. default_reason (string) +3.35. default_reason (string) Default SIP reason phrase sent by t_reply() if it cannot retrieve its parameters (e.g. inexistent avp). @@ -1408,12 +1389,12 @@ modparam("tm", "default_code", 501) Can be set at runtime, e.g.: $ kamcmd cfg.set_now_string tm default_reason "Unknown error" - Example 1.36. Set default_reason parameter + Example 1.35. Set default_reason parameter ... modparam("tm", "default_reason", "Unknown reason") ... -3.37. disable_6xx_block (integer) +3.36. disable_6xx_block (integer) If set the TM module will treat all the 6xx replies like normal replies (warning: this would be non-RFC conformant behaviour). @@ -1432,12 +1413,12 @@ modparam("tm", "default_reason", "Unknown reason") See also: t_set_disable_6xx(). - Example 1.37. Set disable_6xx_block parameter + Example 1.36. Set disable_6xx_block parameter ... modparam("tm", "disable_6xx_block", 1) ... -3.38. local_ack_mode (integer) +3.37. local_ack_mode (integer) This setting controls where locally generated ACKs for 2xx replies to local transactions (transactions created via t_uac*() either through @@ -1462,12 +1443,12 @@ Note Can be set at runtime, e.g.: $ kamcmd cfg.set_now_int tm local_ack_mode 0 - Example 1.38. Set local_ack_mode parameter + Example 1.37. Set local_ack_mode parameter ... modparam("tm", "local_ack_mode", 1) ... -3.39. failure_reply_mode (integer) +3.38. failure_reply_mode (integer) This parameter controls how branches are managed and replies are selected for failure_route handling: keep all, drop all, drop last @@ -1499,12 +1480,12 @@ modparam("tm", "local_ack_mode", 1) The default value is 3. - Example 1.39. Set failure_reply_mode parameter + Example 1.38. Set failure_reply_mode parameter ... modparam("tm", "failure_reply_mode", 0) ... -3.40. faked_reply_prio (integer) +3.39. faked_reply_prio (integer) It controls how branch selection is done. It allows to give a penalty to faked replies such as the infamous 408 on branch timeout. @@ -1522,12 +1503,12 @@ modparam("tm", "failure_reply_mode", 0) To let received replies win from a locally generated 408, set this value to 2000. - Example 1.40. Set faked_reply_prio parameter + Example 1.39. Set faked_reply_prio parameter ... modparam("tm", "faked_reply_prio", 2000) ... -3.41. local_cancel_reason (boolean) +3.40. local_cancel_reason (boolean) Enables/disables adding reason headers (RFC 3326) for CANCELs generated due to receiving a final reply. The reason header added will look like: @@ -1540,12 +1521,12 @@ modparam("tm", "faked_reply_prio", 2000) See also: e2e_cancel_reason. - Example 1.41. Set local_cancel_reason parameter + Example 1.40. Set local_cancel_reason parameter ... modparam("tm", "local_cancel_reason", 0) ... -3.42. e2e_cancel_reason (boolean) +3.41. e2e_cancel_reason (boolean) Enables/disables adding reason headers (RFC 3326) for CANCELs generated due to a received CANCEL. If enabled the reason headers from received @@ -1558,12 +1539,12 @@ modparam("tm", "local_cancel_reason", 0) See also: t_set_no_e2e_cancel_reason() and local_cancel_reason. - Example 1.42. Set e2e_cancel_reason parameter + Example 1.41. Set e2e_cancel_reason parameter ... modparam("tm", "e2e_cancel_reason", 0) ... -3.43. remap_503_500 (boolean) +3.42. remap_503_500 (boolean) Enables/disables conversion of 503 response code to 500. By default it is enabled, based on the SIP RFC requirement. This is global setting @@ -1573,12 +1554,12 @@ modparam("tm", "e2e_cancel_reason", 0) Default value is 1 (enabled). - Example 1.43. Set remap_503_500 parameter + Example 1.42. Set remap_503_500 parameter ... modparam("tm", "remap_503_500", 0) ... -3.44. failure_exec_mode (boolean) +3.43. failure_exec_mode (boolean) Add local failed branches in timer to be considered for failure routing blocks. If disabled, relay functions will return false in case the @@ -1586,12 +1567,12 @@ modparam("tm", "remap_503_500", 0) Default value is 0 (disabled). - Example 1.44. Set failure_exec_mode parameter + Example 1.43. Set failure_exec_mode parameter ... modparam("tm", "failure_exec_mode", 1) ... -3.45. dns_reuse_rcv_socket (boolean) +3.44. dns_reuse_rcv_socket (boolean) Control reuse of the receive socket for additional branches added by DNS failover. If set to 1, the receive socket is used for sending out @@ -1607,24 +1588,24 @@ modparam("tm", "failure_exec_mode", 1) Default value is 0 (disabled). - Example 1.45. Set dns_reuse_rcv_socket parameter + Example 1.44. Set dns_reuse_rcv_socket parameter ... modparam("tm", "dns_reuse_rcv_socket", 1) ... -3.46. xavp_contact (string) +3.45. xavp_contact (string) The name of XAVP storing the attributes per contact. This must be the same as the usrloc parameter xavp_contact. Default value is “NULL”. - Example 1.46. Set xavp_contact parameter + Example 1.45. Set xavp_contact parameter ... modparam("tm|usrloc", "xavp_contact", "ulattrs") ... -3.47. event_callback (str) +3.46. event_callback (str) The name of the function in the kemi configuration file (embedded scripting language such as Lua, Python, ...) to be executed instead of @@ -1633,7 +1614,7 @@ modparam("tm|usrloc", "xavp_contact", "ulattrs") Default value is 'empty' (no function is executed for events). - Example 1.47. Set event_callback parameter + Example 1.46. Set event_callback parameter ... modparam("tm", "event_callback", "ksr_tm_event") ... @@ -1644,7 +1625,7 @@ function ksr_tm_event(evname) end ... -3.48. relay_100 (str) +3.47. relay_100 (str) This parameter controls whether or not a SIP 100 response is proxied. Note that this is not valid behavior when operating in stateful mode @@ -1656,12 +1637,12 @@ end Default value is 0 (disabled). - Example 1.48. Set relay_100 parameter + Example 1.47. Set relay_100 parameter ... modparam("tm", "relay_100", 1) ... -3.49. rich_redirect (int) +3.48. rich_redirect (int) When sending a 3xx class reply, include additional branch info to the contacts such as path vector and branch flags. @@ -1671,7 +1652,7 @@ modparam("tm", "relay_100", 1) Values may be combined (added). - Example 1.49. rich_redirect example + Example 1.48. rich_redirect example ... modparam("tm", "rich_redirect", 3) .... @@ -1752,7 +1733,7 @@ modparam("tm", "rich_redirect", 3) Returns a negative value on failure -- you may still want to send a negative reply upstream statelessly not to leave upstream UAC in lurch. - Example 1.50. t_relay usage + Example 1.49. t_relay usage ... if (!t_relay()) { @@ -1779,7 +1760,7 @@ if (!t_relay()) derived from the message uri (using sip specific DNS lookups), but with the protocol corresponding to the function name. - Example 1.51. t_relay_to_udp usage + Example 1.50. t_relay_to_udp usage ... if (src_ip==10.0.0.0/8) t_relay_to_udp("1.2.3.4", "5060"); # sent to 1.2.3.4:5060 over udp @@ -1819,7 +1800,7 @@ else Meaning of the parameters is as follows: * failure_route - Failure route block to be called. - Example 1.52. t_on_failure usage + Example 1.51. t_on_failure usage ... route { t_on_failure("1"); @@ -1855,7 +1836,7 @@ failure_route[1] { * branch_failure_route - Name of the branch_failure route block to be called (it is prefixed internally with 'tm:branch-failure:'). - Example 1.53. t_on_branch_failure usage + Example 1.52. t_on_branch_failure usage ... route { t_on_branch_failure("myroute"); @@ -1878,7 +1859,7 @@ event_route[tm:branch-failure:myroute] { Meaning of the parameters is as follows: * onreply_route - Onreply route block to be called. - Example 1.54. t_on_reply usage + Example 1.53. t_on_reply usage ... loadmodule "/usr/local/lib/ser/modules/nathelper.so" ... @@ -1910,7 +1891,7 @@ es'); Meaning of the parameters is as follows: * branch_route - branch route block to be called. - Example 1.55. t_on_branch usage + Example 1.54. t_on_branch usage ... route { t_on_branch("1"); @@ -1929,7 +1910,7 @@ 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. - Example 1.56. t_newtran usage + Example 1.55. t_newtran usage ... if (t_newtran()) { log("UAS logic"); @@ -1959,7 +1940,7 @@ if (t_newtran()) { * code - Reply code number. * reason_phrase - Reason string. - Example 1.57. t_reply usage + Example 1.56. t_reply usage ... t_reply("404", "Not found"); ... @@ -1977,7 +1958,7 @@ t_reply("404", "Not found"); * code - Reply code number. * reason - Reason string. - Example 1.58. t_send_reply usage + Example 1.57. t_send_reply usage ... t_send_reply("404", "Not found"); ... @@ -1990,7 +1971,7 @@ t_send_reply("404", "Not found"); none was found. However this is safely (atomically) done using t_newtran. - Example 1.59. t_lookup_request usage + Example 1.58. t_lookup_request usage ... if (t_lookup_request()) { ... @@ -2001,7 +1982,7 @@ if (t_lookup_request()) { Retransmits a reply sent previously by UAS transaction. - Example 1.60. t_retransmit_reply usage + Example 1.59. t_retransmit_reply usage ... t_retransmit_reply(); ... @@ -2011,7 +1992,7 @@ t_retransmit_reply(); Remove transaction from memory (it will be first put on a wait timer to absorb delayed messages). - Example 1.61. t_release usage + Example 1.60. t_release usage ... t_release(); ... @@ -2025,7 +2006,7 @@ t_release(); * ip - IP address where the message should be sent. * port - Port number. - Example 1.62. t_forward_nonack usage + Example 1.61. t_forward_nonack usage ... t_forward_nonack("1.2.3.4", "5060"); ... @@ -2064,7 +2045,7 @@ t_forward_nonack("1.2.3.4", "5060"); See also: fr_timer, fr_inv_timer, t_reset_fr(). - Example 1.63. t_set_fr usage + Example 1.62. t_set_fr usage ... route { t_set_fr(10000); # set only fr invite timeout to 10s @@ -2091,7 +2072,7 @@ branch_route[1] { See also: fr_timer, fr_inv_timer, t_set_fr. - Example 1.64. t_reset_fr usage + Example 1.63. t_reset_fr usage ... route { ... @@ -2117,7 +2098,7 @@ route { See also: max_inv_lifetime, max_noninv_lifetime, t_reset_max_lifetime. - Example 1.65. t_set_max_lifetime usage + Example 1.64. t_set_max_lifetime usage ... route { if (src_ip=1.2.3.4) @@ -2139,7 +2120,7 @@ route { See also: max_inv_lifetime, max_noninv_lifetime, t_set_max_lifetime. - Example 1.66. t_reset_max_lifetime usage + Example 1.65. t_reset_max_lifetime usage ... route { ... @@ -2177,7 +2158,7 @@ route { See also: retr_timer1, retr_timer2, t_reset_retr(). - Example 1.67. t_set_retr usage + Example 1.66. t_set_retr usage ... route { t_set_retr(250, 0); # set only T1 to 250 ms @@ -2204,7 +2185,7 @@ branch_route[1] { See also: retr_timer1, retr_timer2, t_set_retr. - Example 1.68. t_reset_retr usage + Example 1.67. t_reset_retr usage ... route { ... @@ -2220,7 +2201,7 @@ route { See also: auto_inv_100. - Example 1.69. t_set_auto_inv_100 usage + Example 1.68. t_set_auto_inv_100 usage ... route { ... @@ -2235,7 +2216,7 @@ route { timeout. It can be used from FAILURE_ROUTE and BRANCH_FAILURE_ROUTE event route. - Example 1.70. t_branch_timeout usage + Example 1.69. t_branch_timeout usage ... failure_route[0]{ if (t_branch_timeout()){ @@ -2251,7 +2232,7 @@ failure_route[0]{ taken into account). It can be used from failure_route and branch-failure event route. - Example 1.71. t_branch_replied usage + Example 1.70. t_branch_replied usage ... failure_route[0]{ if (t_branch_timeout()){ @@ -2268,7 +2249,7 @@ failure_route[0]{ Returns true if at least one of the current transactions branches did timeout. - Example 1.72. t_any_timeout usage + Example 1.71. t_any_timeout usage ... failure_route[0]{ if (!t_branch_timeout()){ @@ -2285,7 +2266,7 @@ failure_route[0]{ receive some reply in the past. If called from a failure or onreply route, the "current" reply is not taken into account. - Example 1.73. t_any_replied usage + Example 1.72. t_any_replied usage ... onreply_route[0]{ if (!t_any_replied()){ @@ -2299,7 +2280,7 @@ onreply_route[0]{ Returns true if "code" is the final reply received (or locally generated) in at least one of the current transactions branches. - Example 1.74. t_grep_status usage + Example 1.73. t_grep_status usage ... onreply_route[0]{ if (t_grep_status("486")){ @@ -2312,7 +2293,7 @@ onreply_route[0]{ Returns true if the current transaction was canceled. - Example 1.75. t_is_canceled usage + Example 1.74. t_is_canceled usage ... failure_route[0]{ if (t_is_canceled()){ @@ -2326,7 +2307,7 @@ failure_route[0]{ Returns true if the current transaction has already been expired, i.e. the max_inv_lifetime/max_noninv_lifetime interval has already elapsed. - Example 1.76. t_is_expired usage + Example 1.75. t_is_expired usage ... failure_route[0]{ if (t_is_expired()){ @@ -2347,7 +2328,7 @@ failure_route[0]{ CANCELs were successfully sent to the pending branches, true if the INVITE was not found, and false in case of any error. - Example 1.77. t_relay_cancel usage + Example 1.76. t_relay_cancel usage if (method == CANCEL) { if (!t_relay_cancel()) { # implicit drop if relaying was successful, # nothing to do @@ -2374,7 +2355,7 @@ if (method == CANCEL) { overwritten with the flags of the INVITE. isflagset() can be used to check the flags of the previously forwarded INVITE in this case. - Example 1.78. t_lookup_cancel usage + Example 1.77. t_lookup_cancel usage if (method == CANCEL) { if (t_lookup_cancel()) { log("INVITE transaction exists"); @@ -2404,7 +2385,7 @@ if (method == CANCEL) { Dropping replies works only if a new branch is added to the transaction, or it is explicitly replied in the script! - Example 1.79. t_drop_replies() usage + Example 1.78. t_drop_replies() usage ... failure_route[0]{ if (t_check_status("5[0-9][0-9]")){ @@ -2435,7 +2416,7 @@ failure_route[0]{ The transaction must be created by t_newtran() before calling t_save_lumps(). - Example 1.80. t_save_lumps() usage + Example 1.79. t_save_lumps() usage route { ... t_newtran(); @@ -2494,7 +2475,7 @@ failure_route[1] { This function can be used from REQUEST_ROUTE and FAILURE_ROUTE. - Example 1.81. t_load_contacts usage + Example 1.80. t_load_contacts usage ... if (!t_load_contacts()) { sl_send_reply("500", "Server Internal Error - Cannot load contacts"); @@ -2535,7 +2516,7 @@ if (!t_load_contacts()) { contact_flows_avp are not anymore set. Based on that test, you can then use t_set_fr() function to set timers according to your needs. - Example 1.82. t_next_contacts usage + Example 1.81. t_next_contacts usage ... # First call after t_load_contacts() when transaction does not exist yet # and contacts should be available @@ -2573,7 +2554,7 @@ if (!t_next_contacts()) { syslog). This function can be used from a BRANCH_FAILURE_ROUTE event route. - Example 1.83. t_next_contact_flow usage + Example 1.82. t_next_contact_flow usage ... event_route[tm:branch-failure:outbound] { @@ -2596,7 +2577,7 @@ event_route[tm:branch-failure:outbound] This function can be used from ANY_ROUTE . - Example 1.84. t_check_status usage + Example 1.83. t_check_status usage ... if (t_check_status("(487)|(408)")) { log("487 or 408 negative reply\n"); @@ -2650,7 +2631,7 @@ Note See also: t_lookup_request(), t_lookup_cancel(). - Example 1.85. t_check_trans usage + Example 1.84. t_check_trans usage if ( method == "CANCEL" && !t_check_trans()) sl_reply("403", "cancel out of the blue forbidden"); # note: in this example t_check_trans() can be replaced by t_lookup_cancel() @@ -2665,7 +2646,7 @@ if ( method == "CANCEL" && !t_check_trans()) See also: disable_6xx_block. - Example 1.86. t_set_disable_6xx usage + Example 1.85. t_set_disable_6xx usage ... route { ... @@ -2680,7 +2661,7 @@ route { See also: use_dns_failover. - Example 1.87. t_set_disable_failover usage + Example 1.86. t_set_disable_failover usage ... route { ... @@ -2693,7 +2674,7 @@ route { Turn off/on sending internally a SIP reply in case of relay errors. - Example 1.88. t_set_disable_internal_reply usage + Example 1.87. t_set_disable_internal_reply usage ... t_set_disable_internal_reply(1); # turn off sending internal reply on error if(!t_relay()) { @@ -2726,7 +2707,7 @@ if(!t_relay()) { * hostport - address in "host:port" format. It can be given via an AVP. - Example 1.89. t_replicate usage + Example 1.88. t_replicate usage ... # sent to 1.2.3.4:5060 over tcp t_replicate("sip:1.2.3.4:5060;transport=tcp"); @@ -2760,7 +2741,7 @@ t_replicate_to_udp("1.2.3.4", "5060"); + 0x02 - do not generate reply on internal error. + 0x04 - disable dns failover. - Example 1.90. t_relay_to usage + Example 1.89. t_relay_to usage ... # sent to 1.2.3.4:5060 over tcp t_relay_to("tcp:1.2.3.4:5060"); @@ -2786,7 +2767,7 @@ t_relay_to("0x01"); See also: e2e_cancel_reason. - Example 1.91. t_set_no_e2e_cancel_reason usage + Example 1.90. t_set_no_e2e_cancel_reason usage ... route { ... @@ -2809,7 +2790,7 @@ opying * onreply_route - the function returns true if an onreply route is set to be executed. - Example 1.92. t_replicate usage + Example 1.91. t_replicate usage ... if(!t_is_set("failure_route")) LM_DBG("no failure route will be executed for current transaction\n"); @@ -2823,7 +2804,7 @@ if(!t_is_set("failure_route")) It returns true. - Example 1.93. t_use_uac_headers usage + Example 1.92. t_use_uac_headers usage ... t_use_uac_headers(); ... @@ -2842,7 +2823,7 @@ t_use_uac_headers(); returns true if the transaction is currently reply suspended or false if not. - Example 1.94. t_is_retr_async_reply usage + Example 1.93. t_is_retr_async_reply usage ... if (t_is_retr_async_reply()) { xlog("L_DBG", "Dropping retransmitted reply which is still currently sus @@ -2867,7 +2848,7 @@ pended\n"); Content-Type header must exist. * body - SIP message body (can be empty). - Example 1.95. t_uac_send usage + Example 1.94. t_uac_send usage ... t_uac_send("OPTIONS", "sip:alice@kamailio.org", "", "", "From: bob@kamailio.org;tag=2w3e\r\nTo: bob@kamailio.org", ""); @@ -2878,7 +2859,7 @@ t_uac_send("OPTIONS", "sip:alice@kamailio.org", "", "", Return the status code for transaction - the most relevant SIP reply status code, or -1 in case of error or no status code was set. - Example 1.96. t_get_status_code usage + Example 1.95. t_get_status_code usage ... $var(ts) = t_get_status_code(); if($var(ts) == 500) { ... } @@ -2997,7 +2978,7 @@ if($var(ts) == 500) { ... } enabled with the t_on_branch_failure function. This event_route uses the BRANCH_FAILURE_ROUTE route type. - Example 1.97. event_route[tm:branch-failure] usage + Example 1.96. event_route[tm:branch-failure] usage ... request_route { ... @@ -3015,7 +2996,7 @@ event_route[tm:branch-failure:myroute] { Executed after the tm module has sent a local generated, transaction stateful request. - Example 1.98. event_route[tm:local-request] usage + Example 1.97. event_route[tm:local-request] usage ... event_route [tm:local-request] { xlog("L_INFO", "Routing locally generated $rm to $ru\n"); @@ -3028,7 +3009,7 @@ event_route [tm:local-request] { Executed after the tm module has sent a local generated, transaction stateful response. - Example 1.99. event_route[tm:local-response] usage + Example 1.98. event_route[tm:local-response] usage ... event_route[tm:local-response] { xlog("tm:local-response replied locally\n");