new/paho/files/mqttdoc/MQTTAsync/html/struct_m_q_t_t_async__create_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 Asynchronous MQTT C Client Library: MQTTAsync_createOptions 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 Asynchronous 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">MQTTAsync_createOptions Struct Reference</div>  </div>
 </div><!--header-->
 <div class="contents">

 <p><code>#include &lt;<a class="el" href="_m_q_t_t_async_8h_source.html">MQTTAsync.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_async__create_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_async__create_options.html#a0761a5e5be0383882e42924de8e51f82">struct_version</a></td></tr>
 <tr class="separator:a0761a5e5be0383882e42924de8e51f82"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a078cd68d8f896ce7eac0cc83d4486a2c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__create_options.html#a078cd68d8f896ce7eac0cc83d4486a2c">sendWhileDisconnected</a></td></tr>
 <tr class="separator:a078cd68d8f896ce7eac0cc83d4486a2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a3b74acf6f315bb5fe36266bc9647ee97"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__create_options.html#a3b74acf6f315bb5fe36266bc9647ee97">maxBufferedMessages</a></td></tr>
 <tr class="separator:a3b74acf6f315bb5fe36266bc9647ee97"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a12d546fd0ccf4e1091b18e1b735c7240"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__create_options.html#a12d546fd0ccf4e1091b18e1b735c7240">MQTTVersion</a></td></tr>
 <tr class="separator:a12d546fd0ccf4e1091b18e1b735c7240"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <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 MQCO. </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 or 1 0 means no MQTTVersion </p>

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

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">int sendWhileDisconnected</td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>Whether to allow messages to be sent when the client library is not connected. </p>

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

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">int maxBufferedMessages</td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>the maximum number of messages allowed to be buffered while not connected. </p>

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

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">int MQTTVersion</td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>Whether the MQTT version is 3.1, 3.1.1, or 5. To use V5, this must be set. MQTT V5 has to be chosen here, because during the create call the message persistence is initialized, and we want to know whether the format of any persisted messages is appropriate for the MQTT version we are going to connect with. Selecting 3.1 or 3.1.1 and attempting to read 5.0 persisted messages will result in an error on create. </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_async_8h_source.html">MQTTAsync.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 Asynchronous 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 Asynchronous MQTT C Client Library: MQTTAsync_createOptions 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 Asynchronous 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">MQTTAsync_createOptions Struct Reference</div> </div>
	</div><!--header-->
	<div class="contents">

	<p><code>#include <<a class="el" href="_m_q_t_t_async_8h_source.html">MQTTAsync.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_async__create_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_async__create_options.html#a0761a5e5be0383882e42924de8e51f82">struct_version</a></td></tr>
	<tr class="separator:a0761a5e5be0383882e42924de8e51f82"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a078cd68d8f896ce7eac0cc83d4486a2c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__create_options.html#a078cd68d8f896ce7eac0cc83d4486a2c">sendWhileDisconnected</a></td></tr>
	<tr class="separator:a078cd68d8f896ce7eac0cc83d4486a2c"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a3b74acf6f315bb5fe36266bc9647ee97"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__create_options.html#a3b74acf6f315bb5fe36266bc9647ee97">maxBufferedMessages</a></td></tr>
	<tr class="separator:a3b74acf6f315bb5fe36266bc9647ee97"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a12d546fd0ccf4e1091b18e1b735c7240"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__create_options.html#a12d546fd0ccf4e1091b18e1b735c7240">MQTTVersion</a></td></tr>
	<tr class="separator:a12d546fd0ccf4e1091b18e1b735c7240"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<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 MQCO. </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 or 1 0 means no MQTTVersion </p>

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

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">int sendWhileDisconnected</td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>Whether to allow messages to be sent when the client library is not connected. </p>

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

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">int maxBufferedMessages</td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>the maximum number of messages allowed to be buffered while not connected. </p>

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

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">int MQTTVersion</td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>Whether the MQTT version is 3.1, 3.1.1, or 5. To use V5, this must be set. MQTT V5 has to be chosen here, because during the create call the message persistence is initialized, and we want to know whether the format of any persisted messages is appropriate for the MQTT version we are going to connect with. Selecting 3.1 or 3.1.1 and attempting to read 5.0 persisted messages will result in an error on create. </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_async_8h_source.html">MQTTAsync.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 Asynchronous 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>