瀏覽代碼

docs for some core functions

Daniel-Constantin Mierla 7 年之前
父節點
當前提交
afd4cfdee2
共有 1 個文件被更改,包括 36 次插入2 次删除
  1. 36 2
      kamailio-kemi-framework/docs/core.md

+ 36 - 2
kamailio-kemi-framework/docs/core.md

@@ -19,6 +19,8 @@ Exported functions from core directly to KSR module or KSR.hdr submodule are lis
 
 `bool add_local_rport()`
 
+Set the internal flag to add rport parameter to local generated Via header.
+
 ### KSR.add_tcp_alias() ###
 
 `add_tcp_alias(int port)`
@@ -43,6 +45,9 @@ Write a log message to ERROR level.
 
 `bool force_rport()`
 
+Add rport parameter to the top Via of the incoming request and sent the
+SIP response to source port.
+
 ### void KSR.info(...) ###
 
 `void KSR.info("msg")`
@@ -53,6 +58,15 @@ Write a log message to INFO level.
 
 `bool is_method(str "vmethod")`
 
+Return true if the value of the parameter matches the method type of the SIP
+message.
+
+```JavaScript
+if(KSR.is_method("INVITE")) {
+  ...
+}
+```
+
 ### KSR.is_method_in() ###
 
 `bool is_method_in(str "vmethod")`
@@ -76,7 +90,7 @@ Matching the method is done based on corresponding characters:
 
 Example:
 
-```
+```Lua
 if KSR.is_method_in("IABC") then
   -- the method is INVITE, ACK, BYE or CANCEL
   ...
@@ -87,6 +101,14 @@ end
 
 `bool is_INVITE()`
 
+Return true if the method type of the SIP message is `INVITE`.
+
+```Lua
+if KSR.is_INVITE() then
+  ...
+end
+```
+
 ### KSR.is_ACK() ###
 
 `bool is_ACK()`
@@ -139,18 +161,30 @@ end
 
 `bool KSR.is_myself("uri")`
 
+Return true of the URI address provided as parameter matches a local socket (IP)
+or local domain.
+
 ### KSR.is_myself_furi() ###
 
-`bool is_myself_furi()` </a>
+`bool is_myself_furi()`
+
+Return true if the URI in From header matches a local socket (IP) or local
+domain.
 
 ### KSR.is_myself_ruri() ###
 
 `bool is_myself_ruri()`
 
+Return true if the R-URI matches a local socket (IP) or local
+domain.
+
 ### KSR.is_myself_turi() ###
 
 `bool is_myself_turi()`
 
+Return true if the URI in To header matches a local socket (IP) or local
+domain.
+
 ### void KSR.log(...) ###
 
 `void KSR.log("level", "msg")`