Explorar el Código

modules: readme files regenerated - acc ... [skip ci]

Kamailio Dev hace 8 años
padre
commit
a29312f650
Se han modificado 4 ficheros con 45 adiciones y 10 borrados
  1. 1 1
      src/modules/acc/README
  2. 1 1
      src/modules/dialog/README
  3. 2 2
      src/modules/mtree/README
  4. 41 6
      src/modules/sl/README

+ 1 - 1
src/modules/acc/README

@@ -1392,7 +1392,7 @@ acc_db_request("$var(code) Error: $avp(reason)", "SomeTable");
 
 7.3.  acc_request(comment, table)
 
-   Warapper around acc_log_request and acc_db_request functions, writing
+   Wrapper around acc_log_request and acc_db_request functions, writing
    the accounting record to LOG and DATABASE backends. If “db_url”
    parameter is not set, the acc record is written only to LOG backend.
 

+ 1 - 1
src/modules/dialog/README

@@ -1980,7 +1980,7 @@ kamcmd dlg.bridge_dlg _from_ _to_ _op_
 
 11.1. event_route[dialog:start]
 
-   Executed when 200OK reply for INVITE is processed.
+   Executed when 200 OK reply for INVITE is processed.
 
 11.2. event_route[dialog:end]
 

+ 2 - 2
src/modules/mtree/README

@@ -213,11 +213,11 @@ modparam("mtree", "db_table", "mtrees")
        extract a specific column value).
      * type - the type of tree elements (0 = string, 2 = integer). It is
        valid only when the (tprefix, tvalue) pairs are loaded (not for
-       muti-column values).
+       multi-column values).
      * multi - tells if dbtable can contain more than one tree (0 = one
        tree, 1 = more than one tree identified by tname column). It is
        valid only when the (tprefix, tvalue) pairs are loaded (not for
-       muti-column values).
+       multi-column values).
 
    This parameter can be set many times to add more trees in memory.
 

+ 41 - 6
src/modules/sl/README

@@ -56,6 +56,11 @@ Daniel-Constantin Mierla
               4.23. failures
               4.24. received_ACKs
 
+        5. Event routes
+
+              5.1. sl:filtered-ack
+              5.2. sl:local-response
+
    List of Examples
 
    1.1. default_code example
@@ -111,6 +116,11 @@ Chapter 1. Admin Guide
         4.23. failures
         4.24. received_ACKs
 
+   5. Event routes
+
+        5.1. sl:filtered-ack
+        5.2. sl:local-response
+
 1. Overview
 
    The SL module allows the SIP server to act as a stateless UA server and
@@ -119,12 +129,12 @@ Chapter 1. Admin Guide
    memory and scale well.
 
    The SL module needs to filter ACKs sent after a local stateless reply
-   to an INVITE was generated. To recognize such ACKs, ser adds a special
-   "signature" in to-tags. This signature is sought for in incoming ACKs,
-   and if included, the ACKs are absorbed.
+   to an INVITE was generated. To recognize such ACKs, Kamailio adds a
+   special "signature" in to-tags. This signature is sought for in
+   incoming ACKs, and if included, the ACKs are absorbed.
 
    To speed up the filtering process, the module uses a timeout mechanism.
-   When a reply is sent, a timer us set. As long as the timer is valid,
+   When a reply is sent, a timer is set. As long as the timer is valid,
    the incoming ACK requests will be checked using TO tag value. Once the
    timer expires, all the ACK messages are let through - a long time
    passed till it sent a reply, so it does not expect any ACK that have to
@@ -135,8 +145,9 @@ Chapter 1. Admin Guide
    processing. Particularly, the problem happens when a UA sends an INVITE
    which already has a to-tag in it (e.g., a re-INVITE) and the server
    want to reply to it. Then, it will keep the current to-tag, which will
-   be mirrored in ACK. SER will not see its signature and forward the ACK
-   downstream. Caused harm is not bad--just a useless ACK is forwarded.
+   be mirrored in ACK. Kamailio will not see its signature and forward the
+   ACK downstream. Caused harm is not bad, just a useless ACK is
+   forwarded.
 
 2. Parameters
 
@@ -385,3 +396,27 @@ if(status=="408")
 4.24. received_ACKs
 
    Number of received ACKs filtered by SL module.
+
+5. Event routes
+
+   5.1. sl:filtered-ack
+   5.2. sl:local-response
+
+5.1. sl:filtered-ack
+
+   Executed when ACK to locally generated reply is recognized and
+   absorbed.
+...
+event_route[sl:filtered-ack] {
+    xlog("sl:filtered-ack ACK to local reply absorbed\n");
+}
+...
+
+5.2. sl:local-response
+
+   Executed after sl module reply function has sent local reply.
+...
+event_route[sl:local-response] {
+    xlog("sl:local-response replied locally\n");
+}
+...