30 May
2009
30 May
'09
5:41 p.m.
Module: sip-router
Branch: master
Commit: bb8a054005373f8c78ca480435b7db2a7a8b3676
URL:
http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=bb8a054…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: Sat May 30 17:40:17 2009 +0300
tm: doc - added note about tmx module
- indication that some functionalities of K tm are now in tmx
---
modules/tm/README | 94 +++++++++++++++++++++++++++++++++++++++++++++++++
modules/tm/doc/tm.xml | 5 +++
2 files changed, 99 insertions(+), 0 deletions(-)
diff --git a/modules/tm/README b/modules/tm/README
index 9d489a5..ecee53b 100644
--- a/modules/tm/README
+++ b/modules/tm/README
@@ -15,6 +15,94 @@ Juha Heinanen
Revision $Revision$ $Date$
__________________________________________________________________
+ 1.1. Overview
+ 1.2. Known Issues
+ 1.3. Parameters
+
+ 1.3.1. fr_timer (integer)
+ 1.3.2. fr_inv_timer (integer)
+ 1.3.3. max_inv_lifetime (integer)
+ 1.3.4. max_noninv_lifetime (integer)
+ 1.3.5. wt_timer (integer)
+ 1.3.6. delete_timer (integer)
+ 1.3.7. retr_timer1 (integer)
+ 1.3.8. retr_timer2 (integer)
+ 1.3.9. noisy_ctimer (integer)
+ 1.3.10. restart_fr_on_each_reply (integer)
+ 1.3.11. auto_inv_100 (integer)
+ 1.3.12. auto_inv_100_reason (string)
+ 1.3.13. unix_tx_timeout (integer)
+ 1.3.14. aggregate_challenges (integer)
+ 1.3.15. reparse_invite (integer)
+ 1.3.16. ac_extra_hdrs (string)
+ 1.3.17. blst_503 (integer)
+ 1.3.18. blst_503_def_timeout (integer)
+ 1.3.19. blst_503_min_timeout (integer)
+ 1.3.20. blst_503_max_timeout (integer)
+ 1.3.21. blst_methods_add (unsigned integer)
+ 1.3.22. blst_methods_lookup (unsigned integer)
+ 1.3.23. cancel_b_method (integer)
+ 1.3.24. reparse_on_dns_failover (integer)
+ 1.3.25. on_sl_reply (string)
+ 1.3.26. fr_inv_timer_next (integer)
+ 1.3.27. contacts_avp (string)
+
+ 1.4. Functions
+
+ 1.4.1. t_relay_to_udp(ip, port), t_relay_to_udp(),
+ t_relay_to_tcp(ip, port) t_relay_to_tcp()
+ t_relay_to_tls(ip, port) t_relay_to_tls()
+ t_relay_to_sctp(ip, port) t_relay_to_sctp()
+
+ 1.4.2. t_relay() t_relay(host, port)
+ 1.4.3. t_on_failure(failure_route)
+ 1.4.4. t_on_reply(onreply_route)
+ 1.4.5. t_on_branch(branch_route)
+ 1.4.6. append_branch()
+ 1.4.7. t_newtran()
+ 1.4.8. t_reply(code, reason_phrase)
+ 1.4.9. t_lookup_request()
+ 1.4.10. t_retransmit_reply()
+ 1.4.11. t_release()
+ 1.4.12. t_forward_nonack() t_forward_nonack(ip, port)
+ t_forward_nonack_udp(ip, port) t_forward_nonack_tcp(ip,
+ port) t_forward_nonack_tls(ip, port)
+ t_forward_nonack_sctp(ip, port)
+
+ 1.4.13. t_set_fr(fr_inv_timeout [, fr_timeout])
+ 1.4.14. t_reset_fr()
+ 1.4.15. t_set_max_lifetime(inv_lifetime, noninv_lifetime)
+ 1.4.16. t_reset_max_lifetime()
+ 1.4.17. t_set_retr(retr_t1_interval, retr_t2_interval)
+ 1.4.18. t_reset_retr()
+ 1.4.19. t_set_auto_inv_100(0|1)
+ 1.4.20. t_branch_timeout()
+ 1.4.21. t_branch_replied()
+ 1.4.22. t_any_timeout()
+ 1.4.23. t_any_replied()
+ 1.4.24. t_grep_status("code")
+ 1.4.25. t_is_canceled()
+ 1.4.26. t_is_expired()
+ 1.4.27. t_relay_cancel()
+ 1.4.28. t_lookup_cancel(), t_lookup_cancel(1)
+ 1.4.29. t_drop_replies()
+ 1.4.30. t_save_lumps()
+ 1.4.31. t_load_contacts()
+ 1.4.32. t_next_contacts()
+
+ 1.5. TM Module API
+
+ 1.5.1. Defines
+ 1.5.2. Functions
+
+ 1.5.2.1. register_tmcb(cb_type, cb_func)
+ 1.5.2.2. load_tm(*import_structure)
+ 1.5.2.3. int t_suspend(struct sip_msg *msg, unsigned int
+ *hash_index, unsigned int *label)
+
+ 1.5.2.4. int t_continue(unsigned int hash_index, unsigned
+ int label, struct action *route)
+
1.1. Overview
TM module enables stateful processing of SIP transactions. The main use
@@ -64,6 +152,12 @@ Juha Heinanen
timeouts, forking, etc. See t_uac prototype in uac.h for more details.
Who wants to see the transaction result may register for a callback.
+Note
+
+ Several Kamailio (OpenSER) TM module functionalities are now
+ implemented in the TMX module: "modules_k/tmx". Check it to see if what
+ you are looking for is there.
+
1.2. Known Issues
* Possibly, performance could be improved by not parsing non-INVITEs,
diff --git a/modules/tm/doc/tm.xml b/modules/tm/doc/tm.xml
index 2ee419c..64134ff 100644
--- a/modules/tm/doc/tm.xml
+++ b/modules/tm/doc/tm.xml
@@ -98,6 +98,11 @@
See t_uac prototype in uac.h for more details. Who wants to see the
transaction result may register for a callback.
</para>
+ <note>
+ <para>Several Kamailio (OpenSER) TM module functionalities are now
+ implemented in the TMX module: <quote>modules_k/tmx</quote>. Check
+ it to see if what you are looking for is there.</para>
+ </note>
</section>
<section id="tm.known_issues">