update README files

Author: bogdan-iancu

modules/b2b_logic/README

@@ -509,14 +509,14 @@ modparam("b2b_logic", "b2bl_early_update", 1)
        simple pass-through of messages from one side to another,
        and no additional scripting or dedicated routes are
        required.
-     * flags (string, optional) - meanings of the flags is as
-       follows:
-          + t[nn] - Call setup timeout. 0 sets timeout to
-            max_duration value. Example: t300.
-          + a - Transparent authentication. In this mode b2b
-            passes your 401 or 407 authentication request to
-            destination server.
-          + p - Preserve To: header.
+     * flags (string, optional) - CSV list of the following flags:
+          + setup-timeout=[nn] - Call setup timeout. 0 sets
+            timeout to max_duration value. Example:
+            "setup-timeout=300".
+          + transparent-auth - Transparent authentication. In this
+            mode b2b passes your 401 or 407 authentication request
+            to destination server.
+          + preserve-to - Preserve To: header.
      * req_route (string, optional) - name of the script route to
        be called when requests belonging to this B2B session are
        received. This parameter will override the global
@@ -634,25 +634,25 @@ b2b_client_new("client1", "sip:[email protected]");
      * provmedia_uri (string, optional) - URI of the provisional
        media server to be connected with the caller while the
        callee answers.
-     * flags (string, optional) - meanings of the flags is as
-       follows:
-          + t[nn] - Maximum duration of the B2B session. If the
-            lifetime expires, the B2BUA will send BYE messages to
-            both ends and delete the record. Example: t300.
-          + n - Enable rfc3515 NOTIFY to inform the agent sending
-            the REFER of the status of the reference.
-          + f - Rollback call to state before bridging in case of
-            transfer failed, don't hangup the call (default
-            behaviour).
-          + h - Put the old entity on hold before bridging it to
-            the new entity.
-          + r - Do not attempt late SDP negociation with the new
-            entity. Start the bridging by first contacting the new
-            entity using the initial SDP received from the old
-            entity. After the new entity answers, send a reINVITE
-            without body to the old entity. Use the current SDP
-            received in this new answer from the old entity to
-            trigger a renegociation with the new entity.
+     * flags (string, optional) - CSV list of the following flags:
+          + max_duration=[nn] - Maximum duration of the B2B
+            session. If the lifetime expires, the B2BUA will send
+            BYE messages to both ends and delete the record.
+            Example: "max_duration=300".
+          + notify - Enable rfc3515 NOTIFY to inform the agent
+            sending the REFER of the status of the reference.
+          + rollback-failed - Rollback call to state before
+            bridging in case of transfer failed, don't hangup the
+            call (default behaviour).
+          + hold - Put the old entity on hold before bridging it
+            to the new entity.
+          + no-late-sdp - Do not attempt late SDP negociation with
+            the new entity. Start the bridging by first contacting
+            the new entity using the initial SDP received from the
+            old entity. After the new entity answers, send a
+            reINVITE without body to the old entity. Use the
+            current SDP received in this new answer from the old
+            entity to trigger a renegociation with the new entity.
 
    This function can be used from the b2b_logic request routes.
 

modules/cfgutils/README

@@ -30,7 +30,7 @@ cfgutils Module
               1.4.10. set_count(var_to_count, ret_var)
               1.4.11. set_select_weight(int_list_var)
               1.4.12. ts_usec_delta(t1_sec, t1_usec, t2_sec,
-                      t2_usec, delta)
+                      t2_usec, [delta_str], [delta_int])
 
               1.4.13. check_time_rec(time_string, [timestamp])
               1.4.14. get_static_lock(key)
@@ -424,18 +424,23 @@ set_count($avp(dids), $var(num_dids));
 $var(next_gw_idx) = set_select_weight($avp(gw_success_rates));
 ...
 
-1.4.12.  ts_usec_delta(t1_sec, t1_usec, t2_sec, t2_usec, delta)
+1.4.12.  ts_usec_delta(t1_sec, t1_usec, t2_sec, t2_usec, [delta_str],
+[delta_int])
 
-   This function returns the difference between two timestamps,
-   specified in seconds and microseconds. The result is returned
-   in the last parameter, expressed in microseconds.
+   This function returns the absolute difference between the two
+   given timestamps. The result is expressed as microseconds and
+   can be returned as either string or integer.
+
+   WARNING: when using delta_int, the function will return error
+   code -1 in case the difference overflows the signed integer
+   holder! (i.e. a diff of ~35 minutes or more)
 
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    FAILURE_ROUTE, BRANCH_ROUTE.
 
    Example 1.18. ts_usec_delta usage
 ...
-ts_usec_delta($var(t1s), 300, 10, $var(t2ms), $var(result));
+ts_usec_delta($var(t1s), 300, 10, $var(t2us), $var(diff_str));
 ...
 
 1.4.13.  check_time_rec(time_string, [timestamp])

modules/clusterer/README

