view xml/en/docs/stream/ngx_stream_return_module.xml @ 3011:55d49eb065ac

Fixed example in the js_periodic directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 14 Sep 2023 16:38:00 +0100
parents 4d6ea4d94e20
children
line wrap: on
line source

<?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>