changeset 2384:144c8e3d6c09

Documented variables support in limit_rate and limit_rate_after.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 15 May 2019 18:42:38 +0300
parents e01b7a3b601d
children e58281e2a93f
files xml/en/docs/http/ngx_http_core_module.xml xml/ru/docs/http/ngx_http_core_module.xml
diffstat 2 files changed, 34 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_core_module.xml	Tue May 21 17:34:03 2019 +0300
+++ b/xml/en/docs/http/ngx_http_core_module.xml	Wed May 15 18:42:38 2019 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_core_module"
         link="/en/docs/http/ngx_http_core_module.html"
         lang="en"
-        rev="81">
+        rev="82">
 
 <section id="directives" name="Directives">
 
@@ -1047,10 +1047,24 @@
 </para>
 
 <para>
-Rate limit can also be set in the <var>$limit_rate</var> variable.
+The value can contain variables (1.17.0).
 It may be useful in cases where rate should be limited
 depending on a certain condition:
 <example>
+map $slow $rate {
+    1     4k;
+    2     8k;
+}
+
+limit_rate $rate;
+</example>
+</para>
+
+<para>
+Rate limit can also be set in the
+<link id="var_limit_rate"><var>$limit_rate</var></link> variable,
+however, since version 1.17.0, this method is not recommended:
+<example>
 server {
 
     if ($slow) {
@@ -1089,6 +1103,7 @@
 <para>
 Sets the initial amount after which the further transmission
 of a response to a client will be rate limited.
+The value can contain variables (1.17.0).
 </para>
 
 <para>
--- a/xml/ru/docs/http/ngx_http_core_module.xml	Tue May 21 17:34:03 2019 +0300
+++ b/xml/ru/docs/http/ngx_http_core_module.xml	Wed May 15 18:42:38 2019 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_core_module"
         link="/ru/docs/http/ngx_http_core_module.html"
         lang="ru"
-        rev="81">
+        rev="82">
 
 <section id="directives" name="Директивы">
 
@@ -1041,10 +1041,24 @@
 </para>
 
 <para>
-Ограничение скорости можно также задать в переменной <var>$limit_rate</var>.
+В значении параметра можно использовать переменные (1.17.0).
 Это может быть полезно в случаях, когда скорость нужно ограничивать
 в зависимости от какого-либо условия:
 <example>
+map $slow $rate {
+    1     4k;
+    2     8k;
+}
+
+limit_rate $rate;
+</example>
+</para>
+
+<para>
+Ограничение скорости можно также задать в переменной
+<link id="var_limit_rate"><var>$limit_rate</var></link>,
+однако начиная с 1.17.0 использовать данный метод не рекомендуется:
+<example>
 server {
 
     if ($slow) {
@@ -1082,6 +1096,7 @@
 <para>
 Задаёт начальный объём данных, после передачи которого начинает
 ограничиваться скорость передачи ответа клиенту.
+В значении параметра можно использовать переменные (1.17.0).
 </para>
 
 <para>