LiuZe
/
env


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MQTT C Client Libraries Internals: MQTTSubscribe_options Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="pahologo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MQTT C Client Libraries Internals
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">MQTTSubscribe_options Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The MQTT V5 subscribe options, apart from QoS which existed before V5.  
 <a href="structMQTTSubscribe__options.html#details">More...</a></p>

<p><code>#include &lt;MQTTSubscribeOpts.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a2fe9d45e9ee31af976a232584d5a2409"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTSubscribe__options.html#a2fe9d45e9ee31af976a232584d5a2409">struct_id</a> [4]</td></tr>
<tr class="memdesc:a2fe9d45e9ee31af976a232584d5a2409"><td class="mdescLeft">&#160;</td><td class="mdescRight">The eyecatcher for this structure.  <a href="structMQTTSubscribe__options.html#a2fe9d45e9ee31af976a232584d5a2409">More...</a><br /></td></tr>
<tr class="separator:a2fe9d45e9ee31af976a232584d5a2409"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed5f22c185be62363ac36df1d3778c6d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTSubscribe__options.html#aed5f22c185be62363ac36df1d3778c6d">struct_version</a></td></tr>
<tr class="memdesc:aed5f22c185be62363ac36df1d3778c6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The version number of this structure.  <a href="structMQTTSubscribe__options.html#aed5f22c185be62363ac36df1d3778c6d">More...</a><br /></td></tr>
<tr class="separator:aed5f22c185be62363ac36df1d3778c6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52989a1198bc251aad22638e85f2b7b4"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTSubscribe__options.html#a52989a1198bc251aad22638e85f2b7b4">noLocal</a></td></tr>
<tr class="memdesc:a52989a1198bc251aad22638e85f2b7b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">To not receive our own publications, set to 1.  <a href="structMQTTSubscribe__options.html#a52989a1198bc251aad22638e85f2b7b4">More...</a><br /></td></tr>
<tr class="separator:a52989a1198bc251aad22638e85f2b7b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c66f0773c0484dde0e582b4c47d9bf7"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTSubscribe__options.html#a9c66f0773c0484dde0e582b4c47d9bf7">retainAsPublished</a></td></tr>
<tr class="memdesc:a9c66f0773c0484dde0e582b4c47d9bf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">To keep the retain flag as on the original publish message, set to 1.  <a href="structMQTTSubscribe__options.html#a9c66f0773c0484dde0e582b4c47d9bf7">More...</a><br /></td></tr>
<tr class="separator:a9c66f0773c0484dde0e582b4c47d9bf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8375543f39c16e32698226db118076e6"><td class="memItemLeft" align="right" valign="top"><a id="a8375543f39c16e32698226db118076e6"></a>
unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTSubscribe__options.html#a8375543f39c16e32698226db118076e6">retainHandling</a></td></tr>
<tr class="memdesc:a8375543f39c16e32698226db118076e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">0 - send retained messages at the time of the subscribe (original MQTT behaviour) 1 - send retained messages on subscribe only if the subscription is new 2 - do not send retained messages at all <br /></td></tr>
<tr class="separator:a8375543f39c16e32698226db118076e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The MQTT V5 subscribe options, apart from QoS which existed before V5. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a52989a1198bc251aad22638e85f2b7b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52989a1198bc251aad22638e85f2b7b4">&#9670;&nbsp;</a></span>noLocal</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned char MQTTSubscribe_options::noLocal</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>To not receive our own publications, set to 1. </p>
<p>0 is the original MQTT behaviour - all messages matching the subscription are received. </p>

</div>
</div>
<a id="a9c66f0773c0484dde0e582b4c47d9bf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c66f0773c0484dde0e582b4c47d9bf7">&#9670;&nbsp;</a></span>retainAsPublished</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned char MQTTSubscribe_options::retainAsPublished</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>To keep the retain flag as on the original publish message, set to 1. </p>
<p>If 0, defaults to the original MQTT behaviour where the retain flag is only set on publications sent by a broker if in response to a subscribe request. </p>

</div>
</div>
<a id="a2fe9d45e9ee31af976a232584d5a2409"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fe9d45e9ee31af976a232584d5a2409">&#9670;&nbsp;</a></span>struct_id</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char MQTTSubscribe_options::struct_id[4]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The eyecatcher for this structure. </p>
<p>Must be MQSO. </p>

</div>
</div>
<a id="aed5f22c185be62363ac36df1d3778c6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed5f22c185be62363ac36df1d3778c6d">&#9670;&nbsp;</a></span>struct_version</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int MQTTSubscribe_options::struct_version</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The version number of this structure. </p>
<p>Must be 0. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>MQTTSubscribeOpts.h</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 29 2022 11:34:46 for MQTT C Client Libraries Internals by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>