@@ -309,7 +309,7 @@ modparam("clusterer", "db_table", "clusterer")
    state) by any module build on top of clusterer engine, like
    dialog or presence.
 
-   Note that ohter tags may be dynamically learned during runtime
+   Note that other tags may be dynamically learned during runtime
    via clustering communication with other nodes.
 
    The format for this value is “tag_name / cluster_id =

modules/dialog/README

@@ -93,10 +93,10 @@ dialog Module
               1.7.12. unset_dlg_profile(profile,[value])
               1.7.13. is_in_profile(profile,[value])
               1.7.14. get_profile_size(profile,[value],size)
-              1.7.15. set_dlg_flag(idx)
-              1.7.16. test_and_set_dlg_flag(idx, value)
-              1.7.17. reset_dlg_flag(idx)
-              1.7.18. is_dlg_flag_set(idx)
+              1.7.15. set_dlg_flag(flag)
+              1.7.16. test_and_set_dlg_flag(flag, value)
+              1.7.17. reset_dlg_flag(flag)
+              1.7.18. is_dlg_flag_set(flag)
               1.7.19. store_dlg_value(name,val)
               1.7.20. fetch_dlg_value(name,val)
               1.7.21. set_dlg_sharing_tag(tag_name)
@@ -903,9 +903,9 @@ modparam("dialog", "flags_column", "flags_c_name")
 
 1.6.37. profiles_with_value (string)
 
-   List of names for profiles with values. Flags /b or /s allow
-   sharing profiles between OpenSIPS instances using the clusterer
-   module or a CacheDB backend, respectively.
+   List of names (alphanumerical) for profiles with values. Flags
+   /b or /s allow sharing profiles between OpenSIPS instances
+   using the clusterer module or a CacheDB backend, respectively.
 
    Default value is “empty”.
 
@@ -917,9 +917,10 @@ annels/s; codecUsed/b;")
 
 1.6.38. profiles_no_value (string)
 
-   List of names for profiles without values. Flags /b or /s allow
-   sharing profiles between OpenSIPS instances using the clusterer
-   module or a CacheDB backend, respectively.
+   List of names (alphanumerical) for profiles without values.
+   Flags /b or /s allow sharing profiles between OpenSIPS
+   instances using the clusterer module or a CacheDB backend,
+   respectively.
 
    Default value is “empty”.
 
@@ -1462,7 +1463,7 @@ if ( get_dialogs_by_profile("caller",$fU,$avp(dlg_jsons),$avp(dlg_no)) )
 if (load_dialog_ctx("$var(callid)")) {
         xlog("The dialog '$var(callid)' already has a duration "
              "of $DLG_lifetime seconds\n");
-        if (is_in_profile("inbound_call"))
+        if (is_in_profile("inboundCall"))
                 xlog("this dialog is an inbound call\n");
         unload_dialog_ctx();
 }
