Prechádzať zdrojové kódy

kamailio-kemi-framework: remark about getter functions returning integer

Daniel-Constantin Mierla 5 rokov pred
rodič
commit
4b66a4dd2a
1 zmenil súbory, kde vykonal 3 pridanie a 1 odobranie
  1. 3 1
      kamailio-kemi-framework/docs/kemi.md

+ 3 - 1
kamailio-kemi-framework/docs/kemi.md

@@ -616,7 +616,9 @@ The return type can be:
     * if greater than 0 - it was a successful processing or equivalent of true in the
     native scripting language;
     * if equal to 0 - stop execution of the routing script (done by a few functions
-    such as KSR.tm.t_check_trans(...))
+    such as `KSR.tm.t_check_trans(...)`)
+    * exceptions to the above rules are the getter functions that return the
+    integer value of some attribute (e.g., `KSR.kx.get_status()`, `KSR.kx.get_timestamp()`)
   * `SR_KEMIP_BOOL` - returned value can be evaluated in the routing script as
   TRUE or FALSE. In the C code it has to return 1 for TRUE or 0 for FALSE.
   * `SR_KEMIP_XVAL` - returned value depends on the context, can be either