summaryrefslogtreecommitdiffstats
path: root/Godeps/_workspace/src/gopkg.in/throttled/throttled.v1/examples/README.md
diff options
context:
space:
mode:
authorChristopher Speller <crspeller@gmail.com>2015-11-26 09:02:00 -0500
committerChristopher Speller <crspeller@gmail.com>2015-11-26 09:02:00 -0500
commit006fc61ecce1ba3d5c7b7163309467c24edbbc46 (patch)
tree533f5dcd094ebd94d425e64a4261b7b21ec6f3fa /Godeps/_workspace/src/gopkg.in/throttled/throttled.v1/examples/README.md
parentaaced173f8b3020fbbef236d84b070c2c67ee968 (diff)
parent2639452967e66c4840164c36817234d3e7c12ac1 (diff)
downloadchat-006fc61ecce1ba3d5c7b7163309467c24edbbc46.tar.gz
chat-006fc61ecce1ba3d5c7b7163309467c24edbbc46.tar.bz2
chat-006fc61ecce1ba3d5c7b7163309467c24edbbc46.zip
Merge pull request #1505 from mattermost/lib-upgrade
Lib upgrade
Diffstat (limited to 'Godeps/_workspace/src/gopkg.in/throttled/throttled.v1/examples/README.md')
-rw-r--r--Godeps/_workspace/src/gopkg.in/throttled/throttled.v1/examples/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/Godeps/_workspace/src/gopkg.in/throttled/throttled.v1/examples/README.md b/Godeps/_workspace/src/gopkg.in/throttled/throttled.v1/examples/README.md
new file mode 100644
index 000000000..6b12dad20
--- /dev/null
+++ b/Godeps/_workspace/src/gopkg.in/throttled/throttled.v1/examples/README.md
@@ -0,0 +1,12 @@
+# Examples
+
+This directory contains examples for all the throttlers implemented by the throttled package, as well as an example of a custom limiter.
+
+* custom/ : implements a custom limiter that allows requests to path /a on even seconds, and on path /b on odd seconds.
+* interval-many/ : implements a common interval throttler to control two different handlers, one for path /a and another for path /b, so that requests to any one of the handlers go through at the specified interval.
+* interval-vary/ : implements an interval throttler that varies by path, so that requests to each different path goes through at the specified interval.
+* interval/ : implements an interval throttler so that any request goes through at the specified interval, regardless of path or any other criteria.
+* memstats/ : implements a memory-usage throttler that limits access based on current memory statistics.
+* rate-limit/ : implements a rate-limiter throttler that varies by path, so that the number of requests allowed are counted based on the requested path.
+
+Each example app supports a number of command-line flags. Run the example with the -h flag to display usage and defaults.