[sr-dev] git:master: sl Minor README updates (file name changes)
Olle E. Johansson
oej at edvina.net
Thu Dec 20 21:00:27 CET 2012
Module: sip-router
Branch: master
Commit: 7f532c2994a824c33c2e9e2348a10df734c1d3a7
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=7f532c2994a824c33c2e9e2348a10df734c1d3a7
Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date: Thu Dec 20 20:59:59 2012 +0100
sl Minor README updates (file name changes)
---
modules/sl/README | 154 ++++++++++----------
modules/sl/doc/sl.xml | 16 +-
modules/sl/doc/{functions.xml => sl_functions.xml} | 0
modules/sl/doc/{params.xml => sl_params.xml} | 0
modules/sl/doc/{stats.xml => sl_stats.xml} | 0
5 files changed, 86 insertions(+), 84 deletions(-)
diff --git a/modules/sl/README b/modules/sl/README
index 03f8d26..9d5b29c 100644
--- a/modules/sl/README
+++ b/modules/sl/README
@@ -1,4 +1,4 @@
-1. SL Module
+The SL Module - Statless request handling
Bogdan Iancu
@@ -11,47 +11,16 @@ Daniel-Constantin Mierla
Copyright © 2003 FhG FOKUS
__________________________________________________________________
- 1.1. Overview
- 1.2. Parameters
-
- 1.2.1. default_code (int)
- 1.2.2. default_reason (str)
- 1.2.3. bind_tm (int)
-
- 1.3. Functions
-
- 1.3.1. sl_send_reply(code, reason)
- 1.3.2. send_reply(code, reason)
- 1.3.3. sl_reply_error()
-
- 1.4. Statistics
-
- 1.4.1. 1xx_replies
- 1.4.2. 200_replies
- 1.4.3. 202_replies
- 1.4.4. 2xx_replies
- 1.4.5. 300_replies
- 1.4.6. 301_replies
- 1.4.7. 302_replies
- 1.4.8. 3xx_replies
- 1.4.9. 400_replies
- 1.4.10. 401_replies
- 1.4.11. 403_replies
- 1.4.12. 404_replies
- 1.4.13. 407_replies
- 1.4.14. 408_replies
- 1.4.15. 483_replies
- 1.4.16. 4xx_replies
- 1.4.17. 500_replies
- 1.4.18. 5xx_replies
- 1.4.19. 6xx_replies
- 1.4.20. xxx_replies
- 1.4.21. sent_replies
- 1.4.22. sent_err_replies
- 1.4.23. failures
- 1.4.24. received_ACKs
-
-1.1. Overview
+ List of Examples
+
+ 1. default_code example
+ 2. default_reason example
+ 3. bind_tm example
+ 4. sl_send_reply usage
+ 5. send_reply usage
+ 6. sl_reply_error usage
+
+1. Overview
The SL module allows the SIP server to act as a stateless UA server and
generate replies to SIP requests without keeping state. That is
@@ -78,9 +47,13 @@ Daniel-Constantin Mierla
be mirrored in ACK. SER will not see its signature and forward the ACK
downstream. Caused harm is not bad--just a useless ACK is forwarded.
-1.2. Parameters
+2. Parameters
+
+ 2.1. default_code (int)
+ 2.2. default_reason (str)
+ 2.3. bind_tm (int)
-1.2.1. default_code (int)
+2.1. default_code (int)
Default reply status code.
@@ -91,7 +64,7 @@ Daniel-Constantin Mierla
modparam("sl", "default_code", 505)
...
-1.2.2. default_reason (str)
+2.2. default_reason (str)
Default reply reason phrase.
@@ -102,7 +75,7 @@ modparam("sl", "default_code", 505)
modparam("sl", "default_reason", "Server Error")
...
-1.2.3. bind_tm (int)
+2.3. bind_tm (int)
Controls if SL module should attempt to bind to TM module in order to
send stateful reply when the transaction is created.
@@ -114,9 +87,13 @@ modparam("sl", "default_reason", "Server Error")
modparam("sl", "bind_tm", 0) # feature disabled
...
-1.3. Functions
+3. Functions
-1.3.1. sl_send_reply(code, reason)
+ 3.1. sl_send_reply(code, reason)
+ 3.2. send_reply(code, reason)
+ 3.3. sl_reply_error()
+
+3.1. sl_send_reply(code, reason)
For the current request, a reply is sent back having the given code and
text reason. The reply is sent stateless, totally independent of the
@@ -131,7 +108,7 @@ modparam("sl", "bind_tm", 0) # feature disabled
sl_send_reply("404", "Not found");
...
-1.3.2. send_reply(code, reason)
+3.2. send_reply(code, reason)
For the current request, a reply is sent back having the given code and
text reason. The reply is sent stateful or stateless, depending of the
@@ -152,7 +129,7 @@ send_reply("404", "Not found");
send_reply("403", "Invalid user - $fU");
...
-1.3.3. sl_reply_error()
+3.3. sl_reply_error()
Sends back an error reply describing the nature of the last internal
error. Usually this function should be used after a script function
@@ -163,100 +140,125 @@ send_reply("403", "Invalid user - $fU");
sl_reply_error();
...
-1.4. Statistics
-
-1.4.1. 1xx_replies
+4. Statistics
+
+ 4.1. 1xx_replies
+ 4.2. 200_replies
+ 4.3. 202_replies
+ 4.4. 2xx_replies
+ 4.5. 300_replies
+ 4.6. 301_replies
+ 4.7. 302_replies
+ 4.8. 3xx_replies
+ 4.9. 400_replies
+ 4.10. 401_replies
+ 4.11. 403_replies
+ 4.12. 404_replies
+ 4.13. 407_replies
+ 4.14. 408_replies
+ 4.15. 483_replies
+ 4.16. 4xx_replies
+ 4.17. 500_replies
+ 4.18. 5xx_replies
+ 4.19. 6xx_replies
+ 4.20. xxx_replies
+ 4.21. sent_replies
+ 4.22. sent_err_replies
+ 4.23. failures
+ 4.24. received_ACKs
+
+4.1. 1xx_replies
Number of 1xx replies.
-1.4.2. 200_replies
+4.2. 200_replies
Number of 201 replies.
-1.4.3. 202_replies
+4.3. 202_replies
Number of 202 replies.
-1.4.4. 2xx_replies
+4.4. 2xx_replies
Number of 2xx replies.
-1.4.5. 300_replies
+4.5. 300_replies
Number of 300 replies.
-1.4.6. 301_replies
+4.6. 301_replies
Number of 301 replies.
-1.4.7. 302_replies
+4.7. 302_replies
Number of 302 replies.
-1.4.8. 3xx_replies
+4.8. 3xx_replies
Number of 3xx replies.
-1.4.9. 400_replies
+4.9. 400_replies
Number of 400 replies.
-1.4.10. 401_replies
+4.10. 401_replies
Number of 401 replies.
-1.4.11. 403_replies
+4.11. 403_replies
Number of 403 replies.
-1.4.12. 404_replies
+4.12. 404_replies
Number of 404 replies.
-1.4.13. 407_replies
+4.13. 407_replies
Number of 407 replies.
-1.4.14. 408_replies
+4.14. 408_replies
Number of 408 replies.
-1.4.15. 483_replies
+4.15. 483_replies
Number of 483 replies.
-1.4.16. 4xx_replies
+4.16. 4xx_replies
Number of 4xx replies.
-1.4.17. 500_replies
+4.17. 500_replies
Number of 500 replies.
-1.4.18. 5xx_replies
+4.18. 5xx_replies
Number of 5xx replies.
-1.4.19. 6xx_replies
+4.19. 6xx_replies
Number of 6xx replies.
-1.4.20. xxx_replies
+4.20. xxx_replies
Number of replies whose code don't match any above.
-1.4.21. sent_replies
+4.21. sent_replies
Number of all sent replies.
-1.4.22. sent_err_replies
+4.22. sent_err_replies
Number of sent error replies.
-1.4.23. failures
+4.23. failures
Number of failures.
-1.4.24. received_ACKs
+4.24. received_ACKs
Number of received ACKs filtered by SL module.
diff --git a/modules/sl/doc/sl.xml b/modules/sl/doc/sl.xml
index 4b5a402..e560858 100644
--- a/modules/sl/doc/sl.xml
+++ b/modules/sl/doc/sl.xml
@@ -2,8 +2,9 @@
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-<section id="sl" xmlns:xi="http://www.w3.org/2001/XInclude">
- <sectioninfo>
+<book id="sl" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <bookinfo>
+ <title>The SL Module - Statless request handling</title>
<authorgroup>
<author>
<firstname>Bogdan</firstname>
@@ -26,9 +27,8 @@
<year>2003</year>
<holder>FhG FOKUS</holder>
</copyright>
- </sectioninfo>
+ </bookinfo>
- <title>SL Module</title>
<section id="sl.overview">
<title>Overview</title>
@@ -66,8 +66,8 @@
</section>
- <xi:include href="params.xml"/>
- <xi:include href="functions.xml"/>
- <xi:include href="stats.xml"/>
+ <xi:include href="sl_params.xml"/>
+ <xi:include href="sl_functions.xml"/>
+ <xi:include href="sl_stats.xml"/>
-</section>
+</book>
diff --git a/modules/sl/doc/functions.xml b/modules/sl/doc/sl_functions.xml
similarity index 100%
rename from modules/sl/doc/functions.xml
rename to modules/sl/doc/sl_functions.xml
diff --git a/modules/sl/doc/params.xml b/modules/sl/doc/sl_params.xml
similarity index 100%
rename from modules/sl/doc/params.xml
rename to modules/sl/doc/sl_params.xml
diff --git a/modules/sl/doc/stats.xml b/modules/sl/doc/sl_stats.xml
similarity index 100%
rename from modules/sl/doc/stats.xml
rename to modules/sl/doc/sl_stats.xml
More information about the sr-dev
mailing list