Browse Source

kamailio-kemi-framework: docs for message flags functions

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

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

@@ -227,14 +227,35 @@ If level value is not matched, then "err" log level is used.
 
 
 `bool KSR.setflag(int flag)`
 `bool KSR.setflag(int flag)`
 
 
+Set the SIP message/transaction flag at the index provided by the parameter. The flag parameter
+has to be a number from 0 to 31.
+
+```
+KSR.setflag(10);
+```
+
 ### KSR.resetflag(...) ###
 ### KSR.resetflag(...) ###
 
 
 `bool KSR.resetflag(int flag)`
 `bool KSR.resetflag(int flag)`
 
 
+Reset the SIP message/transaction flag at the index provided by the parameter. The flag parameter
+has to be a number from 0 to 31.
+
+```
+KSR.resetflag(10);
+```
+
 ### KSR.isflagset(...) ###
 ### KSR.isflagset(...) ###
 
 
 `bool KSR.isflagset(int flag)`
 `bool KSR.isflagset(int flag)`
 
 
+Return true if the message/transaction flag at the index provided by the parameter is set
+(the bit has value 1).
+
+```
+if ( KSR.isflagset(10) ) ...
+```
+
 ### KSR.setbflag(...) ###
 ### KSR.setbflag(...) ###
 
 
 `bool KSR.setbflag(int flag)`
 `bool KSR.setbflag(int flag)`