changeset 1742:c511b73da3a9

Documented variables in ngx_stream_core_module.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 05 Jul 2016 17:58:34 +0300
parents a99ebc3af3e4
children 3d686cb47c2c
files xml/en/docs/stream/ngx_stream_core_module.xml xml/ru/docs/stream/ngx_stream_core_module.xml
diffstat 2 files changed, 170 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="13">
+        rev="14">
 
 <section id="summary">
 
@@ -360,4 +360,88 @@ The details of setting up hash tables ar
 
 </section>
 
+
+<section id="variables" name="Embedded Variables">
+
+<para>
+The <literal>ngx_stream_core_module</literal> module supports variables
+since 1.11.2.
+<list type="tag">
+
+<tag-name id="var_binary_remote_addr"><var>$binary_remote_addr</var></tag-name>
+<tag-desc>
+client address in a binary form, value’s length is always 4 bytes
+for IPv4 addresses or 16 bytes for IPv6 addresses
+</tag-desc>
+
+<tag-name id="var_bytes_sent"><var>$bytes_sent</var></tag-name>
+<tag-desc>
+number of bytes sent to a client
+</tag-desc>
+
+<tag-name id="var_connection"><var>$connection</var></tag-name>
+<tag-desc>
+connection serial number
+</tag-desc>
+
+<tag-name id="var_hostname"><var>$hostname</var></tag-name>
+<tag-desc>
+host name
+</tag-desc>
+
+<tag-name id="var_msec"><var>$msec</var></tag-name>
+<tag-desc>
+current time in seconds with the milliseconds resolution
+</tag-desc>
+
+<tag-name id="var_nginx_version"><var>$nginx_version</var></tag-name>
+<tag-desc>
+nginx version
+</tag-desc>
+
+<tag-name id="var_pid"><var>$pid</var></tag-name>
+<tag-desc>
+PID of the worker process
+</tag-desc>
+
+<tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name>
+<tag-desc>
+client address
+</tag-desc>
+
+<tag-name id="var_remote_port"><var>$remote_port</var></tag-name>
+<tag-desc>
+client port
+</tag-desc>
+
+<tag-name id="var_server_addr"><var>$server_addr</var></tag-name>
+<tag-desc>
+an address of the server which accepted a connection
+<para>
+Computing a value of this variable usually requires one system call.
+To avoid a system call, the <link id="listen"/> directives
+must specify addresses and use the <literal>bind</literal> parameter.
+</para>
+</tag-desc>
+
+<tag-name id="var_server_port"><var>$server_port</var></tag-name>
+<tag-desc>
+port of the server which accepted a connection
+</tag-desc>
+
+<tag-name id="var_time_iso8601"><var>$time_iso8601</var></tag-name>
+<tag-desc>
+local time in the ISO 8601 standard format
+</tag-desc>
+
+<tag-name id="var_time_local"><var>$time_local</var></tag-name>
+<tag-desc>
+local time in the Common Log Format
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
 </module>
--- 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="13">
+        rev="14">
 
 <section id="summary">
 
@@ -368,4 +368,88 @@ resolver_timeout 5s;
 
 </section>
 
+
+<section id="variables" name="Встроенные переменные">
+
+<para>
+Модуль <literal>ngx_http_core_module</literal> поддерживает переменные
+начиная с версии 1.11.2.
+<list type="tag">
+
+<tag-name id="var_binary_remote_addr"><var>$binary_remote_addr</var></tag-name>
+<tag-desc>
+адрес клиента в бинарном виде, длина значения всегда 4 байта
+для IPv4-адресов или 16 байт для IPv6-адресов
+</tag-desc>
+
+<tag-name id="var_bytes_sent"><var>$bytes_sent</var></tag-name>
+<tag-desc>
+число байт, переданное клиенту
+</tag-desc>
+
+<tag-name id="var_connection"><var>$connection</var></tag-name>
+<tag-desc>
+порядковый номер соединения
+</tag-desc>
+
+<tag-name id="var_hostname"><var>$hostname</var></tag-name>
+<tag-desc>
+имя хоста
+</tag-desc>
+
+<tag-name id="var_msec"><var>$msec</var></tag-name>
+<tag-desc>
+текущее время в секундах с точностью до миллисекунд
+</tag-desc>
+
+<tag-name id="var_nginx_version"><var>$nginx_version</var></tag-name>
+<tag-desc>
+версия nginx
+</tag-desc>
+
+<tag-name id="var_pid"><var>$pid</var></tag-name>
+<tag-desc>
+номер (PID) рабочего процесса
+</tag-desc>
+
+<tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name>
+<tag-desc>
+адрес клиента
+</tag-desc>
+
+<tag-name id="var_remote_port"><var>$remote_port</var></tag-name>
+<tag-desc>
+порт клиента
+</tag-desc>
+
+<tag-name id="var_server_addr"><var>$server_addr</var></tag-name>
+<tag-desc>
+адрес сервера, принявшего соединение
+<para>
+Получение значения этой переменной обычно требует одного системного вызова.
+Чтобы избежать системного вызова, в директивах <link id="listen"/>
+следует указывать адреса и использовать параметр <literal>bind</literal>.
+</para>
+</tag-desc>
+
+<tag-name id="var_server_port"><var>$server_port</var></tag-name>
+<tag-desc>
+порт сервера, принявшего соединение
+</tag-desc>
+
+<tag-name id="var_time_iso8601"><var>$time_iso8601</var></tag-name>
+<tag-desc>
+локальное время в формате по стандарту ISO 8601
+</tag-desc>
+
+<tag-name id="var_time_local"><var>$time_local</var></tag-name>
+<tag-desc>
+локальное время в Common Log Format
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
 </module>