modules: acc_radius, db_unixodbc, evapi, misc_radius - regenerated readmes

modules/acc_radius/README

@@ -16,7 +16,7 @@ Daniel-Constantin Mierla
    asipto.com
    <[email protected]>
 
-   Copyright © 2002, 2003 FhG FOKUS
+   Copyright © 2002, 2003 FhG FOKUS
      __________________________________________________________________
 
    Table of Contents
@@ -36,6 +36,7 @@ Daniel-Constantin Mierla
               3.3. radius_missed_flag (integer)
               3.4. service_type (integer)
               3.5. radius_extra (string)
+              3.6. rad_time_mode(integer)
 
         4. Functions
 
@@ -48,7 +49,8 @@ Daniel-Constantin Mierla
    1.3. radius_missed_flag example
    1.4. service_type example
    1.5. radius_extra example
-   1.6. acc_rad_request usage
+   1.6. rad_time_mode example
+   1.7. acc_rad_request usage
 
 Chapter 1. Admin Guide
 
@@ -67,6 +69,7 @@ Chapter 1. Admin Guide
         3.3. radius_missed_flag (integer)
         3.4. service_type (integer)
         3.5. radius_extra (string)
+        3.6. rad_time_mode(integer)
 
    4. Functions
 
@@ -97,8 +100,13 @@ Chapter 1. Admin Guide
 
    The following libraries or applications must be installed before
    running Kamailio with this module loaded:
-     * radiusclient-ng 0.5.0 or higher. See
-       http://developer.berlios.de/projects/radiusclient-ng/.
+     * radiusclient-ng 0.5.0 or higher, freeradius-client
+       https://github.com/FreeRADIUS/freeradius-client/ or radcli
+       http://radcli.github.io/radcli/.
+     * freeradius-client library can be used after setting FREERADIUS
+       variable in source code with 'export FREERADIUS=1' before compile.
+     * radcli library can be used after setting RADCLI variable in source
+       code with 'export RADCLI=1' before compile.
 
 3. Parameters
 
@@ -107,6 +115,7 @@ Chapter 1. Admin Guide
    3.3. radius_missed_flag (integer)
    3.4. service_type (integer)
    3.5. radius_extra (string)
+   3.6. rad_time_mode(integer)
 
 3.1. radius_config (string)
 
@@ -119,7 +128,7 @@ Chapter 1. Admin Guide
    If the parameter is set to empty string, the RADIUS accounting support
    will be disabled (even if compiled).
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
    Example 1.1. radius_config example
 ...
@@ -172,22 +181,41 @@ modparam("acc_radius", "service_type", 16)
 modparam("acc_radius", "radius_extra", "via=$hdr(Via[*]); email=$avp(s:email)")
 ...
 
+3.6. rad_time_mode(integer)
+
+   Radius Event-Timestamp for accounting.
+
+   Values can be:
+     * 0 - (default), format is only unix timestamp for Event-Timestamp
+       (For example: 1445590624)
+     * 1 - format is unix timestamp with microseconds in Addition, it
+       needs to change Event-Timestamp attribute type in dictionary to
+       string both radius server and client (For example:
+       1445590624.377372)
+
+   Default value is 0 (Unix timestamp).
+
+   Example 1.6. rad_time_mode example
+...
+modparam("acc_radius", "rad_time_mode", 1)
+...
+
 4. Functions
 
    4.1. acc_rad_request(comment)
 
-4.1.  acc_rad_request(comment)
+4.1. acc_rad_request(comment)
 
    Like acc_log_request of acc module, acc_rad_request reports on a SIP
    request event. It reports to radius server as configured in
-   “radius_config�.
+   "radius_config".
 
    Meaning of the parameters is as follows:
      * comment - Comment to be appended.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.6. acc_rad_request usage
+   Example 1.7. acc_rad_request usage
 ...
 acc_rad_request("Some comment");
 ...

modules/db_unixodbc/README

@@ -8,7 +8,7 @@ Edited by
 
 Marco Lorrai
 
-   Copyright © 2005, 2006 Marco Lorrai
+   Copyright © 2005, 2006 Marco Lorrai
      __________________________________________________________________
 
    Table of Contents
@@ -26,6 +26,7 @@ Marco Lorrai
               3.1. ping_interval (int)
               3.2. auto_reconnect (int)
               3.3. use_escape_common (int)
