http\Response

[mdref/mdref-http] / http / Env / Response / setThrottleRate.md

diff --git a/http/Env/Response/setThrottleRate.md b/http/Env/Response/setThrottleRate.md
new file mode 100644 (file)
index 0000000..03b7047
--- /dev/null
+++ b/http/Env/Response/setThrottleRate.md
@@ -0,0 +1,17 @@
+# http\Env\Response http\Env\Response::setThrottleRate(int $chunk_size[, float $delay = 1])
+
+Enable throttling.
+Send $chunk_size bytes every $delay seconds.
+
+> **Note:** If you need throttling by regular means, check for other options in your stack, because this method blocks the executing process/thread until the response has completely been sent.
+
+## Params:
+
+* int $chunk_size  
+  Bytes to send.
+* Optional float $delay = 1  
+  Seconds to sleep.
+
+## Returns:
+
+* http\Env\Response, self.