Browse code

app_ruby: docs for xval_mode parameter

Daniel-Constantin Mierla authored on 08/01/2020 20:07:11
Showing 1 changed files
... ...
@@ -85,7 +85,37 @@ modparam("app_ruby", "load", "/usr/local/etc/kamailio/ruby/myscript.rb")
85 85
 </programlisting>
86 86
 	    </example>
87 87
 	</section>
88
-
88
+	<section id="app_ruby.p.xval_mode">
89
+	    <title><varname>xval_mode</varname> (int)</title>
90
+	    <para>
91
+			Control if the external sub-module functions returning extended-values
92
+			should propagate their string return value (when set to 0) or be
93
+			replaced by NULL/nil (when set to 1).
94
+			</para>
95
+			<para>
96
+			When set to 0, the KSR::PV Ruby submodule is implemented with the
97
+			internal functions from the app_ruby module, otherwise the ones from
98
+			core are used.
99
+	    </para>
100
+	    <para>
101
+			Note: when set to 1, there were crashing reports that are under
102
+			investigation, this option being provided as intermediary
103
+			solution to preserve the behaviour from older versions.
104
+	    </para>
105
+	    <para>
106
+		<emphasis>
107
+		    Default value is <quote>0</quote>.
108
+		</emphasis>
109
+	    </para>
110
+	    <example>
111
+		<title>Set <varname>xval_mode</varname> parameter</title>
112
+		<programlisting format="linespecific">
113
+...
114
+modparam("app_ruby", "xval_mode", 1)
115
+...
116
+</programlisting>
117
+	    </example>
118
+	</section>
89 119
 	</section>
90 120
 
91 121
     <section>