[sr-dev] git:master:5aad5de6: modules: readme files regenerated - app_ruby ... [skip ci]

Module: kamailio Branch: master Commit: 5aad5de690594449d8b1eaa8137fb858a97f4a07 URL: https://github.com/kamailio/kamailio/commit/5aad5de690594449d8b1eaa8137fb85… Author: Kamailio Dev <kamailio.dev(a)kamailio.org> Committer: Kamailio Dev <kamailio.dev(a)kamailio.org> Date: 2020-01-08T21:16:12+01:00 modules: readme files regenerated - app_ruby ... [skip ci] --- Modified: src/modules/app_ruby/README --- Diff: https://github.com/kamailio/kamailio/commit/5aad5de690594449d8b1eaa8137fb85… Patch: https://github.com/kamailio/kamailio/commit/5aad5de690594449d8b1eaa8137fb85… --- diff --git a/src/modules/app_ruby/README b/src/modules/app_ruby/README index cf1ba153b0..9afc281b7f 100644 --- a/src/modules/app_ruby/README +++ b/src/modules/app_ruby/README @@ -26,6 +26,7 @@ Daniel-Constantin Mierla 3. Parameters 3.1. load (str) + 3.2. xval_mode (int) 4. Functions @@ -41,7 +42,8 @@ Daniel-Constantin Mierla List of Examples 1.1. Set load parameter - 1.2. jsdt_run usage + 1.2. Set xval_mode parameter + 1.3. jsdt_run usage Chapter 1. Admin Guide @@ -56,6 +58,7 @@ Chapter 1. Admin Guide 3. Parameters 3.1. load (str) + 3.2. xval_mode (int) 4. Functions @@ -101,6 +104,7 @@ Chapter 1. Admin Guide 3. Parameters 3.1. load (str) + 3.2. xval_mode (int) 3.1. load (str) @@ -116,6 +120,27 @@ Chapter 1. Admin Guide modparam("app_ruby", "load", "/usr/local/etc/kamailio/ruby/myscript.rb") ... +3.2. xval_mode (int) + + Control if the external sub-module functions returning extended-values + should propagate their string return value (when set to 0) or be + replaced by NULL/nil (when set to 1). + + When set to 0, the KSR::PV Ruby submodule is implemented with the + internal functions from the app_ruby module, otherwise the ones from + core are used. + + Note: when set to 1, there were crashing reports that are under + investigation, this option being provided as intermediary solution to + preserve the behaviour from older versions. + + Default value is “0”. + + Example 1.2. Set xval_mode parameter +... +modparam("app_ruby", "xval_mode", 1) +... + 4. Functions 4.1. ruby_run(function, params) @@ -127,7 +152,7 @@ modparam("app_ruby", "load", "/usr/local/etc/kamailio/ruby/myscript.rb") loaded at startup via parameter 'load'. Parameters can be strings with pseudo-variables that are evaluated at runtime. - Example 1.2. jsdt_run usage + Example 1.3. jsdt_run usage ... if(!ruby_run("rb_append_fu_to_reply")) {