Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_mqtt_preread_module.xml @ 2956:a85e4d126bc7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 02 May 2023 11:39:21 +0100
parents
children
comparison
equal deleted inserted replaced
2955:2c4d7151b9a9 2956:a85e4d126bc7
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) Nginx, Inc.
5 -->
6
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8
9 <module name="Module ngx_stream_mqtt_preread_module"
10 link="/en/docs/http/ngx_stream_mqtt_preread_module.html"
11 lang="en"
12 rev="1">
13
14 <section id="summary">
15
16 <para>
17 The <literal>ngx_stream_mqtt_preread_module</literal> module (1.23.4) allows
18 extracting information from the CONNECT message
19 of the Message Queuing Telemetry Transport protocol (MQTT) versions
20 <link url="https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html">3.1.1</link>
21 and
22 <link url="https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html">5.0</link>,
23 for example, a username or a client ID.
24 </para>
25
26 <para>
27 <note>
28 This module is available as part of our
29 <commercial_version>commercial subscription</commercial_version>.
30 </note>
31 </para>
32
33 </section>
34
35
36 <section id="example" name="Example Configuration">
37
38 <para>
39 <example>
40 mqtt_preread on;
41 return $mqtt_preread_clientid;
42 </example>
43 </para>
44
45 </section>
46
47
48 <section id="directives" name="Directives">
49
50 <directive name="mqtt_preread">
51 <syntax><literal>on</literal> | <literal>off</literal></syntax>
52 <default>off</default>
53 <context>stream</context>
54 <context>server</context>
55
56 <para>
57 Enables extracting information from the MQTT CONNECT message at
58 the <link doc="stream_processing.xml" id="preread_phase">preread</link> phase.
59 </para>
60
61 </directive>
62
63 </section>
64
65
66 <section id="variables" name="Embedded Variables">
67
68 <para>
69 <list type="tag">
70
71 <tag-name id="var_mqtt_preread_clientid"><var>$mqtt_preread_clientid</var></tag-name>
72 <tag-desc>
73 the <literal>clientid</literal> value from the CONNECT message
74 </tag-desc>
75
76 <tag-name id="var_mqtt_preread_username"><var>$mqtt_preread_username</var></tag-name>
77 <tag-desc>
78 the <literal>username</literal> value from the CONNECT message
79 </tag-desc>
80
81 </list>
82 </para>
83
84 </section>
85
86 </module>