+              3.4. replace_query (int)
 
         4. Functions
         5. Installation and Running
@@ -37,9 +38,10 @@ Marco Lorrai
 
    List of Examples
 
-   1.1. Set the “ping_interval� parameter
-   1.2. Set the “auto_reconnect� parameter
-   1.3. Set the “use_escape_common� parameter
+   1.1. Set the "ping_interval" parameter
+   1.2. Set the "auto_reconnect" parameter
+   1.3. Set the "use_escape_common" parameter
+   1.4. Set the "replace_query" parameter
 
 Chapter 1. Admin Guide
 
@@ -56,6 +58,7 @@ Chapter 1. Admin Guide
         3.1. ping_interval (int)
         3.2. auto_reconnect (int)
         3.3. use_escape_common (int)
+        3.4. replace_query (int)
 
    4. Functions
    5. Installation and Running
@@ -96,14 +99,15 @@ Chapter 1. Admin Guide
    3.1. ping_interval (int)
    3.2. auto_reconnect (int)
    3.3. use_escape_common (int)
+   3.4. replace_query (int)
 
 3.1. ping_interval (int)
 
    Sets the ping time interval.
 
-   Default value is “300� seconds.
+   Default value is "300" seconds.
 
-   Example 1.1. Set the “ping_interval� parameter
+   Example 1.1. Set the "ping_interval" parameter
 ...
 modparam("db_unixodbc", "ping_interval", 600)
 ...
@@ -112,9 +116,9 @@ modparam("db_unixodbc", "ping_interval", 600)
 
    Turns on or off the auto_reconnect mode.
 
-   Default value is “1�, this means it is enabled.
+   Default value is "1", this means it is enabled.
 
-   Example 1.2. Set the “auto_reconnect� parameter
+   Example 1.2. Set the "auto_reconnect" parameter
 ...
 modparam("db_unixodbc", "auto_reconnect", 0)
 ...
@@ -130,13 +134,24 @@ modparam("db_unixodbc", "auto_reconnect", 0)
    a value, escape other characters ...). It prevents against SQL
    injection.
 
-   Default value is “0� (0 = disabled; 1 = enabled).
+   Default value is "0" (0 = disabled; 1 = enabled).
 
-   Example 1.3. Set the “use_escape_common� parameter
+   Example 1.3. Set the "use_escape_common" parameter
 ...
 modparam("db_unixodbc", "use_escape_common", 1)
 ...
 
+3.4. replace_query (int)
+
+   Tells if the ODBC replace query is supported by the DB odbc driver.
+
+   Default value is "1" seconds.
+
+   Example 1.4. Set the "replace_query" parameter
+...
+modparam("db_unixodbc", "replace_query", 0)
+...
+
 4. Functions
 
    NONE
@@ -185,6 +200,13 @@ shell>safe_mysqld --user=mysql --socket=/var/lib/mysql/mysql.sock
    The connector search the socket in /var/lib/mysql/mysql.sock and not in
    /tmp/mysql.sock
 
+   REMARK: Oracle ODBC driver doesn't support ODBC query. To disable its
+   usage and replace the replace query by an update or insert query, use
+   the parameter:
+....
+modparam("db_unixodbc", "replace_query", 0)
+....
+
 Chapter 2. Developer Guide
 
    The module implements the Kamailio DB API, in order to be used by other

modules/evapi/README

@@ -35,8 +35,10 @@ Daniel-Constantin Mierla
               4.2. evapi_async_relay(evdata)
               4.3. evapi_multicast(evdata, etag)
               4.4. evapi_async_multicast(evdata, etag)
-              4.5. evapi_close()
-              4.6. evapi_set_tag(tname)
+              4.5. evapi_unicast(evdata, etag)
+              4.6. evapi_async_unicast(evdata, etag)
+              4.7. evapi_close()
+              4.8. evapi_set_tag(tname)
 
         5. Event routes
 
@@ -56,8 +58,10 @@ Daniel-Constantin Mierla
    1.6. evapi_async_relay usage
    1.7. evapi_multicast usage
    1.8. evapi_async_multicast usage
-   1.9. evapi_close usage
-   1.10. evapi_set_tag usage
+   1.9. evapi_unicast usage
+   1.10. evapi_async_unicast usage
+   1.11. evapi_close usage
+   1.12. evapi_set_tag usage
 
 Chapter 1. Admin Guide
 
