docs: mention mqtt as valid packet type in module docs

emqx · Nov 27, 2024 · adfb96e · adfb96e
1 parent 6d775b0
commit adfb96e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
@@ -1554,7 +1554,7 @@ Z = erlang:crc32_combine(X,Y,iolist_size(Data2)).</code>
               byte is included in the returned packet unless the line
               was truncated according to option <c>line_length</c>.</p>
           </item>
-          <tag><c>asn1 | cdr | sunrm | fcgi | tpkt</c></tag>
+          <tag><c>asn1 | cdr | sunrm | fcgi | tpkt | mqtt</c></tag>
           <item>
             <p>The header is <em>not</em> stripped off.</p>
             <p>The meanings of the packet types are as follows:</p>
@@ -1564,6 +1564,7 @@ Z = erlang:crc32_combine(X,Y,iolist_size(Data2)).</code>
               <tag><c>cdr</c> - CORBA (GIOP 1.1)</tag><item></item>
               <tag><c>fcgi</c> - Fast CGI</tag><item></item>
               <tag><c>tpkt</c> - TPKT format [RFC1006]</tag><item></item>
+              <tag><c>mqtt</c> - MQTT packet [mqtt-v5.0] / [mqtt-v3.1.1]</tag><item></item>
             </taglist>
           </item>
           <tag><c>http | httph | http_bin | httph_bin</c></tag>

diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
@@ -1433,7 +1433,7 @@ setcap cap_sys_admin,cap_sys_ptrace,cap_dac_read_search+epi beam.smp</code>
                   is stripped off on each receive operation.</p>
                 <p>The 4-byte header is limited to 2Gb.</p>
               </item>
-              <tag><c>asn1 | cdr | sunrm | fcgi | tpkt | line</c></tag>
+              <tag><c>asn1 | cdr | sunrm | fcgi | tpkt | mqtt | line</c></tag>
               <item>
                 <p>These packet types only have effect on receiving.
                   When sending a packet, it is the responsibility of
@@ -1450,6 +1450,7 @@ setcap cap_sys_admin,cap_sys_ptrace,cap_dac_read_search+epi beam.smp</code>
 		  <item><c>cdr</c> - CORBA (GIOP 1.1)</item>
 		  <item><c>fcgi</c> - Fast CGI</item>
 		  <item><c>tpkt</c> - TPKT format [RFC1006]</item>
+		  <item><c>mqtt</c> - MQTT packet [mqtt-v5.0] / [mqtt-v3.1.1]</item>
 		  <item><c>line</c> - Line mode, a packet is a line-terminated
 		    with newline, lines longer than the receive buffer are
 		    truncated</item>