-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathstructCC__Mqtt311ConnectConfig.html
124 lines (120 loc) · 8.4 KB
/
structCC__Mqtt311ConnectConfig.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CommsChampion Ecosystem MQTT v3.1.1 Client: CC_Mqtt311ConnectConfig 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 id="projectrow">
<td id="projectalign">
<div id="projectname">CommsChampion Ecosystem MQTT v3.1.1 Client
</div>
<div id="projectbrief">MQTT v3.1.1 Client Library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> |
<a href="structCC__Mqtt311ConnectConfig-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">CC_Mqtt311ConnectConfig Struct Reference<div class="ingroups"><a class="el" href="group__connect.html">"Connect Operation Data Type and Functions"</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Configuration structure to be passed to the <b><a class="el" href="group__connect.html#gad84a395dd590d67671bfee7250b67d06" title="Perform basic configuration of the "connect" operation.">cc_mqtt311_client_connect_config()</a></b>.
<a href="structCC__Mqtt311ConnectConfig.html#details">More...</a></p>
<p><code>#include "<a class="el" href="common_8h_source.html">common.h</a>"</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a56b1d00587a8a6900fe2a97295d8926d" id="r_a56b1d00587a8a6900fe2a97295d8926d"><td class="memItemLeft" align="right" valign="top"><a id="a56b1d00587a8a6900fe2a97295d8926d" name="a56b1d00587a8a6900fe2a97295d8926d"></a>
bool </td><td class="memItemRight" valign="bottom"><b>m_cleanSession</b></td></tr>
<tr class="memdesc:a56b1d00587a8a6900fe2a97295d8926d"><td class="mdescLeft"> </td><td class="mdescRight">Clean session flag, defaults to false. <br /></td></tr>
<tr class="separator:a56b1d00587a8a6900fe2a97295d8926d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae305fcb58d773e611a6cea92eb682d70" id="r_ae305fcb58d773e611a6cea92eb682d70"><td class="memItemLeft" align="right" valign="top"><a id="ae305fcb58d773e611a6cea92eb682d70" name="ae305fcb58d773e611a6cea92eb682d70"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>m_clientId</b></td></tr>
<tr class="memdesc:ae305fcb58d773e611a6cea92eb682d70"><td class="mdescLeft"> </td><td class="mdescRight">Zero terminated Client ID string, can be NULL. When NULL means empty "Client ID". Defaults to NULL. <br /></td></tr>
<tr class="separator:ae305fcb58d773e611a6cea92eb682d70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69241627faa2efc15285e90eee5e4269" id="r_a69241627faa2efc15285e90eee5e4269"><td class="memItemLeft" align="right" valign="top"><a id="a69241627faa2efc15285e90eee5e4269" name="a69241627faa2efc15285e90eee5e4269"></a>
unsigned </td><td class="memItemRight" valign="bottom"><b>m_keepAlive</b></td></tr>
<tr class="memdesc:a69241627faa2efc15285e90eee5e4269"><td class="mdescLeft"> </td><td class="mdescRight">Keep alive seconds configuration, defaults to 60. <br /></td></tr>
<tr class="separator:a69241627faa2efc15285e90eee5e4269"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aadfa3e04f0f2482f607cb487820f7a11" id="r_aadfa3e04f0f2482f607cb487820f7a11"><td class="memItemLeft" align="right" valign="top"><a id="aadfa3e04f0f2482f607cb487820f7a11" name="aadfa3e04f0f2482f607cb487820f7a11"></a>
const unsigned char * </td><td class="memItemRight" valign="bottom"><b>m_password</b></td></tr>
<tr class="memdesc:aadfa3e04f0f2482f607cb487820f7a11"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to password buffer, can be NULL, defaults to NULL. <br /></td></tr>
<tr class="separator:aadfa3e04f0f2482f607cb487820f7a11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54027c1de7a21d96b5a24ed979b17b8b" id="r_a54027c1de7a21d96b5a24ed979b17b8b"><td class="memItemLeft" align="right" valign="top"><a id="a54027c1de7a21d96b5a24ed979b17b8b" name="a54027c1de7a21d96b5a24ed979b17b8b"></a>
unsigned </td><td class="memItemRight" valign="bottom"><b>m_passwordLen</b></td></tr>
<tr class="memdesc:a54027c1de7a21d96b5a24ed979b17b8b"><td class="mdescLeft"> </td><td class="mdescRight">Number of password bytes. When 0 means no password value. Defaults to 0. <br /></td></tr>
<tr class="separator:a54027c1de7a21d96b5a24ed979b17b8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8391d91bd1f9f024e54bce4f0fbfbfdd" id="r_a8391d91bd1f9f024e54bce4f0fbfbfdd"><td class="memItemLeft" align="right" valign="top"><a id="a8391d91bd1f9f024e54bce4f0fbfbfdd" name="a8391d91bd1f9f024e54bce4f0fbfbfdd"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>m_username</b></td></tr>
<tr class="memdesc:a8391d91bd1f9f024e54bce4f0fbfbfdd"><td class="mdescLeft"> </td><td class="mdescRight">Zero terminated Username string, can be NULL. When NULL means no username value. Defaults to NULL. <br /></td></tr>
<tr class="separator:a8391d91bd1f9f024e54bce4f0fbfbfdd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Configuration structure to be passed to the <b><a class="el" href="group__connect.html#gad84a395dd590d67671bfee7250b67d06" title="Perform basic configuration of the "connect" operation.">cc_mqtt311_client_connect_config()</a></b>. </p>
<dl class="section see"><dt>See also</dt><dd><b><a class="el" href="group__connect.html#ga7313c201b35d73d585112f2026f658b4" title="Intialize the CC_Mqtt311ConnectConfig configuration structure.">cc_mqtt311_client_connect_init_config()</a></b> </dd></dl>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="common_8h_source.html">common.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>