Module: sems
Branch: kubartv/cc_rest
Commit: dcda99c6791a42f7b5f7791fedddb2811b9220ad
URL:    
http://git.sip-router.org/cgi-bin/gitweb.cgi/sems/?a=commit;h=dcda99c6791a42f7b5f7791fedddb2811b9220ad

Author: Václav Kubart <[email protected]>
Committer: Václav Kubart <[email protected]>
Date:   Thu Feb  2 09:38:01 2012 +0100

initial module documentation

---

 apps/sbc/call_control/rest/Readme.cc_rest.txt |   49 ++++++++++++++++++++-----
 1 files changed, 40 insertions(+), 9 deletions(-)

diff --git a/apps/sbc/call_control/rest/Readme.cc_rest.txt 
b/apps/sbc/call_control/rest/Readme.cc_rest.txt
index 43629a7..3427677 100644
--- a/apps/sbc/call_control/rest/Readme.cc_rest.txt
+++ b/apps/sbc/call_control/rest/Readme.cc_rest.txt
@@ -1,9 +1,40 @@
-CCTemplate - call control template module
-
-This is a template to start a call control module. It contains all
-the boilerplate and interface code.
- Just change:
-   - cp -r to new directory (which will be built with default make target)
-   - MOD_NAME in Makefile
-   - rename .cpp, .h files
-   - replace all "CCTemplate" with "MyName" in .cpp/.h
+REST call control module
+========================
+
+This call control module asks HTTP server for replacements of call profile data
+and uses them when processing incoming invite ("start" DI function).
+
+Data are retrieved from URL which is given as call control module parameter
+"url". They are expected in simple text file containing parameters which should
+be replaced formatted like:
+
+    parameter 1 name = parameter 1 value
+    parameter 2 name = parameter 2 value
+    ...
+
+Currently are supported following parameters:
+
+Module parameters
+-----------------
+
+url
+
+    URL from which is data retrieved, usual replacements are done as with other
+    call control module parameters.
+
+
+Example call profile
+--------------------
+
+call_control=rest
+rest_module=cc_rest
+rest_url=http://127.0.0.1/~kubartv/$fU/$rU
+
+Example data file
+-----------------
+
+ruri = sip:[email protected]
+from = sip:[email protected]
+next_hop_ip = 192.168.1.202
+next_hop_port = 5062
+

_______________________________________________
Semsdev mailing list
[email protected]
http://lists.iptel.org/mailman/listinfo/semsdev

Reply via email to