[sr-dev] git:4.2: pipelimit: enhanced docs for pl_check() function

[Daniel-Constantin Mierla]

Module: sip-router
Branch: 4.2
Commit: 6d89d2328a375a6660e46a5031d66b16e05d0efb
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=6d89d2328a375a6660e46a5031d66b16e05d0efb

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Fri Oct 17 09:42:13 2014 +0200

pipelimit: enhanced docs for pl_check() function

- documented the algorithm and limit parameters

(cherry picked from commit 24e76b1932fa8c4e1136ad82cb582a97c50244c4)

---

 modules/pipelimit/README |   13 ++++++++++++-
 1 files changed, 12 insertions(+), 1 deletions(-)

diff --git a/modules/pipelimit/README b/modules/pipelimit/README
index 094622b..9f4caf1 100644
--- a/modules/pipelimit/README
+++ b/modules/pipelimit/README
@@ -308,7 +308,11 @@ kamcmd cfg.set_now_string pipelimit reply_reason "Limiting"
      * 2 if pipe has NOP algorithm
 
    Meaning of the parameters is as follows:
-     * name - the pseudovariable holding the pipe name.
+     * name - the string or pseudovariable with the pipe name.
+     * algorithm - the string or pseudovariable with the algorithm. The
+       values can be: taildrop, red, network or feedback - see readme of
+       ratelimit module for details on each algorithm.
+     * limit - the integer or pseudovariable with the limit value.
 
    This function can be used from REQUEST_ROUTE.
 
@@ -347,6 +351,13 @@ with unexpected retcode=$var(check_result)\n");
                 exit;
         }
 ...
+        # perform pipe match for authenticated user
+        $var(limit) = 20;
+        if (!pl_check("$au", "traildrop", "$var(limit)")) {
+                pl_drop();
+                exit;
+        }
+...
 
 4.2. pl_drop([ [min ], max ])