Mercurial > hg > nginx-site
comparison xml/ru/docs/stream/ngx_stream_mqtt_filter_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 | 6e094f915896 |
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_filter_module" | |
10 link="/ru/docs/http/ngx_stream_mqtt_filter_module.html" | |
11 lang="ru" | |
12 rev="1"> | |
13 | |
14 <section id="summary"> | |
15 | |
16 <para> | |
17 Модуль <literal>ngx_stream_mqtt_filter_module</literal> (1.23.4) обеспечивает | |
18 поддержку протокола Message Queuing Telemetry Transport (MQTT) | |
19 версий | |
20 <link url="https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html">3.1.1</link> | |
21 и | |
22 <link url="https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html">5.0</link>. | |
23 </para> | |
24 | |
25 <para> | |
26 <note> | |
27 Модуль доступен как часть | |
28 <commercial_version>коммерческой подписки</commercial_version>. | |
29 </note> | |
30 </para> | |
31 | |
32 </section> | |
33 | |
34 | |
35 <section id="example" name="Пример конфигурации"> | |
36 | |
37 <para> | |
38 <example> | |
39 listen 127.0.0.1:18883; | |
40 proxy_pass backend; | |
41 proxy_buffer_size 16k; | |
42 | |
43 mqtt on; | |
44 mqtt_set_connect clientid "$client"; | |
45 mqtt_set_connect username "$name"; | |
46 </example> | |
47 </para> | |
48 | |
49 </section> | |
50 | |
51 | |
52 <section id="directives" name="Директивы"> | |
53 | |
54 <directive name="mqtt"> | |
55 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
56 <default>off</default> | |
57 <context>stream</context> | |
58 <context>server</context> | |
59 | |
60 <para> | |
61 Включает протокол MQTT для данного виртуального сервера. | |
62 </para> | |
63 | |
64 </directive> | |
65 | |
66 <directive name="mqtt_rewrite_buffer_size"> | |
67 <syntax><value>размер</value></syntax> | |
68 <default>4k|8k</default> | |
69 <context>server</context> | |
70 | |
71 <para> | |
72 Задаёт <value>размер</value> буфера, | |
73 в который будет записываться модифицированное сообщение. | |
74 По умолчанию размер одного буфера равен размеру страницы памяти. | |
75 В зависимости от платформы это или 4K, или 8K, | |
76 однако его можно сделать меньше. | |
77 </para> | |
78 | |
79 </directive> | |
80 | |
81 <directive name="mqtt_set_connect"> | |
82 <syntax><literal>поле</literal> <value>значение</value></syntax> | |
83 <default/> | |
84 <context>server</context> | |
85 | |
86 <para> | |
87 Устанавливает <literal>поле</literal> | |
88 в заданное <literal>значение</literal> для сообщения CONNECT. | |
89 Поддерживаются следующие поля: | |
90 <literal>clientid</literal>, | |
91 <literal>username</literal> и | |
92 <literal>password</literal>. | |
93 В качестве значения можно использовать текст, переменные и их комбинации. | |
94 </para> | |
95 | |
96 <para> | |
97 На одном уровне может быть указано | |
98 несколько директив <literal>mqtt_set_connect</literal>: | |
99 <example> | |
100 mqtt_set_connect clientid "$client"; | |
101 mqtt_set_connect username "$name"; | |
102 </example> | |
103 </para> | |
104 | |
105 </directive> | |
106 | |
107 </section> | |
108 | |
109 </module> |