view xml/en/docs/stream/ngx_stream_return_module.xml @ 2846:fdf1464e1977

Moved banner to the external file to make partial rollout possible. An idea is to have several banners and show them with different probability specified by split directive in the nginx.conf
author Sergey Budnevitch <sb@waeme.net>
date Tue, 10 May 2022 18:07:27 +0400
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>