Module: kamailio
Branch: master
Commit: be8ba0dab1ee36ae517cef52c023cd83440f4af9
URL:
https://github.com/kamailio/kamailio/commit/be8ba0dab1ee36ae517cef52c023cd8…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2019-08-27T09:31:51+02:00
modules: readme files regenerated - tm ... [skip ci]
---
Modified: src/modules/tm/README
---
Diff:
https://github.com/kamailio/kamailio/commit/be8ba0dab1ee36ae517cef52c023cd8…
Patch:
https://github.com/kamailio/kamailio/commit/be8ba0dab1ee36ae517cef52c023cd8…
---
diff --git a/src/modules/tm/README b/src/modules/tm/README
index 47598f379e..7f0970a4e3 100644
--- a/src/modules/tm/README
+++ b/src/modules/tm/README
@@ -149,7 +149,7 @@ Daniel-Constantin Mierla
6. Event Routes
- 6.1. event_route[tm:branch-failure]
+ 6.1. event_route[tm:branch-failure:id]
6.2. event_route[tm:local-request]
6.3. event_route[tm:local-response]
@@ -268,9 +268,9 @@ Daniel-Constantin Mierla
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
+ 1.96. event_route[tm:branch-failure:id] usage
+ 1.1. event_route[tm:local-request] usage
+ 1.2. event_route[tm:local-response] usage
Chapter 1. Admin Guide
@@ -400,7 +400,7 @@ Chapter 1. Admin Guide
6. Event Routes
- 6.1. event_route[tm:branch-failure]
+ 6.1. event_route[tm:branch-failure:id]
6.2. event_route[tm:local-request]
6.3. event_route[tm:local-response]
@@ -2964,21 +2964,21 @@ if($var(ts) == 500) { ... }
6. Event Routes
- 6.1. event_route[tm:branch-failure]
+ 6.1. event_route[tm:branch-failure:id]
6.2. event_route[tm:local-request]
6.3. event_route[tm:local-response]
-6.1. event_route[tm:branch-failure]
+6.1. event_route[tm:branch-failure:id]
Named branch failure routes can be defined to run when when a failure
response is received. This allows handling failures on individual
branches, for example, retrying an alternative outbound flow.
- The format of the event_route name is "tm:branch-failure:<name>" and
is
+ The format of the event_route name is "tm:branch-failure:<id>" and is
enabled with the t_on_branch_failure function. This event_route uses
the BRANCH_FAILURE_ROUTE route type.
- Example 1.96. event_route[tm:branch-failure] usage
+ Example 1.96. event_route[tm:branch-failure:id] usage
...
request_route {
...
@@ -2993,8 +2993,15 @@ event_route[tm:branch-failure:myroute] {
6.2. event_route[tm:local-request]
- Executed after the tm module has sent a local generated, transaction
- stateful request.
+ Executed when the tm module generates a request, in other words, the
+ request originates from and a transaction is created for it. The source
+ of the requests can be tm itself or other modules that use tm
+ internally (e.g., msilo, uac). The event route is executed if it is
+ defined in the native config file. To execute the equivalent callback
+ when using KEMI scripting, see the 'event_callback' module parameter.
+
+ The request can still be updated, i.e., changes are possible to R-URI
+ ($ru), destination URI ($du) or the send socket ($fs).
Example 1.97. event_route[tm:local-request] usage
...
@@ -3006,8 +3013,8 @@ event_route [tm:local-request] {
6.3. event_route[tm:local-response]
- Executed after the tm module has sent a local generated, transaction
- stateful response.
+ Executed when the tm module is about to send a local generated,
+ transaction stateful response.
Example 1.98. event_route[tm:local-response] usage
...