modules: readme files regenerated - avpops ...

modules/avpops/README

@@ -579,8 +579,11 @@ avp_check("$xavp(op=>foo[*])","fm/$xavp(op=>fm[$var(id)])/g");
           + name = ( avp_name | avp_alias ) ['/'flags]
           + flags = 'g' | 'G' | 'd' | 'D' | 'n' | 'N' | 's' | 'S'
 
-   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
-   BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE.
+   NOTE: if a list of AVPs is copied/moved (flag g|G), then the order of
+   the values is reversed. Copy/move twice in order to get the same order
+   as in original list.
+
+   This function can be used from ANY_ROUTE.
 
    Example 1.19. avp_copy usage
 ...

modules/http_async_client/README

@@ -263,7 +263,7 @@ modparam("http_async_client", "curl_verbose", 1)
 
    Choose the memory manager used by curl:
      * shm: curl will use kamailio's SHM pool and memory manager
-     * sys: curl will use the system memory amd memory manager (malloc,
+     * sys: curl will use the system memory and memory manager (malloc,
        free, ...)
 
    Note: if this module is used in conjunction with another module using

modules/http_client/README

@@ -575,18 +575,18 @@ xlog("L_INFO", "API-server HTTP connection: $avp(route) Result code $var(res)\n"
    Example 1.17. curl_http_query() usage
 ...
 # GET-Request
-http_client_query("http://tutpro.com/index.php?r_uri=$(ru{s.escape.param})&f_uri
-=$(fu{s.escape.param})",
-           "$var(result)")
+http_client_query("http://api.com/index.php?r_uri=$(ru{s.escape.param})&f_uri=$(
+fu{s.escape.param})",
+           "$var(result)");
 switch ($retcode) {
        ...
 }
 ...
 ...
 # POST-Request
-http_client_query("http://tutpro.com/index.php", "r_uri=$(ru{s.escape.param})&f_
-uri=$(fu{s.escape.param})",
-           "$var(result)")
+http_client_query("http://api.com/index.php", "r_uri=$(ru{s.escape.param})&f_uri
+=$(fu{s.escape.param})",
+           "$var(result)");
 switch ($retcode) {
        ...
 }

modules/tcpops/README

@@ -31,6 +31,10 @@ Olle E. Johansson
               3.5. tcp_set_connection_lifetime([conid], lifetime)
               3.6. tcp_enable_closed_event([conid])
 
+        4. Event routes
+
+              4.1. tcp:closed
+
    List of Examples
 
    1.1. Set closed_event parameter
@@ -59,6 +63,10 @@ Chapter 1. Admin Guide
         3.5. tcp_set_connection_lifetime([conid], lifetime)
         3.6. tcp_enable_closed_event([conid])
 
+   4. Event routes
+
+        4.1. tcp:closed
+
 1. Overview
 
    This modules allows Kamailio to control the TCP connection options
@@ -277,3 +285,22 @@ request_route {
 event_route[tcp:closed] {
         xlog("connection $conid was closed");
 }
+
+4. Event routes
+
+   4.1. tcp:closed
+
+4.1.  tcp:closed
+
+   This route is called when a socket is closed by the remote party, or
+   reset, or timeout. The corresponding $conid variable will be available
+   in the event route.
+
+   Whether this route is always called, never, or on a per socket basis is
+   controlled by the closed_event parameter.
+
+...
+event_route[tcp:closed] {
+    xlog("L_INFO", "TCP connection closed ($conid)\n");
+}
+...

modules/tls/README

@@ -191,7 +191,11 @@ Chapter 1. Admin Guide
    This module implements the TLS transport for Kamailio using the OpenSSL
    library (http://www.openssl.org). To enable the Kamailio TLS support
    this module must be loaded and enable_tls=yes core setting must be
-   added to the Kamailio config file
+   added to the Kamailio config file.
+
+   IMPORTANT: tls module must be loaded before any other Kamailio module
+   that uses libssl (OpenSSL library). A safe option is to have tls module
+   loaded first (be in the first "loadmodule" inside Kamailio.cfg).
 
 2. Quick Start
 

modules/uac/README

@@ -836,9 +836,8 @@ event_route[uac:reply] {
 8.6.  uac.reg_refresh
 
    Load one record by l_uuid from database for remote registrations. If
-   the record exists in memory, its authentication password, flags and
-   proxy are updated, otherwise a new record is added. The command has a
-   parameter, which is the value of l_uuid field.
+   the record exists in memory, it will be replaced with the new values
+   loaded from database.
 
    Example 1.33. uac.reg_refresh usage
 ...

modules/utils/README

@@ -243,7 +243,7 @@ modparam("utils", "xcap_table", "pres_xcap")
 # GET-Request
 http_query("http://tutpro.com/index.php?r_uri=$(ru{s.escape.param})&f_uri=$(fu{s
 .escape.param})",
-           "$var(result)")
+           "$var(result)");
 switch ($retcode) {
        ...
 }
@@ -252,7 +252,7 @@ switch ($retcode) {
 # POST-Request
 http_query("http://tutpro.com/index.php", "r_uri=$(ru{s.escape.param})&f_uri=$(f
 u{s.escape.param})",
-           "$var(result)")
+           "$var(result)");
 switch ($retcode) {
        ...
 }
@@ -261,7 +261,7 @@ switch ($retcode) {
 # GET-Request with additional headers and Post-Data.
 http_query("http://tutpro.com/index.php", "{ "alert": "Alert text goes here" }",
  "Content-Type: application/json"
-           "$var(result)")
+           "$var(result)");
 switch ($retcode) {
        ...
 }