<!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.16"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>UbixOS V2: mqtt_connect_client_info_t 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="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</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="projectalign" style="padding-left: 0.5em;"> <div id="projectname">UbixOS V2  <span id="projectnumber">2.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.16 --> <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> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('structmqtt__connect__client__info__t.html','');}); /* @license-end */ </script> <div id="doc-content"> <!-- 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 class="header"> <div class="summary"> <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">mqtt_connect_client_info_t Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="mqtt_8h_source.html">mqtt.h</a>></code></p> <div class="dynheader"> Collaboration diagram for mqtt_connect_client_info_t:</div> <div class="dyncontent"> <div class="center"><img src="structmqtt__connect__client__info__t__coll__graph.png" border="0" usemap="#mqtt__connect__client__info__t_coll__map" alt="Collaboration graph"/></div> </div> <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:ad35f7850df21f001d5c5ffaa1a18c05a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmqtt__connect__client__info__t.html#ad35f7850df21f001d5c5ffaa1a18c05a">client_id</a></td></tr> <tr class="separator:ad35f7850df21f001d5c5ffaa1a18c05a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8f68efe91c5311418151256c96102d4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmqtt__connect__client__info__t.html#a8f68efe91c5311418151256c96102d4b">client_pass</a></td></tr> <tr class="separator:a8f68efe91c5311418151256c96102d4b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aec961673d5c3e8dc853c91f30d9333b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmqtt__connect__client__info__t.html#aec961673d5c3e8dc853c91f30d9333b5">client_user</a></td></tr> <tr class="separator:aec961673d5c3e8dc853c91f30d9333b5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac80262a7456812e9eefffd8c3b9ac21a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmqtt__connect__client__info__t.html#ac80262a7456812e9eefffd8c3b9ac21a">keep_alive</a></td></tr> <tr class="separator:ac80262a7456812e9eefffd8c3b9ac21a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a925fcebd15555afdc0820e196e2fd3a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmqtt__connect__client__info__t.html#a925fcebd15555afdc0820e196e2fd3a7">will_msg</a></td></tr> <tr class="separator:a925fcebd15555afdc0820e196e2fd3a7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a07954934f4fecf54fa190997848229d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmqtt__connect__client__info__t.html#a07954934f4fecf54fa190997848229d9">will_qos</a></td></tr> <tr class="separator:a07954934f4fecf54fa190997848229d9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a49c10873f44d7534140a63eef2a6a4e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmqtt__connect__client__info__t.html#a49c10873f44d7534140a63eef2a6a4e3">will_retain</a></td></tr> <tr class="separator:a49c10873f44d7534140a63eef2a6a4e3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a32e77415460752ba0484eb3ba0faf0c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmqtt__connect__client__info__t.html#a32e77415460752ba0484eb3ba0faf0c8">will_topic</a></td></tr> <tr class="separator:a32e77415460752ba0484eb3ba0faf0c8"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Client information and connection parameters </p> <p class="definition">Definition at line <a class="el" href="mqtt_8h_source.html#l00060">60</a> of file <a class="el" href="mqtt_8h_source.html">mqtt.h</a>.</p> </div><h2 class="groupheader">Field Documentation</h2> <a id="ad35f7850df21f001d5c5ffaa1a18c05a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad35f7850df21f001d5c5ffaa1a18c05a">◆ </a></span>client_id</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char* mqtt_connect_client_info_t::client_id</td> </tr> </table> </div><div class="memdoc"> <p>Client identifier, must be set by caller </p> <p class="definition">Definition at line <a class="el" href="mqtt_8h_source.html#l00062">62</a> of file <a class="el" href="mqtt_8h_source.html">mqtt.h</a>.</p> </div> </div> <a id="a8f68efe91c5311418151256c96102d4b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8f68efe91c5311418151256c96102d4b">◆ </a></span>client_pass</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char* mqtt_connect_client_info_t::client_pass</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="mqtt_8h_source.html#l00065">65</a> of file <a class="el" href="mqtt_8h_source.html">mqtt.h</a>.</p> </div> </div> <a id="aec961673d5c3e8dc853c91f30d9333b5"></a> <h2 class="memtitle"><span class="permalink"><a href="#aec961673d5c3e8dc853c91f30d9333b5">◆ </a></span>client_user</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char* mqtt_connect_client_info_t::client_user</td> </tr> </table> </div><div class="memdoc"> <p>User name and password, set to NULL if not used </p> <p class="definition">Definition at line <a class="el" href="mqtt_8h_source.html#l00064">64</a> of file <a class="el" href="mqtt_8h_source.html">mqtt.h</a>.</p> </div> </div> <a id="ac80262a7456812e9eefffd8c3b9ac21a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac80262a7456812e9eefffd8c3b9ac21a">◆ </a></span>keep_alive</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> mqtt_connect_client_info_t::keep_alive</td> </tr> </table> </div><div class="memdoc"> <p>keep alive time in seconds, 0 to disable keep alive functionality </p> <p class="definition">Definition at line <a class="el" href="mqtt_8h_source.html#l00067">67</a> of file <a class="el" href="mqtt_8h_source.html">mqtt.h</a>.</p> </div> </div> <a id="a925fcebd15555afdc0820e196e2fd3a7"></a> <h2 class="memtitle"><span class="permalink"><a href="#a925fcebd15555afdc0820e196e2fd3a7">◆ </a></span>will_msg</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char* mqtt_connect_client_info_t::will_msg</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="mqtt_8h_source.html#l00071">71</a> of file <a class="el" href="mqtt_8h_source.html">mqtt.h</a>.</p> </div> </div> <a id="a07954934f4fecf54fa190997848229d9"></a> <h2 class="memtitle"><span class="permalink"><a href="#a07954934f4fecf54fa190997848229d9">◆ </a></span>will_qos</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> mqtt_connect_client_info_t::will_qos</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="mqtt_8h_source.html#l00072">72</a> of file <a class="el" href="mqtt_8h_source.html">mqtt.h</a>.</p> </div> </div> <a id="a49c10873f44d7534140a63eef2a6a4e3"></a> <h2 class="memtitle"><span class="permalink"><a href="#a49c10873f44d7534140a63eef2a6a4e3">◆ </a></span>will_retain</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> mqtt_connect_client_info_t::will_retain</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="mqtt_8h_source.html#l00073">73</a> of file <a class="el" href="mqtt_8h_source.html">mqtt.h</a>.</p> </div> </div> <a id="a32e77415460752ba0484eb3ba0faf0c8"></a> <h2 class="memtitle"><span class="permalink"><a href="#a32e77415460752ba0484eb3ba0faf0c8">◆ </a></span>will_topic</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char* mqtt_connect_client_info_t::will_topic</td> </tr> </table> </div><div class="memdoc"> <p>will topic, set to NULL if will is not to be used, will_msg, will_qos and will retain are then ignored </p> <p class="definition">Definition at line <a class="el" href="mqtt_8h_source.html#l00070">70</a> of file <a class="el" href="mqtt_8h_source.html">mqtt.h</a>.</p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li>C:/Dev/git/UbixOS/sys/include/net/apps/<a class="el" href="mqtt_8h_source.html">mqtt.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="structmqtt__connect__client__info__t.html">mqtt_connect_client_info_t</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li> </ul> </div> </body> </html>