[sr-dev] git:master: tm: readme regenerated
Daniel-Constantin Mierla
miconda at gmail.com
Fri Aug 23 21:04:57 CEST 2013
Module: sip-router
Branch: master
Commit: b2a536f0f577026ffa57d0b603c60e6232bc8e78
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b2a536f0f577026ffa57d0b603c60e6232bc8e78
Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: Fri Aug 23 21:04:06 2013 +0200
tm: readme regenerated
---
modules/tm/README | 69 ++++++++++++++++++++++++++++++++--------------------
1 files changed, 42 insertions(+), 27 deletions(-)
diff --git a/modules/tm/README b/modules/tm/README
index 090ea3f..2462d12 100644
--- a/modules/tm/README
+++ b/modules/tm/README
@@ -113,10 +113,11 @@ Juha Heinanen
5.41. t_check_trans()
5.42. t_set_disable_6xx(0|1)
5.43. t_set_disable_failover(0|1)
- 5.44. t_replicate(params)
- 5.45. t_relay_to(proxy, flags)
- 5.46. t_set_no_e2e_cancel_reason(0|1)
- 5.47. t_is_set(target)
+ 5.44. t_set_disable_internal_reply(0|1)
+ 5.45. t_replicate(params)
+ 5.46. t_relay_to(proxy, flags)
+ 5.47. t_set_no_e2e_cancel_reason(0|1)
+ 5.48. t_is_set(target)
6. TM Module API
@@ -221,11 +222,12 @@ Juha Heinanen
1.79. t_check_trans usage
1.80. t_set_disable_6xx usage
1.81. t_set_disable_failover usage
- 1.82. t_replicate usage
+ 1.82. t_set_disable_internal_reply usage
1.83. t_replicate usage
- 1.84. t_set_no_e2e_cancel_reason usage
- 1.85. t_replicate usage
- 1.86. event_route[tm:branch-failure] usage
+ 1.84. t_replicate usage
+ 1.85. t_set_no_e2e_cancel_reason usage
+ 1.86. t_replicate usage
+ 1.87. event_route[tm:branch-failure] usage
Chapter 1. Admin Guide
@@ -327,10 +329,11 @@ Chapter 1. Admin Guide
5.41. t_check_trans()
5.42. t_set_disable_6xx(0|1)
5.43. t_set_disable_failover(0|1)
- 5.44. t_replicate(params)
- 5.45. t_relay_to(proxy, flags)
- 5.46. t_set_no_e2e_cancel_reason(0|1)
- 5.47. t_is_set(target)
+ 5.44. t_set_disable_internal_reply(0|1)
+ 5.45. t_replicate(params)
+ 5.46. t_relay_to(proxy, flags)
+ 5.47. t_set_no_e2e_cancel_reason(0|1)
+ 5.48. t_is_set(target)
6. TM Module API
@@ -1594,10 +1597,11 @@ modparam("tm", "dns_reuse_rcv_socket", 1)
5.41. t_check_trans()
5.42. t_set_disable_6xx(0|1)
5.43. t_set_disable_failover(0|1)
- 5.44. t_replicate(params)
- 5.45. t_relay_to(proxy, flags)
- 5.46. t_set_no_e2e_cancel_reason(0|1)
- 5.47. t_is_set(target)
+ 5.44. t_set_disable_internal_reply(0|1)
+ 5.45. t_replicate(params)
+ 5.46. t_relay_to(proxy, flags)
+ 5.47. t_set_no_e2e_cancel_reason(0|1)
+ 5.48. t_is_set(target)
5.1. t_relay([host, port])
@@ -2505,7 +2509,19 @@ route {
...
}
-5.44. t_replicate(params)
+5.44. t_set_disable_internal_reply(0|1)
+
+ Turn off/on sending internally a SIP reply in case of relay errors.
+
+ Example 1.82. t_set_disable_internal_reply usage
+...
+t_set_disable_internal_reply(1); # turn off sending internal reply on error
+if(!t_relay()) {
+ send_reply("500", "Server error");
+}
+...
+
+5.45. t_replicate(params)
Replicate the SIP request to a specific address.
@@ -2527,7 +2543,7 @@ route {
* hostport - address in "host:port" format. It can be given via an
AVP.
- Example 1.82. t_replicate usage
+ Example 1.83. t_replicate usage
...
# sent to 1.2.3.4:5060 over tcp
t_replicate("sip:1.2.3.4:5060;transport=tcp");
@@ -2540,7 +2556,7 @@ t_replicate("sip:$var(h);transport=tls");
t_replicate_to_udp("1.2.3.4", "5060");
...
-5.45. t_relay_to(proxy, flags)
+5.46. t_relay_to(proxy, flags)
Forward the SIP request to a specific address, controlling internal
behavior via flags.
@@ -2558,11 +2574,10 @@ t_replicate_to_udp("1.2.3.4", "5060");
* flags - bitmask integer value to control the internal behavior.
Bits can be:
+ 0x01 - do not generate 100 reply.
- + 0x02 - do not generate reply on internal error (NOTE: has no
- effect anymore).
+ + 0x02 - do not generate reply on internal error.
+ 0x04 - disable dns failover.
- Example 1.83. t_replicate usage
+ Example 1.84. t_replicate usage
...
# sent to 1.2.3.4:5060 over tcp
t_relay_to("tcp:1.2.3.4:5060");
@@ -2574,7 +2589,7 @@ t_relay_to("tls:1.2.3.4");
t_relay_to("0x01");
...
-5.46. t_set_no_e2e_cancel_reason(0|1)
+5.47. t_set_no_e2e_cancel_reason(0|1)
Enables/disables reason header (RFC 3326) copying from the triggering
received CANCEL to the generated hop-by-hop CANCEL. 0 enables and 1
@@ -2585,7 +2600,7 @@ t_relay_to("0x01");
See also: e2e_cancel_reason.
- Example 1.84. t_set_no_e2e_cancel_reason usage
+ Example 1.85. t_set_no_e2e_cancel_reason usage
...
route {
...
@@ -2595,7 +2610,7 @@ opying
...
}
-5.47. t_is_set(target)
+5.48. t_is_set(target)
Return true if the attribute specified by 'target' is set for
transaction.
@@ -2608,7 +2623,7 @@ opying
* onreply_route - the function returns true if an onreply route is
set to be executed.
- Example 1.85. t_replicate usage
+ Example 1.86. t_replicate usage
...
if(!t_is_set("failure_route"))
LM_DBG("no failure route will be executed for current transaction\n");
@@ -2795,7 +2810,7 @@ action *route)
enabled with the t_on_branch_failure function. This event_route uses
the BRANCH_FAILURE_ROUTE route type.
- Example 1.86. event_route[tm:branch-failure] usage
+ Example 1.87. event_route[tm:branch-failure] usage
...
route {
t_on_branch_failure("myroute");
More information about the sr-dev
mailing list