new/paho/files/mqttdoc/MQTTClient/html/struct_m_q_t_t_subscribe__options.html - gerrit/www.eclipse.org/paho - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>Paho MQTT C Client Library: 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">Paho MQTT C Client Library
    </div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.8.14 -->
 <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><code>#include &lt;<a class="el" href="_m_q_t_t_subscribe_opts_8h_source.html">MQTTSubscribeOpts.h</a>&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:aa5326df180cb23c59afbcab711a06479"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_subscribe__options.html#aa5326df180cb23c59afbcab711a06479">struct_id</a> [4]</td></tr>
 <tr class="separator:aa5326df180cb23c59afbcab711a06479"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0761a5e5be0383882e42924de8e51f82"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_subscribe__options.html#a0761a5e5be0383882e42924de8e51f82">struct_version</a></td></tr>
 <tr class="separator:a0761a5e5be0383882e42924de8e51f82"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:abbb6a188886c12f305cbe69358515d8b"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_subscribe__options.html#abbb6a188886c12f305cbe69358515d8b">noLocal</a></td></tr>
 <tr class="separator:abbb6a188886c12f305cbe69358515d8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a8ba074ad218224ee4a8ca802c5e36944"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_subscribe__options.html#a8ba074ad218224ee4a8ca802c5e36944">retainAsPublished</a></td></tr>
 <tr class="separator:a8ba074ad218224ee4a8ca802c5e36944"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a11f17b62e40ecdfe107101ae164367a3"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_subscribe__options.html#a11f17b62e40ecdfe107101ae164367a3">retainHandling</a></td></tr>
 <tr class="separator:a11f17b62e40ecdfe107101ae164367a3"><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="aa5326df180cb23c59afbcab711a06479"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#aa5326df180cb23c59afbcab711a06479">&#9670;&nbsp;</a></span>struct_id</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">char struct_id[4]</td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>The eyecatcher for this structure. Must be MQSO. </p>

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

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">int struct_version</td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>The version number of this structure. Must be 0. </p>

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

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">unsigned char noLocal</td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>To not receive our own publications, set to 1. 0 is the original MQTT behaviour - all messages matching the subscription are received. </p>

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

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">unsigned char retainAsPublished</td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>To keep the retain flag as on the original publish message, set to 1. 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="a11f17b62e40ecdfe107101ae164367a3"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a11f17b62e40ecdfe107101ae164367a3">&#9670;&nbsp;</a></span>retainHandling</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">unsigned char retainHandling</td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>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 </p>

 </div>
 </div>
 <hr/>The documentation for this struct was generated from the following file:<ul>
 <li><a class="el" href="_m_q_t_t_subscribe_opts_8h_source.html">MQTTSubscribeOpts.h</a></li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated on Thu Sep 13 2018 13:40:20 for Paho MQTT C Client Library by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.14
 </small></address>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Paho MQTT C Client Library: 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">Paho MQTT C Client Library
	</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.8.14 -->
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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><code>#include <<a class="el" href="_m_q_t_t_subscribe_opts_8h_source.html">MQTTSubscribeOpts.h</a>></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:aa5326df180cb23c59afbcab711a06479"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_subscribe__options.html#aa5326df180cb23c59afbcab711a06479">struct_id</a> [4]</td></tr>
	<tr class="separator:aa5326df180cb23c59afbcab711a06479"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a0761a5e5be0383882e42924de8e51f82"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_subscribe__options.html#a0761a5e5be0383882e42924de8e51f82">struct_version</a></td></tr>
	<tr class="separator:a0761a5e5be0383882e42924de8e51f82"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:abbb6a188886c12f305cbe69358515d8b"><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_subscribe__options.html#abbb6a188886c12f305cbe69358515d8b">noLocal</a></td></tr>
	<tr class="separator:abbb6a188886c12f305cbe69358515d8b"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a8ba074ad218224ee4a8ca802c5e36944"><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_subscribe__options.html#a8ba074ad218224ee4a8ca802c5e36944">retainAsPublished</a></td></tr>
	<tr class="separator:a8ba074ad218224ee4a8ca802c5e36944"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a11f17b62e40ecdfe107101ae164367a3"><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_subscribe__options.html#a11f17b62e40ecdfe107101ae164367a3">retainHandling</a></td></tr>
	<tr class="separator:a11f17b62e40ecdfe107101ae164367a3"><td class="memSeparator" colspan="2"> </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="aa5326df180cb23c59afbcab711a06479"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#aa5326df180cb23c59afbcab711a06479">◆ </a></span>struct_id</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">char struct_id[4]</td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>The eyecatcher for this structure. Must be MQSO. </p>

	</div>
	</div>
	<a id="a0761a5e5be0383882e42924de8e51f82"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a0761a5e5be0383882e42924de8e51f82">◆ </a></span>struct_version</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">int struct_version</td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>The version number of this structure. Must be 0. </p>

	</div>
	</div>
	<a id="abbb6a188886c12f305cbe69358515d8b"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#abbb6a188886c12f305cbe69358515d8b">◆ </a></span>noLocal</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">unsigned char noLocal</td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>To not receive our own publications, set to 1. 0 is the original MQTT behaviour - all messages matching the subscription are received. </p>

	</div>
	</div>
	<a id="a8ba074ad218224ee4a8ca802c5e36944"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a8ba074ad218224ee4a8ca802c5e36944">◆ </a></span>retainAsPublished</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">unsigned char retainAsPublished</td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>To keep the retain flag as on the original publish message, set to 1. 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="a11f17b62e40ecdfe107101ae164367a3"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a11f17b62e40ecdfe107101ae164367a3">◆ </a></span>retainHandling</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">unsigned char retainHandling</td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>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 </p>

	</div>
	</div>
	<hr/>The documentation for this struct was generated from the following file:<ul>
	<li><a class="el" href="_m_q_t_t_subscribe_opts_8h_source.html">MQTTSubscribeOpts.h</a></li>
	</ul>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated on Thu Sep 13 2018 13:40:20 for Paho MQTT C Client Library by  <a href="http://www.doxygen.org/index.html">
	<img class="footer" src="doxygen.png" alt="doxygen"/>
	</a> 1.8.14
	</small></address>
	</body>
	</html>