Browse Source

tmx: readme regenerated

Daniel-Constantin Mierla 14 years ago
parent
commit
9fb70fab95
1 changed files with 28 additions and 10 deletions
  1. 28 10
      modules_k/tmx/README

+ 28 - 10
modules_k/tmx/README

@@ -40,6 +40,7 @@ Daniel-Constantin Mierla
               5.2. t_uac_cancel
               5.2. t_uac_cancel
               5.3. t_hash
               5.3. t_hash
               5.4. t_reply
               5.4. t_reply
+              5.5. t_reply_callid
 
 
         6. Exported statistics
         6. Exported statistics
 
 
@@ -90,6 +91,7 @@ Chapter 1. Admin Guide
         5.2. t_uac_cancel
         5.2. t_uac_cancel
         5.3. t_hash
         5.3. t_hash
         5.4. t_reply
         5.4. t_reply
+        5.5. t_reply_callid
 
 
    6. Exported statistics
    6. Exported statistics
 
 
@@ -137,7 +139,7 @@ Chapter 1. Admin Guide
    3.5. t_is_failure_route()
    3.5. t_is_failure_route()
    3.6. t_is_branch_route()
    3.6. t_is_branch_route()
 
 
-3.1.  t_cancel_branches(which)
+3.1. t_cancel_branches(which)
 
 
    Cancel branches of an active SIP transaction. The function can be
    Cancel branches of an active SIP transaction. The function can be
    called for a SIP reply that will identify the current branch.
    called for a SIP reply that will identify the current branch.
@@ -156,7 +158,7 @@ if (t_cancel_branches("all")) {
 }
 }
 ...
 ...
 
 
-3.2.  t_cancel_callid(callid, cseq, flag)
+3.2. t_cancel_callid(callid, cseq, flag)
 
 
    Cancel first INVITE transaction identified by callid and cseq. It sets
    Cancel first INVITE transaction identified by callid and cseq. It sets
    the flag if the value is greater than zero
    the flag if the value is greater than zero
@@ -175,7 +177,7 @@ if (t_cancel_callid("123qaz", "5", "22")) {
 }
 }
 ...
 ...
 
 
-3.3.  t_reply_callid(callid, cseq, code, reason)
+3.3. t_reply_callid(callid, cseq, code, reason)
 
 
    Send reply to first INVITE transaction identified by callid and cseq.
    Send reply to first INVITE transaction identified by callid and cseq.
 
 
@@ -194,7 +196,7 @@ if (t_reply_callid("123qaz", "5", "458", "Replied remotely")) {
 }
 }
 ...
 ...
 
 
-3.4.  t_flush_flags()
+3.4. t_flush_flags()
 
 
    Flush the flags from current SIP message into the already created
    Flush the flags from current SIP message into the already created
    transaction. It make sense only in routing block if the transaction was
    transaction. It make sense only in routing block if the transaction was
@@ -207,7 +209,7 @@ if (t_reply_callid("123qaz", "5", "458", "Replied remotely")) {
 t_flush_flags();
 t_flush_flags();
 ...
 ...
 
 
-3.5.  t_is_failure_route()
+3.5. t_is_failure_route()
 
 
    Returns true if the top-executed route block is failure_route.
    Returns true if the top-executed route block is failure_route.
 
 
@@ -224,7 +226,7 @@ route[abc] {
 }
 }
 ...
 ...
 
 
-3.6.  t_is_branch_route()
+3.6. t_is_branch_route()
 
 
    Returns true if the top-executed route block is branch_route.
    Returns true if the top-executed route block is branch_route.
 
 
@@ -257,8 +259,9 @@ route[abc] {
    5.2. t_uac_cancel
    5.2. t_uac_cancel
    5.3. t_hash
    5.3. t_hash
    5.4. t_reply
    5.4. t_reply
+   5.5. t_reply_callid
 
 
-5.1.  t_uac_dlg
+5.1. t_uac_dlg
 
 
    Generates and sends a local SIP request.
    Generates and sends a local SIP request.
 
 
@@ -273,7 +276,7 @@ route[abc] {
      * body - (optional, may not be present) request body (if present,
      * 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)
 
 
-5.2.  t_uac_cancel
+5.2. t_uac_cancel
 
 
    Generates and sends a CANCEL for an existing local SIP request.
    Generates and sends a CANCEL for an existing local SIP request.
 
 
@@ -281,14 +284,14 @@ route[abc] {
      * callid - callid of the INVITE request to be cancelled.
      * callid - callid of the INVITE request to be cancelled.
      * cseq - cseq of the INVITE request to be cancelled.
      * cseq - cseq of the INVITE request to be cancelled.
 
 
-5.3.  t_hash
+5.3. t_hash
 
 
    Gets information about the load of TM internal hash table.
    Gets information about the load of TM internal hash table.
 
 
    Parameters:
    Parameters:
      * none
      * none
 
 
-5.4.  t_reply
+5.4. t_reply
 
 
    Generates and sends a reply for an existing inbound SIP transaction.
    Generates and sends a reply for an existing inbound SIP transaction.
 
 
@@ -302,6 +305,21 @@ route[abc] {
      * body - (optional, may not be present) reply body (if present,
      * 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)
 
 
+5.5. t_reply_callid
+
+   Generates and sends a reply for an existing inbound SIP transaction.
+
+   Parameters:
+     * code - reply code
+     * reason - reason phrase.
+     * callid - SIP Call-ID header
+     * 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;
+     * body - (optional, may not be present) reply body (if present,
+       requires the "Content-Type" and "Content-length" headers)
+
 6. Exported statistics
 6. Exported statistics
 
 
    6.1. received_replies
    6.1. received_replies