Mercurial > hg > nginx-site
comparison xml/ru/docs/stream/ngx_stream_mqtt_preread_module.xml @ 2956:a85e4d126bc7
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="Модуль ngx_stream_mqtt_preread_module" | |
10 link="/ru/docs/http/ngx_stream_mqtt_preread_module.html" | |
11 lang="ru" | |
12 rev="1"> | |
13 | |
14 <section id="summary"> | |
15 | |
16 <para> | |
17 Модуль <literal>ngx_stream_mqtt_preread_module</literal> (1.23.4) позволяет | |
18 извлекать информацию из сообщения CONNECT | |
19 протокола Message Queuing Telemetry Transport (MQTT) | |
20 версий | |
21 <link url="https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html">3.1.1</link> | |
22 и | |
23 <link url="https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html">5.0</link>, | |
24 например имя пользователя или ID клиента. | |
25 </para> | |
26 | |
27 <para> | |
28 <note> | |
29 Модуль доступен как часть | |
30 <commercial_version>коммерческой подписки</commercial_version>. | |
31 </note> | |
32 </para> | |
33 | |
34 </section> | |
35 | |
36 | |
37 <section id="example" name="Пример конфигурации"> | |
38 | |
39 <para> | |
40 <example> | |
41 mqtt_preread on; | |
42 return $mqtt_preread_clientid; | |
43 </example> | |
44 </para> | |
45 | |
46 </section> | |
47 | |
48 | |
49 <section id="directives" name="Директивы"> | |
50 | |
51 <directive name="mqtt_preread"> | |
52 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
53 <default>off</default> | |
54 <context>stream</context> | |
55 <context>server</context> | |
56 | |
57 <para> | |
58 Разрешает извлечение информации из сообщения СONNECT во время фазы | |
59 <link doc="stream_processing.xml" id="preread_phase">предварительного чтения</link>. | |
60 </para> | |
61 | |
62 </directive> | |
63 | |
64 </section> | |
65 | |
66 | |
67 <section id="variables" name="Встроенные переменные"> | |
68 | |
69 <para> | |
70 <list type="tag"> | |
71 | |
72 <tag-name id="var_mqtt_preread_clientid"><var>$mqtt_preread_clientid</var></tag-name> | |
73 <tag-desc> | |
74 значение <literal>clientid</literal> из СONNECT-сообщения | |
75 </tag-desc> | |
76 | |
77 <tag-name id="var_mqtt_preread_username"><var>$mqtt_preread_username</var></tag-name> | |
78 <tag-desc> | |
79 значение <literal>username</literal> из СONNECT-сообщения | |
80 </tag-desc> | |
81 | |
82 </list> | |
83 </para> | |
84 | |
85 </section> | |
86 | |
87 </module> |