changeset 1771:6a30f04a0208

Documented the $status variable in stream.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 06 Sep 2016 15:18:58 +0300
parents ae46e57cecba
children 536dc1885e24
files xml/en/docs/stream/ngx_stream_core_module.xml xml/ru/docs/stream/ngx_stream_core_module.xml
diffstat 2 files changed, 74 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_core_module.xml
+++ b/xml/en/docs/stream/ngx_stream_core_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_core_module"
         link="/en/docs/stream/ngx_stream_core_module.html"
         lang="en"
-        rev="16">
+        rev="17">
 
 <section id="summary">
 
@@ -448,6 +448,42 @@ session duration in seconds with a milli
 (1.11.4);
 </tag-desc>
 
+<tag-name id="var_status"><var>$status</var></tag-name>
+<tag-desc>
+session status (1.11.4), can be one of the following:
+<list type="tag">
+
+<tag-name><literal>200</literal></tag-name>
+<tag-desc>
+session completed successfully
+</tag-desc>
+
+<tag-name><literal>403</literal></tag-name>
+<tag-desc>
+access forbidden, for example, when access is limited for
+<link doc="ngx_stream_access_module.xml">certain client addresses</link>
+</tag-desc>
+
+<tag-name><literal>500</literal></tag-name>
+<tag-desc>
+internal server error
+</tag-desc>
+
+<tag-name><literal>502</literal></tag-name>
+<tag-desc>
+bad gateway, for example,
+if an upstream server could not be selected or reached.
+</tag-desc>
+
+<tag-name><literal>503</literal></tag-name>
+<tag-desc>
+service unavailable, for example, when access is limited by the
+<link doc="ngx_stream_limit_conn_module.xml">number of connections</link>
+</tag-desc>
+
+</list>
+</tag-desc>
+
 <tag-name id="var_time_iso8601"><var>$time_iso8601</var></tag-name>
 <tag-desc>
 local time in the ISO 8601 standard format
--- a/xml/ru/docs/stream/ngx_stream_core_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_core_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_core_module"
         link="/ru/docs/stream/ngx_stream_core_module.html"
         lang="ru"
-        rev="16">
+        rev="17">
 
 <section id="summary">
 
@@ -456,6 +456,42 @@ resolver_timeout 5s;
 (1.11.4);
 </tag-desc>
 
+<tag-name id="var_status"><var>$status</var></tag-name>
+<tag-desc>
+статус сессии (1.11.4), может принимать одно из следующих значений:
+<list type="tag">
+
+<tag-name><literal>200</literal></tag-name>
+<tag-desc>
+сессия завершена успешно
+</tag-desc>
+
+<tag-name><literal>403</literal></tag-name>
+<tag-desc>
+доступ запрещён, например при ограничении доступа для
+<link doc="ngx_stream_access_module.xml">определённых адресов клиентов</link>
+</tag-desc>
+
+<tag-name><literal>500</literal></tag-name>
+<tag-desc>
+внутренняя ошибка сервера
+</tag-desc>
+
+<tag-name><literal>502</literal></tag-name>
+<tag-desc>
+плохой шлюз, например
+если невозможно выбрать сервер группы или сервер недоступен
+</tag-desc>
+
+<tag-name><literal>503</literal></tag-name>
+<tag-desc>
+сервис недоступен, например при ограничении по
+<link doc="ngx_stream_limit_conn_module.xml">числу соединений</link>
+</tag-desc>
+
+</list>
+</tag-desc>
+
 <tag-name id="var_time_iso8601"><var>$time_iso8601</var></tag-name>
 <tag-desc>
 локальное время в формате по стандарту ISO 8601