Browse Source

kamailio-kemi-framework: updated core exports

Daniel-Constantin Mierla 7 years ago
parent
commit
4a9f0e86df
1 changed files with 57 additions and 17 deletions
  1. 57 17
      kamailio-kemi-framework/docs/core.md

+ 57 - 17
kamailio-kemi-framework/docs/core.md

@@ -15,6 +15,18 @@ KSR.hdr.remove("Route");
 ```
 ```
 Exported functions from core directly to KSR module or KSR.hdr submodule are listed in the next sections.
 Exported functions from core directly to KSR module or KSR.hdr submodule are listed in the next sections.
 
 
+### KSR.add_local_rport() ###
+
+`bool add_local_rport()`
+
+### KSR.add_tcp_alias() ###
+
+`add_tcp_alias(int port)`
+
+### KSR.add_tcp_alias_via() ###
+
+`int add_tcp_alias_via()`
+
 ### void KSR.dbg(...) ###
 ### void KSR.dbg(...) ###
 
 
 `void KSR.dbg("msg")`
 `void KSR.dbg("msg")`
@@ -27,12 +39,40 @@ Write a log message to DEBUG level.
 
 
 Write a log message to ERROR level.
 Write a log message to ERROR level.
 
 
+### KSR.force_rport() ###
+
+`bool force_rport()`
+
 ### void KSR.info(...) ###
 ### void KSR.info(...) ###
 
 
 `void KSR.info("msg")`
 `void KSR.info("msg")`
 
 
 Write a log message to INFO level.
 Write a log message to INFO level.
 
 
+### KSR.is_method() ###
+
+`bool is_method(str "vmethod")`
+
+### KSR.is_method_in() ###
+
+`bool is_method_in(str "vmethod")`
+
+### KSR.is_myself(...) ###
+
+`bool KSR.is_myself("uri")`
+
+### KSR.is_myself_furi() ###
+
+`bool is_myself_furi()` </a>
+
+### KSR.is_myself_ruri() ###
+
+`bool is_myself_ruri()`
+
+### KSR.is_myself_turi() ###
+
+`bool is_myself_turi()`
+
 ### void KSR.log(...) ###
 ### void KSR.log(...) ###
 
 
 `void KSR.log("level", "msg")`
 `void KSR.log("level", "msg")`
@@ -47,18 +87,6 @@ Write a log message specifying the level value. The level parameter can be:
 
 
 If level value is not matched, then "err" log level is used.
 If level value is not matched, then "err" log level is used.
 
 
-### KSR.set_drop(...) ###
-
-`void KSR.set_drop()`
-
-Set the DROP flag, so at the end of KEMI script execution, the SIP request branch or the SIP response is not forwarded.
-
-Note: it doesn't not stop the execution of KEMI script, see KSR.x.drop().
-
-### KSR.is_myself(...) ###
-
-`bool KSR.is_myself("uri")`
-
 ### KSR.setflag(...) ###
 ### KSR.setflag(...) ###
 
 
 `bool KSR.setflag(flag)`
 `bool KSR.setflag(flag)`
@@ -131,14 +159,26 @@ Note: it doesn't not stop the execution of KEMI script, see KSR.x.drop().
 
 
 `bool KSR.isdsturiset()`
 `bool KSR.isdsturiset()`
 
 
-### KSR.is_method(...) ###
-
-`bool KSR.is_method("methods")`
-
 ### KSR.force_rport(...) ###
 ### KSR.force_rport(...) ###
 
 
 `bool KSR.force_rport()`
 `bool KSR.force_rport()`
 
 
+### KSR.set_drop(...) ###
+
+`void KSR.set_drop()`
+
+Set the DROP flag, so at the end of KEMI script execution, the SIP request branch or the SIP response is not forwarded.
+
+Note: it doesn't not stop the execution of KEMI script, see KSR.x.drop().
+
+### KSR.set_advertised_address() ###
+
+`int set_advertised_address(str "addr")`
+
+### KSR.set_advertised_port() ###
+
+`int set_advertised_port(str "port")`
+
 ### KSR.set_forward_close(...) ###
 ### KSR.set_forward_close(...) ###
 
 
 `bool KSR.set_forward_close()`
 `bool KSR.set_forward_close()`
@@ -189,4 +229,4 @@ Note: it doesn't not stop the execution of KEMI script, see KSR.x.drop().
 
 
 ### KSR.hdr.append_to_reply(...) ###
 ### KSR.hdr.append_to_reply(...) ###
 
 
-`int KSR.hdr.append_to_reply("hdrval")`
+`int KSR.hdr.append_to_reply("hdrval")`