@@ -1503,7 +1504,7 @@ if (load_dialog_ctx("$var(callid)")) {
 
    Example 1.63. set_dlg_profile usage
 ...
-set_dlg_profile("inbound_call");
+set_dlg_profile("inboundCall");
 set_dlg_profile("caller",$fu);
 ...
 
@@ -1525,7 +1526,7 @@ set_dlg_profile("caller",$fu);
 
    Example 1.64. unset_dlg_profile usage
 ...
-unset_dlg_profile("inbound_call");
+unset_dlg_profile("inboundCall");
 unset_dlg_profile("caller",$fu);
 ...
 
@@ -1553,7 +1554,7 @@ unset_dlg_profile("caller",$fu);
 
    Example 1.65. is_in_profile usage
 ...
-if (is_in_profile("inbound_call")) {
+if (is_in_profile("inboundCall")) {
         log("this request belongs to a inbound call\n");
 }
 ...
@@ -1593,14 +1594,14 @@ get_profile_size("caller", $fu, $var(size));
 xlog("currently, the user $fu has $var(size) active outgoing calls\n");
 ...
 
-1.7.15.  set_dlg_flag(idx)
+1.7.15.  set_dlg_flag(flag)
 
-   Sets the dialog flag index idx to true. The dialog flags are
+   Sets the dialog flag named flag to true. The dialog flags are
    dialog persistent and they can be accessed (set and test) for
    all requests belonging to the dialog.
 
    Parameters:
-     * idx (int) - The flag index can be between 0 and 31.
+     * flag (string, static) - The flag name.
 
    NOTE: the dialog must be created before using this function
    (use create_dialog() function before).
@@ -1610,15 +1611,15 @@ xlog("currently, the user $fu has $var(size) active outgoing calls\n");
 
    Example 1.67. set_dlg_flag usage
 ...
-set_dlg_flag(3);
+set_dlg_flag("MY_DLG_FLAG");
 ...
 
-1.7.16.  test_and_set_dlg_flag(idx, value)
+1.7.16.  test_and_set_dlg_flag(flag, value)
 
-   Atomically checks if the dialog flag index idx is equal to
+   Atomically checks if the dialog flag named flag is equal to
    value. If true, changes the value with the opposite one. This
    operation is done under the dialog lock.
-     * idx (int) - The flag index can be between 0 and 31.
+     * flag (string, static) - The flag name.
      * value (int) - The value should be 0 (false) or 1 (true).
 
    NOTE: the dialog must be created before using this function
@@ -1629,17 +1630,17 @@ set_dlg_flag(3);
 
    Example 1.68. test_and_set_dlg_flag usage
 ...
-test_and_set_dlg_flag(3, 0);
+test_and_set_dlg_flag("MY_DLG_FLAG", 0);
 ...
 
-1.7.17.  reset_dlg_flag(idx)
+1.7.17.  reset_dlg_flag(flag)
 
-   Resets the dialog flag index idx to false. The dialog flags are
-   dialog persistent and they can be accessed (set and test) for
-   all requests belonging to the dialog.
+   Resets the dialog flag named flag to false. The dialog flags
+   are dialog persistent and they can be accessed (set and test)
+   for all requests belonging to the dialog.
 
    Parameters:
-     * idx (int) - The flag index can be between 0 and 31.
+     * flag (string, static) - The flag name.
 
    NOTE: the dialog must be created before using this function
    (use create_dialog() function before).
@@ -1649,17 +1650,17 @@ test_and_set_dlg_flag(3, 0);
 
    Example 1.69. reset_dlg_flag usage
 ...
-reset_dlg_flag(16);
+reset_dlg_flag("MY_DLG_FLAG");
 ...
 
-1.7.18.  is_dlg_flag_set(idx)
+1.7.18.  is_dlg_flag_set(flag)
 
-   Returns true if the dialog flag index idx is set. The dialog
+   Returns true if the dialog flag named flag is set. The dialog
    flags are dialog persistent and they can be accessed (set and
    test) for all requests belonging to the dialog.
 
    Parameters:
-     * idx (int) - The flag index can be between 0 and 31.
+     * flag (string, static) - The flag name.
 
    NOTE: the dialog must be created before using this function
    (use create_dialog() function before).
@@ -1669,8 +1670,8 @@ reset_dlg_flag(16);
 
    Example 1.70. is_dlg_flag_set usage
 ...
-if (is_dlg_flag_set(16)) {
-        xlog("dialog flag 16 is set\n");
+if (is_dlg_flag_set("MY_DLG_FLAG")) {
+        xlog("dialog flag MY_DLG_FLAG is set\n");
 }
 ...
 
@@ -2041,7 +2042,7 @@ GIwZjAzNGM1ZDY
      * value (optional)- string value to toughen the check;
 
    MI FIFO Command Format:
-                opensips-cli -x mi profile_get_size inbound_calls
+                opensips-cli -x mi profile_get_size inboundCalls
 
 1.9.5. profile_list_dlgs
 
@@ -2062,7 +2063,7 @@ GIwZjAzNGM1ZDY
      * value (optional)- string value to toughen the check;
 
    MI FIFO Command Format:
-                opensips-cli -x mi profile_list_dlgs inbound_calls
+                opensips-cli -x mi profile_list_dlgs inboundCalls
 
 1.9.6. profile_get_values
 
@@ -2077,7 +2078,7 @@ GIwZjAzNGM1ZDY
      * profile - name of the profile to list the dialog for.
 
    MI FIFO Command Format:
-                opensips-cli -x mi profile_get_values inbound_calls
+                opensips-cli -x mi profile_get_values inboundCalls
 
 1.9.7. profile_end_dlgs
 
@@ -2094,7 +2095,7 @@ GIwZjAzNGM1ZDY
        only the dialogs with the specified value
 
    MI FIFO Command Format:
-                opensips-cli -x mi profile_end_dlgs inbound_calls
+                opensips-cli -x mi profile_end_dlgs inboundCalls
 
 1.9.8. dlg_db_sync
 
@@ -2286,10 +2287,10 @@ GIwZjAzNGM1ZDY
 
 1.10.4. $DLG_flags
 
-   Returns the dialog flags array (as a single integer value) of
-   the dialog corresponding to the processed sequential request.
-   This PV will be available only for sequential requests, after
-   doing loose_route().
+   Returns the dialog flags (as a list of flag names separted by
+   space) of the dialog corresponding to the processed sequential
+   request. This PV will be available only for sequential
+   requests, after doing loose_route().
 
    NULL will be returned if there is no dialog for the request.
 

modules/dispatcher/README

@@ -1215,10 +1215,15 @@ opensips-cli -x mi ds_list
 
    Parameters:
      * partition (optional) - name of the partition to be
-       reloaded.
+       reloaded. default partition is "default".
+     * inherit_state (optional) : whether inherit old state of the
+       destination , default is y.
+          + “n”: no inherit state
+          + “y”: inherit state
 
    MI FIFO Command Format:
 opensips-cli -x mi ds_reload
+opensips-cli -x mi ds_reload inherit_state=n
 
 1.5.4.  ds_push_script_attrs