Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_mqtt_filter_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 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="Module ngx_stream_mqtt_filter_module"
10 link="/en/docs/http/ngx_stream_mqtt_filter_module.html"
11 lang="en"
12 rev="1">
13
14 <section id="summary">
15
16 <para>
17 The <literal>ngx_stream_mqtt_filter_module</literal> module (1.23.4) provides
18 support for Message Queuing Telemetry Transport protocol (MQTT) versions
19 <link url="https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html">3.1.1</link>
20 and
21 <link url="https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html">5.0</link>.
22 </para>
23
24 <para>
25 <note>
26 This module is available as part of our
27 <commercial_version>commercial subscription</commercial_version>.
28 </note>
29 </para>
30
31 </section>
32
33
34 <section id="example" name="Example Configuration">
35
36 <para>
37 <example>
38 listen 127.0.0.1:18883;
39 proxy_pass backend;
40 proxy_buffer_size 16k;
41
42 mqtt on;
43 mqtt_set_connect clientid "$client";
44 mqtt_set_connect username "$name";
45 </example>
46 </para>
47
48 </section>
49
50
51 <section id="directives" name="Directives">
52
53 <directive name="mqtt">
54 <syntax><literal>on</literal> | <literal>off</literal></syntax>
55 <default>off</default>
56 <context>stream</context>
57 <context>server</context>
58
59 <para>
60 Enables the MQTT protocol for the given virtual server.
61 </para>
62
63 </directive>
64
65 <directive name="mqtt_rewrite_buffer_size">
66 <syntax><value>size</value></syntax>
67 <default>4k|8k</default>
68 <context>server</context>
69
70 <para>
71 Sets the <value>size</value> of the buffer
72 used for writing a modified message.
73 By default, the buffer size is equal to one memory page.
74 This is either 4K or 8K, depending on a platform.
75 It can be made smaller, however.
76 </para>
77
78 </directive>
79
80 <directive name="mqtt_set_connect">
81 <syntax><literal>field</literal> <value>value</value></syntax>
82 <default/>
83 <context>server</context>
84
85 <para>
86 Sets the message <literal>field</literal>
87 to the given <literal>value</literal> for CONNECT message.
88 The following fields are supported:
89 <literal>clientid</literal>,
90 <literal>username</literal>, and
91 <literal>password</literal>.
92 The value can contain text, variables, and their combination.
93 </para>
94
95 <para>
96 Several <literal>mqtt_set_connect</literal> directives
97 can be specified on the same level:
98 <example>
99 mqtt_set_connect clientid "$client";
100 mqtt_set_connect username "$name";
101 </example>
102 </para>
103
104 </directive>
105
106 </section>
107
108 </module>