@@ -81,8 +85,10 @@ Chapter 1. Admin Guide
         4.2. evapi_async_relay(evdata)
         4.3. evapi_multicast(evdata, etag)
         4.4. evapi_async_multicast(evdata, etag)
-        4.5. evapi_close()
-        4.6. evapi_set_tag(tname)
+        4.5. evapi_unicast(evdata, etag)
+        4.6. evapi_async_unicast(evdata, etag)
+        4.7. evapi_close()
+        4.8. evapi_set_tag(tname)
 
    5. Event routes
 
@@ -167,8 +173,10 @@ modparam("evapi", "netstring_format", 0)
    4.2. evapi_async_relay(evdata)
    4.3. evapi_multicast(evdata, etag)
    4.4. evapi_async_multicast(evdata, etag)
-   4.5. evapi_close()
-   4.6. evapi_set_tag(tname)
+   4.5. evapi_unicast(evdata, etag)
+   4.6. evapi_async_unicast(evdata, etag)
+   4.7. evapi_close()
+   4.8. evapi_set_tag(tname)
 
 4.1. evapi_relay(evdata)
 
@@ -230,8 +238,8 @@ evapi_async_relay("{ \"event\": \"suspend\",\n \"data\":"
 
    Example 1.7. evapi_multicast usage
 ...
-evapi_relay("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}", "tagx")
-;
+evapi_multicast("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}", "ta
+gx");
 ...
 
 4.4. evapi_async_multicast(evdata, etag)
@@ -246,13 +254,37 @@ evapi_async_multicast("{ \"event\": \"suspend\",\n \"data\":"
     " { \"index\": \"$T(id_index)\", \"label\": \"$T(id_label)\" }\n}", "tagx");
 ...
 
-4.5. evapi_close()
+4.5. evapi_unicast(evdata, etag)
+
+   Relay the event data given as parameter to the first connection that
+   match the tag provided by etag value. The etag can be a variable. For
+   more see evapi_relay() and evapi_set_tag().
+
+   Example 1.9. evapi_unicast usage
+...
+evapi_unicast("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}", "tagx
+");
+...
+
+4.6. evapi_async_unicast(evdata, etag)
+
+   Async relay the event data given as parameter to the first connection
+   that match the tag provided by etag value. The etag can be a variable.
+   For more see evapi_async_relay() and evapi_set_tag().
+
+   Example 1.10. evapi_async_unicast usage
+...
+evapi_async_unicast("{ \"event\": \"suspend\",\n \"data\":"
+    " { \"index\": \"$T(id_index)\", \"label\": \"$T(id_label)\" }\n}", "tagx");
+...
+
+4.7. evapi_close()
 
    Close evapi current client connection.
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.9. evapi_close usage
+   Example 1.11. evapi_close usage
 ...
 event_route[evapi:connection-new] {
   if($evapi(srcaddr)!="127.0.0.1") {
@@ -262,7 +294,7 @@ event_route[evapi:connection-new] {
 }
 ...
 
-4.6. evapi_set_tag(tname)
+4.8. evapi_set_tag(tname)
 
    Set tag name for current client connection. The parameters has to be a
    string up to 64 characters. It can also be a variable holding such
@@ -270,7 +302,7 @@ event_route[evapi:connection-new] {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.10. evapi_set_tag usage
+   Example 1.12. evapi_set_tag usage
 ...
 event_route[evapi:connection-new] {
   if($evapi(srcaddr)=="127.0.0.1") {

modules/misc_radius/README

@@ -149,9 +149,14 @@ Chapter 1. Admin Guide
 2.2. External Libraries or Applications
 
    The following libraries or applications must be installed before
-   compilling Kamailio with this module loaded:
-     * radiusclient-ng 0.5.6 or higher -- library and development files.
-       See http://developer.berlios.de/projects/radiusclient-ng/.
+   running Kamailio with this module loaded:
+     * radiusclient-ng 0.5.0 or higher, freeradius-client
+       https://github.com/FreeRADIUS/freeradius-client/ or radcli
+       http://radcli.github.io/radcli/.
+     * freeradius-client library can be used after setting FREERADIUS
+       variable in source code with 'export FREERADIUS=1' before compile.
+     * radcli library can be used after setting RADCLI variable in source
+       code with 'export RADCLI=1' before compile.
 
 3. Parameters