Mercurial > hg > nginx-site

changeset 1746:4d6ea4d94e20

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented the return module in stream.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 05 Jul 2016 17:58:34 +0300
parents 0dfb7628bfee
children 27bbcdecd12c
files xml/en/GNUmakefile xml/en/docs/index.xml xml/en/docs/stream/ngx_stream_return_module.xml xml/ru/GNUmakefile xml/ru/docs/index.xml xml/ru/docs/stream/ngx_stream_return_module.xml
diffstat 6 files changed, 122 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/GNUmakefile
+++ b/xml/en/GNUmakefile
@@ -99,6 +99,7 @@ REFS =									\
 		stream/ngx_stream_limit_conn_module			\
 		stream/ngx_stream_map_module				\
 		stream/ngx_stream_proxy_module				\
+		stream/ngx_stream_return_module				\
 		stream/ngx_stream_ssl_module				\
 		stream/ngx_stream_upstream_module			\
 
--- a/xml/en/docs/index.xml
+++ b/xml/en/docs/index.xml
@@ -8,7 +8,7 @@
 <article name="nginx documentation"
          link="/en/docs/"
          lang="en"
-         rev="25"
+         rev="26"
          toc="no">
 
 
@@ -507,6 +507,11 @@ ngx_stream_proxy_module</link>
 </listitem>
 
 <listitem>
+<link doc="stream/ngx_stream_return_module.xml">
+ngx_stream_return_module</link>
+</listitem>
+
+<listitem>
 <link doc="stream/ngx_stream_ssl_module.xml">
 ngx_stream_ssl_module</link>
 </listitem>
new file mode 100644
--- /dev/null
+++ b/xml/en/docs/stream/ngx_stream_return_module.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0"?>
+
+<!--
+  Copyright (C) Nginx, Inc.
+  -->
+
+<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
+
+<module name="Module ngx_stream_return_module"
+        link="/en/docs/stream/ngx_stream_return_module.html"
+        lang="en"
+        rev="1">
+
+<section id="summary">
+
+<para>
+The <literal>ngx_stream_return_module</literal> module (1.11.2) allows
+sending a specified value to the client and then closing the connection.
+</para>
+
+</section>
+
+
+<section id="example" name="Example Configuration">
+
+<para>
+<example>
+server {
+    listen 12345;
+    return $time_iso8601;
+}
+</example>
+</para>
+
+</section>
+
+
+<section id="directives" name="Directives">
+
+<directive name="return">
+<syntax><value>value</value></syntax>
+<default/>
+<context>server</context>
+
+<para>
+Specifies a <value>value</value> to send to the client.
+The value can contain text, variables, and their combination.
+</para>
+
+</directive>
+
+</section>
+
+</module>
--- a/xml/ru/GNUmakefile
+++ b/xml/ru/GNUmakefile
@@ -88,6 +88,7 @@ REFS =									\
 		stream/ngx_stream_limit_conn_module			\
 		stream/ngx_stream_map_module				\
 		stream/ngx_stream_proxy_module				\
+		stream/ngx_stream_return_module				\
 		stream/ngx_stream_ssl_module				\
 		stream/ngx_stream_upstream_module			\
 
--- a/xml/ru/docs/index.xml
+++ b/xml/ru/docs/index.xml
@@ -8,7 +8,7 @@
 <article name="nginx: документация"
          link="/ru/docs/"
          lang="ru"
-         rev="25"
+         rev="26"
          toc="no">
 
 
@@ -511,6 +511,11 @@ ngx_stream_proxy_module</link>
 </listitem>
 
 <listitem>
+<link doc="stream/ngx_stream_return_module.xml">
+ngx_stream_return_module</link>
+</listitem>
+
+<listitem>
 <link doc="stream/ngx_stream_ssl_module.xml">
 ngx_stream_ssl_module</link>
 </listitem>
new file mode 100644
--- /dev/null
+++ b/xml/ru/docs/stream/ngx_stream_return_module.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0"?>
+
+<!--
+  Copyright (C) Nginx, Inc.
+  -->
+
+<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
+
+<module name="Модуль ngx_stream_return_module"
+        link="/ru/docs/stream/ngx_stream_return_module.html"
+        lang="ru"
+        rev="1">
+
+<section id="summary">
+
+<para>
+Модуль <literal>ngx_stream_return_module</literal> (1.11.2) позволяет
+отправить заданное значение клиенту и после этого закрыть соединение.
+</para>
+
+</section>
+
+
+<section id="example" name="Пример конфигурации">
+
+<para>
+<example>
+server {
+    listen 12345;
+    return $time_iso8601;
+}
+</example>
+</para>
+
+</section>
+
+
+<section id="directives" name="Директивы">
+
+<directive name="return">
+<syntax><value>значение</value></syntax>
+<default/>
+<context>server</context>
+
+<para>
+Задаёт <value>значение</value>, отправляемое клиенту.
+В качестве значения можно использовать текст, переменные и их комбинации.
+</para>
+
+</directive>
+
+</section>
+
+</module>