Browse Source

kamailio-kemi-framework: docs for some of the branch flag management functions

Daniel-Constantin Mierla 7 years ago
parent
commit
ea4d8f1135
1 changed files with 30 additions and 0 deletions
  1. 30 0
      kamailio-kemi-framework/docs/core.md

+ 30 - 0
kamailio-kemi-framework/docs/core.md

@@ -260,18 +260,48 @@ if ( KSR.isflagset(10) ) ...
 
 
 `bool KSR.setbflag(int flag)`
 `bool KSR.setbflag(int flag)`
 
 
+Set the branch flag at the index provided by the parameter. The flag parameter
+has to be a number from 0 to 31.
+
+```
+KSR.setbflag(10);
+```
+
 ### KSR.resetbflag(...) ###
 ### KSR.resetbflag(...) ###
 
 
 `bool KSR.resetbflag(int flag)`
 `bool KSR.resetbflag(int flag)`
 
 
+Reset the branch flag at the index provided by the parameter. The flag parameter
+has to be a number from 0 to 31.
+
+```
+KSR.resetbflag(10);
+```
+
 ### KSR.isbflagset(...) ###
 ### KSR.isbflagset(...) ###
 
 
 `bool KSR.isbflagset(int flag)`
 `bool KSR.isbflagset(int flag)`
 
 
+Return true if the branch flag at the index provided by the parameter is set
+(the bit has value 1).
+
+```
+if ( KSR.isbflagset(10) ) ...
+```
+
 ### KSR.setbiflag(...) ###
 ### KSR.setbiflag(...) ###
 
 
 `bool KSR.setbiflag(int flag, int branch)`
 `bool KSR.setbiflag(int flag, int branch)`
 
 
+Set the flag at the index provided by the first parameter to the branch number
+specified by the second parameter. The flag parameter has to be a number from
+0 to 31. The branch parameter should be between 0 and 12 (a matter of
+`max_branches` global parameter).
+
+```
+KSR.setbiflag(10, 2);
+```
+
 ### KSR.resetbiflag(...) ###
 ### KSR.resetbiflag(...) ###
 
 
 `bool KSR.resetbiflag(int flag, int branch)`
 `bool KSR.resetbiflag(int flag, int branch)`