From b4970c92cfed389d221782b091eb3984b7d6224f Mon Sep 17 00:00:00 2001 From: Juha Heinanen Date: Sun, 7 Feb 2016 08:28:51 +0200 Subject: [PATCH] modules/tmx: regenerated README --- modules/tmx/README | 181 +++++++++++++++++++++++++-------------------- 1 file changed, 101 insertions(+), 80 deletions(-) diff --git a/modules/tmx/README b/modules/tmx/README index 387812113d7..e56b139abc3 100644 --- a/modules/tmx/README +++ b/modules/tmx/README @@ -22,7 +22,7 @@ Juha Heinanen - Copyright 2009 Daniel-Constantin Mierla + Copyright © 2009 Daniel-Constantin Mierla __________________________________________________________________ Table of Contents @@ -64,17 +64,20 @@ Juha Heinanen 7. Statistics - 7.1. received_replies - 7.2. relayed_replies - 7.3. local_replies - 7.4. UAS_transactions - 7.5. UAC_transactions - 7.6. 2xx_transactions - 7.7. 3xx_transactions - 7.8. 4xx_transactions - 7.9. 5xx_transactions - 7.10. 6xx_transactions - 7.11. inuse_transactions + 7.1. UAS_transactions + 7.2. UAC_transactions + 7.3. 2xx_transactions + 7.4. 3xx_transactions + 7.5. 4xx_transactions + 7.6. 5xx_transactions + 7.7. 6xx_transactions + 7.8. inuse_transactions + 7.9. active_transactions + 7.10. rpl_received + 7.11. rpl_absorbed + 7.12. rpl_relayed + 7.13. rpl_generated + 7.14. rpl_sent List of Examples @@ -130,17 +133,20 @@ Chapter 1. Admin Guide 7. Statistics - 7.1. received_replies - 7.2. relayed_replies - 7.3. local_replies - 7.4. UAS_transactions - 7.5. UAC_transactions - 7.6. 2xx_transactions - 7.7. 3xx_transactions - 7.8. 4xx_transactions - 7.9. 5xx_transactions - 7.10. 6xx_transactions - 7.11. inuse_transactions + 7.1. UAS_transactions + 7.2. UAC_transactions + 7.3. 2xx_transactions + 7.4. 3xx_transactions + 7.5. 4xx_transactions + 7.6. 5xx_transactions + 7.7. 6xx_transactions + 7.8. inuse_transactions + 7.9. active_transactions + 7.10. rpl_received + 7.11. rpl_absorbed + 7.12. rpl_relayed + 7.13. rpl_generated + 7.14. rpl_sent 1. Overview @@ -169,7 +175,7 @@ Chapter 1. Admin Guide 3.1. precheck_trans -3.1. precheck_trans +3.1. precheck_trans Enable/disable transaction pre-check via t_precheck_trans() function. If set to 0, the internal structures are not created at startup and the @@ -196,7 +202,7 @@ modparam("tmx", "precheck_trans", 0) 4.10. t_reuse_branch() 4.11. t_precheck_trans() -4.1. t_cancel_branches(which) +4.1. t_cancel_branches(which) Cancel branches of an active SIP transaction. The function can be called for a SIP reply that will identify the current branch. @@ -215,7 +221,7 @@ if (t_cancel_branches("all")) { } ... -4.2. t_cancel_callid(callid, cseq, flag [, rcode]) +4.2. t_cancel_callid(callid, cseq, flag [, rcode]) Cancel first INVITE transaction identified by callid and cseq. It sets the flag if the value is greater than zero @@ -240,7 +246,7 @@ if (t_cancel_callid("123qaz", "5", "22", "200")) { } ... -4.3. t_reply_callid(callid, cseq, code, reason) +4.3. t_reply_callid(callid, cseq, code, reason) Send reply to first transaction identified by callid and cseq. @@ -259,7 +265,7 @@ if (t_reply_callid("123qaz", "5", "458", "Replied remotely")) { } ... -4.4. t_flush_flags() +4.4. t_flush_flags() Flush the flags from current SIP message into the already created transaction. It make sense only in routing block if the transaction was @@ -272,7 +278,7 @@ if (t_reply_callid("123qaz", "5", "458", "Replied remotely")) { t_flush_flags(); ... -4.5. t_is_failure_route() +4.5. t_is_failure_route() Returns true if the top-executed route block is failure_route. @@ -289,7 +295,7 @@ route[abc] { } ... -4.6. t_is_branch_route() +4.6. t_is_branch_route() Returns true if the top-executed route block is branch_route. @@ -306,7 +312,7 @@ route[abc] { } ... -4.7. t_is_reply_route() +4.7. t_is_reply_route() Returns true if the top-executed route block is reply_route. @@ -323,7 +329,7 @@ route[abc] { } ... -4.8. t_suspend() +4.8. t_suspend() Suspend the execution of SIP request in a transaction. If transaction was not created yet, it is created by this function. Returns true in @@ -341,7 +347,7 @@ if(t_suspend()) } ... -4.9. t_continue(tindex, tlabel, rtname) +4.9. t_continue(tindex, tlabel, rtname) Continue the execution of the transaction identified by tindex and tlabel with the actions defined in route[rtname]. @@ -361,7 +367,7 @@ if(t_suspend()) t_continue('123', '456', 'MYROUTE'); ... -4.10. t_reuse_branch() +4.10. t_reuse_branch() Creates new "main" branch by making copy of branch-failure branch. Currently the following branch attributes are copied from @@ -380,7 +386,7 @@ event_route [tm:branch-failure:contact] { } ... -4.11. t_precheck_trans() +4.11. t_precheck_trans() Check if current processed message is handled by other process. This function is useful to catch retransmissions before transaction is @@ -426,22 +432,22 @@ event_route [tm:branch-failure:contact] { 6.4. t_reply 6.5. t_reply_callid -6.1. t_uac_dlg +6.1. t_uac_dlg Generates and sends a local SIP request. Parameters: * method - request method * RURI - request SIP URI - * NEXT HOP - next hop SIP URI (OBP); use "." if no value. - * socket - local socket to be used for sending the request; use "." + * NEXT HOP - next hop SIP URI (OBP); use “.” if no value. + * socket - local socket to be used for sending the request; use “.” if no value. * headers - set of additional headers to be added to the request; at - least "From" and "To" headers must be specify) + least “From” and “To” headers must be specify) * body - (optional, may not be present) request body (if present, - requires the "Content-Type" and "Content-length" headers) + requires the “Content-Type” and “Content-length” headers) -6.2. t_uac_cancel +6.2. t_uac_cancel Generates and sends a CANCEL for an existing local SIP request. @@ -449,14 +455,14 @@ event_route [tm:branch-failure:contact] { * callid - callid of the INVITE request to be cancelled. * cseq - cseq of the INVITE request to be cancelled. -6.3. t_hash +6.3. t_hash Gets information about the load of TM internal hash table. Parameters: * none -6.4. t_reply +6.4. t_reply Generates and sends a reply for an existing inbound SIP transaction. @@ -466,11 +472,11 @@ event_route [tm:branch-failure:contact] { * trans_id - transaction identifier (has the hash_entry:label format) * to_tag - To tag to be added to TO header * new_headers - extra headers to be appended to the reply; use a dot - (".") char only if there are no headers; + (“.”) char only if there are no headers; * body - (optional, may not be present) reply body (if present, - requires the "Content-Type" and "Content-length" headers) + requires the “Content-Type” and “Content-length” headers) -6.5. t_reply_callid +6.5. t_reply_callid Generates and sends a reply for an existing inbound SIP transaction. @@ -481,67 +487,82 @@ event_route [tm:branch-failure:contact] { * cseq - SIP CSeq header * to_tag - To tag to be added to TO header * new_headers - extra headers to be appended to the reply; use a dot - (".") char only if there are no headers; + (“.”) char only if there are no headers; * body - (optional, may not be present) reply body (if present, - requires the "Content-Type" and "Content-length" headers) + requires the “Content-Type” and “Content-length” headers) 7. Statistics - 7.1. received_replies - 7.2. relayed_replies - 7.3. local_replies - 7.4. UAS_transactions - 7.5. UAC_transactions - 7.6. 2xx_transactions - 7.7. 3xx_transactions - 7.8. 4xx_transactions - 7.9. 5xx_transactions - 7.10. 6xx_transactions - 7.11. inuse_transactions + 7.1. UAS_transactions + 7.2. UAC_transactions + 7.3. 2xx_transactions + 7.4. 3xx_transactions + 7.5. 4xx_transactions + 7.6. 5xx_transactions + 7.7. 6xx_transactions + 7.8. inuse_transactions + 7.9. active_transactions + 7.10. rpl_received + 7.11. rpl_absorbed + 7.12. rpl_relayed + 7.13. rpl_generated + 7.14. rpl_sent Exported statistics are listed in the next sections. All statistics - except "inuse_transactions" can be reset. + except “inuse_transactions” can be reset. -7.1. received_replies - - Total number of total replies received by TM module. - -7.2. relayed_replies - - Total number of replies received and relayed by TM module. - -7.3. local_replies - - Total number of replies local generated by TM module. - -7.4. UAS_transactions +7.1. UAS_transactions Total number of transactions created by received requests. -7.5. UAC_transactions +7.2. UAC_transactions Total number of transactions created by local generated requests. -7.6. 2xx_transactions +7.3. 2xx_transactions Total number of transactions completed with 2xx replies. -7.7. 3xx_transactions +7.4. 3xx_transactions Total number of transactions completed with 3xx replies. -7.8. 4xx_transactions +7.5. 4xx_transactions Total number of transactions completed with 4xx replies. -7.9. 5xx_transactions +7.6. 5xx_transactions Total number of transactions completed with 5xx replies. -7.10. 6xx_transactions +7.7. 6xx_transactions Total number of transactions completed with 6xx replies. -7.11. inuse_transactions +7.8. inuse_transactions Number of transactions existing in memory at current time. + +7.9. active_transactions + + Number of ongoing transactions at current time. + +7.10. rpl_received + + Total number of replies received by TM module. + +7.11. rpl_absorbed + + Total number of replies received and not relayed by TM module. + +7.12. rpl_relayed + + Total number of replies received and relayed by TM module. + +7.13. rpl_generated + + Total number of replies locally generated and relayed by TM module. + +7.14. rpl_sent + + Total number of replies relayed by TM module.