Browse Source

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

Kamailio Dev 7 years ago
parent
commit
6ab88720bf
1 changed files with 24 additions and 16 deletions
  1. 24 16
      src/modules/app_python/README

+ 24 - 16
src/modules/app_python/README

@@ -21,9 +21,10 @@ Maxim Sobolev
 
 
         3. Parameters
         3. Parameters
 
 
-              3.1. script_name (string)
-              3.2. mod_init_function (string)
-              3.3. child_init_method (string)
+              3.1. load (string)
+              3.2. script_name (string)
+              3.3. mod_init_function (string)
+              3.4. child_init_method (string)
 
 
         4. Functions
         4. Functions
 
 
@@ -31,7 +32,7 @@ Maxim Sobolev
 
 
    List of Examples
    List of Examples
 
 
-   1.1. Set script_name parameter
+   1.1. Set load parameter
    1.2. Set mod_init_function parameter
    1.2. Set mod_init_function parameter
    1.3. Set child_init_method parameter
    1.3. Set child_init_method parameter
    1.4. python_exec usage
    1.4. python_exec usage
@@ -48,9 +49,10 @@ Chapter 1. Admin Guide
 
 
    3. Parameters
    3. Parameters
 
 
-        3.1. script_name (string)
-        3.2. mod_init_function (string)
-        3.3. child_init_method (string)
+        3.1. load (string)
+        3.2. script_name (string)
+        3.3. mod_init_function (string)
+        3.4. child_init_method (string)
 
 
    4. Functions
    4. Functions
 
 
@@ -83,23 +85,29 @@ Chapter 1. Admin Guide
 
 
 3. Parameters
 3. Parameters
 
 
-   3.1. script_name (string)
-   3.2. mod_init_function (string)
-   3.3. child_init_method (string)
+   3.1. load (string)
+   3.2. script_name (string)
+   3.3. mod_init_function (string)
+   3.4. child_init_method (string)
 
 
-3.1. script_name (string)
+3.1. load (string)
 
 
-   The path to the fiel with Python code to be executed from configuration
+   The path to the file with Python code to be executed from configuration
    file.
    file.
 
 
    Default value is “/usr/local/etc/kamailio/handler.py”.
    Default value is “/usr/local/etc/kamailio/handler.py”.
 
 
-   Example 1.1. Set script_name parameter
+   Example 1.1. Set load parameter
 ...
 ...
-modparam("app_python", "script_name", "/usr/local/etc/kamailio/myscript.py")
+modparam("app_python", "load", "/usr/local/etc/kamailio/myscript.py")
 ...
 ...
 
 
-3.2. mod_init_function (string)
+3.2. script_name (string)
+
+   This is same as "load" parameter, kept for backward compatibility with
+   the older versions of the module.
+
+3.3. mod_init_function (string)
 
 
    The Python function to be executed by this module when it is initialied
    The Python function to be executed by this module when it is initialied
    by Kamailio.
    by Kamailio.
@@ -111,7 +119,7 @@ modparam("app_python", "script_name", "/usr/local/etc/kamailio/myscript.py")
 modparam("app_python", "mod_init_function", "my_mod_init")
 modparam("app_python", "mod_init_function", "my_mod_init")
 ...
 ...
 
 
-3.3. child_init_method (string)
+3.4. child_init_method (string)
 
 
    The Python function to be executed by this module when a new worker
    The Python function to be executed by this module when a new worker
    process (child) is initialied by Kamailio.
    process (child) is initialied by Kamailio.