Browse Source

kamailio-kemi-framework: bits of enhancements for few core exports

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

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

@@ -39,6 +39,12 @@ Adds the port from the message via as an alias to TCP connection. See `add_tcp_a
 
 
 Write a log message to DEBUG level.
 Write a log message to DEBUG level.
 
 
+Example:
+
+```
+KSR.dbg("message from embedded interpreter\n");
+```
+
 ### void KSR.err(...) ###
 ### void KSR.err(...) ###
 
 
 `void KSR.err(str "msg")`
 `void KSR.err(str "msg")`
@@ -315,10 +321,14 @@ KSR.setbiflag(10, 2);
 
 
 `bool KSR.resetbiflag(int flag, int branch)`
 `bool KSR.resetbiflag(int flag, int branch)`
 
 
+Reset a branch flag.
+
 ### KSR.isbiflagset(...) ###
 ### KSR.isbiflagset(...) ###
 
 
 `bool KSR.isbiflagset(int flag, int branch)`
 `bool KSR.isbiflagset(int flag, int branch)`
 
 
+Test if a branch flag is set.
+
 ### KSR.setsflag(...) ###
 ### KSR.setsflag(...) ###
 
 
 `bool KSR.setsflag(int flag)`
 `bool KSR.setsflag(int flag)`
@@ -335,6 +345,14 @@ KSR.setbiflag(10, 2);
 
 
 `bool KSR.seturi(str "uri")`
 `bool KSR.seturi(str "uri")`
 
 
+Set the request URI (R-URI).
+
+Example:
+
+```
+KSR.seturi("sip:[email protected]");
+```
+
 ### KSR.setuser(...) ###
 ### KSR.setuser(...) ###
 
 
 `bool KSR.setuser(str "user")`
 `bool KSR.setuser(str "user")`