Google Git
Sign in
pigweed / third_party / github / STMicroelectronics / stm32_mw_lwip / refs/heads/main / . / doc / doxygen / output / html / structmqtt__connect__client__info__t.html
blob: e460e29d86cc7fa073527d30ab0de5fd12e4f2a3 [file] [log] [blame]
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>lwIP: 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">
$(document).ready(initResizable);
</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">lwIP
&#160;<span id="projectnumber">2.1.2</span>
</div>
<div id="projectbrief">Lightweight IP stack</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
$(document).ready(function(){initNavTree('structmqtt__connect__client__info__t.html','');});
</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 class="ingroups"><a class="el" href="group__apps.html">Applications</a> &raquo; <a class="el" href="group__mqtt.html">MQTT client</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;mqtt.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:ad35f7850df21f001d5c5ffaa1a18c05a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</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">&#160;</td></tr>
<tr class="memitem:aec961673d5c3e8dc853c91f30d9333b5"><td class="memItemLeft" align="right" valign="top">const char *&#160;</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">&#160;</td></tr>
<tr class="memitem:a8f68efe91c5311418151256c96102d4b"><td class="memItemLeft" align="right" valign="top">const char *&#160;</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">&#160;</td></tr>
<tr class="memitem:ac80262a7456812e9eefffd8c3b9ac21a"><td class="memItemLeft" align="right" valign="top">u16_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a32e77415460752ba0484eb3ba0faf0c8"><td class="memItemLeft" align="right" valign="top">const char *&#160;</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">&#160;</td></tr>
<tr class="memitem:a925fcebd15555afdc0820e196e2fd3a7"><td class="memItemLeft" align="right" valign="top">const char *&#160;</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">&#160;</td></tr>
<tr class="memitem:a07954934f4fecf54fa190997848229d9"><td class="memItemLeft" align="right" valign="top">u8_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a49c10873f44d7534140a63eef2a6a4e3"><td class="memItemLeft" align="right" valign="top">u8_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a45987acc116de5d27fff6856778e55b4"><td class="memItemLeft" align="right" valign="top">struct altcp_tls_config *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmqtt__connect__client__info__t.html#a45987acc116de5d27fff6856778e55b4">tls_config</a></td></tr>
<tr class="separator:a45987acc116de5d27fff6856778e55b4"><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>Client information and connection parameters </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="ad35f7850df21f001d5c5ffaa1a18c05a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad35f7850df21f001d5c5ffaa1a18c05a">&#9670;&nbsp;</a></span>client_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* mqtt_connect_client_info_t::client_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Client identifier, must be set by caller </p>
</div>
</div>
<a id="a8f68efe91c5311418151256c96102d4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f68efe91c5311418151256c96102d4b">&#9670;&nbsp;</a></span>client_pass</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* mqtt_connect_client_info_t::client_pass</td>
</tr>
</table>
</div><div class="memdoc">
<p>Password, set to NULL if not used </p>
</div>
</div>
<a id="aec961673d5c3e8dc853c91f30d9333b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec961673d5c3e8dc853c91f30d9333b5">&#9670;&nbsp;</a></span>client_user</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* mqtt_connect_client_info_t::client_user</td>
</tr>
</table>
</div><div class="memdoc">
<p>User name, set to NULL if not used </p>
</div>
</div>
<a id="ac80262a7456812e9eefffd8c3b9ac21a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac80262a7456812e9eefffd8c3b9ac21a">&#9670;&nbsp;</a></span>keep_alive</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u16_t 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>
</div>
</div>
<a id="a45987acc116de5d27fff6856778e55b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45987acc116de5d27fff6856778e55b4">&#9670;&nbsp;</a></span>tls_config</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct altcp_tls_config* mqtt_connect_client_info_t::tls_config</td>
</tr>
</table>
</div><div class="memdoc">
<p>TLS configuration for secure connections </p>
</div>
</div>
<a id="a925fcebd15555afdc0820e196e2fd3a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a925fcebd15555afdc0820e196e2fd3a7">&#9670;&nbsp;</a></span>will_msg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* mqtt_connect_client_info_t::will_msg</td>
</tr>
</table>
</div><div class="memdoc">
<p>will_msg, see will_topic </p>
</div>
</div>
<a id="a07954934f4fecf54fa190997848229d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07954934f4fecf54fa190997848229d9">&#9670;&nbsp;</a></span>will_qos</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u8_t mqtt_connect_client_info_t::will_qos</td>
</tr>
</table>
</div><div class="memdoc">
<p>will_qos, see will_topic </p>
</div>
</div>
<a id="a49c10873f44d7534140a63eef2a6a4e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49c10873f44d7534140a63eef2a6a4e3">&#9670;&nbsp;</a></span>will_retain</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u8_t mqtt_connect_client_info_t::will_retain</td>
</tr>
</table>
</div><div class="memdoc">
<p>will_retain, see will_topic </p>
</div>
</div>
<a id="a32e77415460752ba0484eb3ba0faf0c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32e77415460752ba0484eb3ba0faf0c8">&#9670;&nbsp;</a></span>will_topic</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const 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>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/include/lwip/apps/<a class="el" href="mqtt_8h.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.13 </li>
</ul>
</div>
</body>
</html>