[sr-dev] git:master: modules_k: ratelimit - README file updated to reflect rl_drop() removal

[Ovidiu Sas]

Module: sip-router
Branch: master
Commit: 9ef1e02ac525368577efeabfd650c8c102827e75
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=9ef1e02ac525368577efeabfd650c8c102827e75

Author: Ovidiu Sas <osas at voipembedded.com>
Committer: Ovidiu Sas <osas at voipembedded.com>
Date:   Fri Jul  2 22:38:55 2010 -0400

modules_k: ratelimit - README file updated to reflect rl_drop() removal

---

 modules_k/ratelimit/doc/ratelimit_admin.xml |  122 +++------------------------
 1 files changed, 12 insertions(+), 110 deletions(-)

diff --git a/modules_k/ratelimit/doc/ratelimit_admin.xml b/modules_k/ratelimit/doc/ratelimit_admin.xml
index 438179e..718ebd0 100644
--- a/modules_k/ratelimit/doc/ratelimit_admin.xml
+++ b/modules_k/ratelimit/doc/ratelimit_admin.xml
@@ -43,7 +43,8 @@
 ...
 	if (is_method("INVITE|REGISTER|SUBSCRIBE") {
 		if (!rl_check()) {
-			rl_drop();
+			append_to_reply("Retry-After: 5\r\n");
+			sl_send_reply("503","Limiting");
 			exit;
 		};
 	};
@@ -264,67 +265,6 @@ modparam("ratelimit", "pipe", "4:NETWORK:10000")
 </programlisting>
 		</example>
 	</section>
-	<section>
-		<title><varname>reply_code</varname> (integer)</title>
-		<para>
-		The code of the reply sent by &kamailio; while limiting.
-		</para>
-		<para>
-		<emphasis>
-			Default value is 503.
-		</emphasis>
-
-		</para>
-		<example>
-		<title>Set <varname>reply_code</varname> parameter</title>
-		<programlisting format="linespecific">
-...
-modparam("ratelimit", "reply_code", 505)
-...
-</programlisting>
-		</example>
-		<para>
-		This value cant be modified at runtime using sercmd
-		</para>
-		<example>
-		<title> Set <varname>reply_code</varname> parameter at runtime </title>
-		<programlisting format="linespecific">
-
-sercmd cfg.set_now_int ratelimit reply_code 505
-
-		</programlisting>
-		</example>
-	</section>
-	<section>
-		<title><varname>reply_reason</varname> (string)</title>
-		<para>
-		The reason of the reply sent by &kamailio; while limiting.
-		</para>
-		<para>
-		<emphasis>
-			Default value is "Server Unavailable".
-		</emphasis>
-		</para>
-		<example>
-		<title>Set <varname>reply_reason</varname> parameter</title>
-		<programlisting format="linespecific">
-...
-modparam("ratelimit", "reply_reason", "Limiting")
-...
-</programlisting>
-		</example>
-		<para>
-		This value cant be modified at runtime using sercmd
-		</para>
-		<example>
-		<title> Set <varname>reply_reason</varname> parameter at runtime </title>
-		<programlisting format="linespecific">
-
-sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
-
-		</programlisting>
-		</example>
-	</section>
 	</section>
 	<section>
 	<title>Exported Functions</title>
@@ -360,7 +300,8 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
 ...
 	# perform queue/pipe match for current method
 	if (!rl_check()) {
-		rl_drop();
+		append_to_reply("Retry-After: 5\r\n");
+		sl_send_reply("503","Limiting");
 		exit;
 	};
 ...
@@ -368,7 +309,8 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
 	# set int pvar to 1
 	$var(p) = 1;
 	if (!rl_check("$var(p)")) {
-		rl_drop();
+		append_to_reply("Retry-After: 5\r\n");
+		sl_send_reply("503","Limiting");
 		exit;
 	};
 ...
@@ -376,7 +318,8 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
 	# set str pvar to 1
 	$var(p) = "1";
 	if (!rl_check("$var(p)") {
-		rl_drop(); 
+		append_to_reply("Retry-After: 5\r\n");
+		sl_send_reply("503","Limiting");
 		exit; 
 	};
 ...
@@ -412,62 +355,21 @@ sercmd cfg.set_now_string ratelimit reply_reason "Limiting"
 ...
 	# perform queue/pipe match for current method
 	if (!rl_check_pipe()) {
-		rl_drop();
+		append_to_reply("Retry-After: 5\r\n");
+		sl_send_reply("503","Limiting");
 		exit;
 	};
 ...
 	# use pipe no 1 for the current method
 	if (!rl_check_pipe("1") {
-		rl_drop(); 
+		append_to_reply("Retry-After: 5\r\n");
+		sl_send_reply("503","Limiting");
 		exit; 
 	};
 ...
 </programlisting>
 		</example>
 	</section>
-	<section>
-		<title>
-		<function moreinfo="none">rl_drop([[min ], max])</function>
-		</title>
-		<para>
-		For the current request, a "503 - Server Unavailable" reply is sent back.
-		The reply may or may not have a "Retry-After" header.  If no parameter is given,
-		there will be no "Retry-After" header.  If only the
-		<emphasis>max</emphasis> parameter is given, the
-		reply will contain a "Retry-After: <emphasis>max</emphasis>" header.  If both
-		<emphasis>min</emphasis> and <emphasis>max</emphasis> params are given, the
-		reply will contain a "Retry-After: <emphasis>random</emphasis>" header with
-		<emphasis>random</emphasis> being a random value between the given min and max.
-		</para>
-		<para>Meaning of the parameters is as follows:</para>
-		<itemizedlist>
-			<listitem><para>
-			<emphasis>min</emphasis> - the minimum value of "Retry-After" header.
-			</para>
-			</listitem>
-			<listitem>
-			<para>
-			<emphasis>max</emphasis> - the maximum value of "Retry-After" header.
-			</para>
-			</listitem>
-		</itemizedlist>
-		<para>
-		This function can be used from REQUEST_ROUTE.
-		</para>
-		<example>
-		<title><function>rl_drop</function> usage</title>
-		<programlisting format="linespecific">
-...
-	if (!rl_check()) {
-		# send back a "503 - Server Unavailable"
-		# with a "Retry-After: 5"
-		rl_drop("5");
-		exit;
-	};
-...
-</programlisting>
-		</example>
-	</section>
 	</section>
 
 	<section>