Browse code

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

Kamailio Dev authored on 08/01/2020 20:16:12
Showing 1 changed files
... ...
@@ -26,6 +26,7 @@ Daniel-Constantin Mierla
26 26
         3. Parameters
27 27
 
28 28
               3.1. load (str)
29
+              3.2. xval_mode (int)
29 30
 
30 31
         4. Functions
31 32
 
... ...
@@ -41,7 +42,8 @@ Daniel-Constantin Mierla
41 41
    List of Examples
42 42
 
43 43
    1.1. Set load parameter
44
-   1.2. jsdt_run usage
44
+   1.2. Set xval_mode parameter
45
+   1.3. jsdt_run usage
45 46
 
46 47
 Chapter 1. Admin Guide
47 48
 
... ...
@@ -56,6 +58,7 @@ Chapter 1. Admin Guide
56 56
    3. Parameters
57 57
 
58 58
         3.1. load (str)
59
+        3.2. xval_mode (int)
59 60
 
60 61
    4. Functions
61 62
 
... ...
@@ -101,6 +104,7 @@ Chapter 1. Admin Guide
101 101
 3. Parameters
102 102
 
103 103
    3.1. load (str)
104
+   3.2. xval_mode (int)
104 105
 
105 106
 3.1. load (str)
106 107
 
... ...
@@ -116,6 +120,27 @@ Chapter 1. Admin Guide
116 116
 modparam("app_ruby", "load", "/usr/local/etc/kamailio/ruby/myscript.rb")
117 117
 ...
118 118
 
119
+3.2. xval_mode (int)
120
+
121
+   Control if the external sub-module functions returning extended-values
122
+   should propagate their string return value (when set to 0) or be
123
+   replaced by NULL/nil (when set to 1).
124
+
125
+   When set to 0, the KSR::PV Ruby submodule is implemented with the
126
+   internal functions from the app_ruby module, otherwise the ones from
127
+   core are used.
128
+
129
+   Note: when set to 1, there were crashing reports that are under
130
+   investigation, this option being provided as intermediary solution to
131
+   preserve the behaviour from older versions.
132
+
133
+   Default value is “0”.
134
+
135
+   Example 1.2. Set xval_mode parameter
136
+...
137
+modparam("app_ruby", "xval_mode", 1)
138
+...
139
+
119 140
 4. Functions
120 141
 
121 142
    4.1. ruby_run(function, params)
... ...
@@ -127,7 +152,7 @@ modparam("app_ruby", "load", "/usr/local/etc/kamailio/ruby/myscript.rb")
127 127
    loaded at startup via parameter 'load'. Parameters can be strings with
128 128
    pseudo-variables that are evaluated at runtime.
129 129
 
130
-   Example 1.2. jsdt_run usage
130
+   Example 1.3. jsdt_run usage
131 131
 ...
132 132
 if(!ruby_run("rb_append_fu_to_reply"))
133 133
 {