-
Notifications
You must be signed in to change notification settings - Fork 0
/
structCC__Mqtt5SubscribeTopicConfig.html
120 lines (116 loc) · 7.81 KB
/
structCC__Mqtt5SubscribeTopicConfig.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
<!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 v5 Client: CC_Mqtt5SubscribeTopicConfig 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 v5 Client
</div>
<div id="projectbrief">MQTT v5 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__Mqtt5SubscribeTopicConfig-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">CC_Mqtt5SubscribeTopicConfig Struct Reference<div class="ingroups"><a class="el" href="group__subscribe.html">"Subscribe Operation Data Type and Functions"</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Topic filter configuration structure of the "subscribe" operation.
<a href="structCC__Mqtt5SubscribeTopicConfig.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:af00787ba85f79b6f5440c86bc91bbb2a" id="r_af00787ba85f79b6f5440c86bc91bbb2a"><td class="memItemLeft" align="right" valign="top"><a id="af00787ba85f79b6f5440c86bc91bbb2a" name="af00787ba85f79b6f5440c86bc91bbb2a"></a>
<a class="el" href="group__global.html#gacfea3a318c3e2dd3d60c69a6a6157d7f">CC_Mqtt5QoS</a> </td><td class="memItemRight" valign="bottom"><b>m_maxQos</b></td></tr>
<tr class="memdesc:af00787ba85f79b6f5440c86bc91bbb2a"><td class="mdescLeft"> </td><td class="mdescRight">"Maximum QoS" value, defaults to <a class="el" href="group__global.html#ggacfea3a318c3e2dd3d60c69a6a6157d7fa13430f9f8356378d2e493b1c0d1fface">CC_Mqtt5QoS_ExactlyOnceDelivery</a>. <br /></td></tr>
<tr class="separator:af00787ba85f79b6f5440c86bc91bbb2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c5f7e0e1ed68c645872e397fc700120" id="r_a6c5f7e0e1ed68c645872e397fc700120"><td class="memItemLeft" align="right" valign="top"><a id="a6c5f7e0e1ed68c645872e397fc700120" name="a6c5f7e0e1ed68c645872e397fc700120"></a>
bool </td><td class="memItemRight" valign="bottom"><b>m_noLocal</b></td></tr>
<tr class="memdesc:a6c5f7e0e1ed68c645872e397fc700120"><td class="mdescLeft"> </td><td class="mdescRight">"No Local" subscription option, defaults to <b>false</b>. <br /></td></tr>
<tr class="separator:a6c5f7e0e1ed68c645872e397fc700120"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02751615dcabae29f9d03f358b06ecc0" id="r_a02751615dcabae29f9d03f358b06ecc0"><td class="memItemLeft" align="right" valign="top"><a id="a02751615dcabae29f9d03f358b06ecc0" name="a02751615dcabae29f9d03f358b06ecc0"></a>
bool </td><td class="memItemRight" valign="bottom"><b>m_retainAsPublished</b></td></tr>
<tr class="memdesc:a02751615dcabae29f9d03f358b06ecc0"><td class="mdescLeft"> </td><td class="mdescRight">"Retain As Published" subscription option, defaults to <b>false</b>. <br /></td></tr>
<tr class="separator:a02751615dcabae29f9d03f358b06ecc0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41dfd349de9e48e07d19cca30fe9bb52" id="r_a41dfd349de9e48e07d19cca30fe9bb52"><td class="memItemLeft" align="right" valign="top"><a id="a41dfd349de9e48e07d19cca30fe9bb52" name="a41dfd349de9e48e07d19cca30fe9bb52"></a>
<a class="el" href="group__subscribe.html#gabfd846ede45f77ffed9847de11b6b0a6">CC_Mqtt5RetainHandling</a> </td><td class="memItemRight" valign="bottom"><b>m_retainHandling</b></td></tr>
<tr class="memdesc:a41dfd349de9e48e07d19cca30fe9bb52"><td class="mdescLeft"> </td><td class="mdescRight">"Retain Handling" subscription option, defaults to <a class="el" href="group__subscribe.html#ggabfd846ede45f77ffed9847de11b6b0a6a6400a1d538d187e304a19b26e6d69a4d">CC_Mqtt5RetainHandling_Send</a>. <br /></td></tr>
<tr class="separator:a41dfd349de9e48e07d19cca30fe9bb52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6554f4cb616f58f95c0000b1b80fb6b8" id="r_a6554f4cb616f58f95c0000b1b80fb6b8"><td class="memItemLeft" align="right" valign="top"><a id="a6554f4cb616f58f95c0000b1b80fb6b8" name="a6554f4cb616f58f95c0000b1b80fb6b8"></a>
const char * </td><td class="memItemRight" valign="bottom"><b>m_topic</b></td></tr>
<tr class="memdesc:a6554f4cb616f58f95c0000b1b80fb6b8"><td class="mdescLeft"> </td><td class="mdescRight">"Topic Filter" string, mustn't be NULL <br /></td></tr>
<tr class="separator:a6554f4cb616f58f95c0000b1b80fb6b8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Topic filter configuration structure of the "subscribe" operation. </p>
<dl class="section see"><dt>See also</dt><dd><b><a class="el" href="group__subscribe.html#gabeff7363174cab7ab34bb045af931df9" title="Intialize the CC_Mqtt5SubscribeTopicConfig configuration structure.">cc_mqtt5_client_subscribe_init_config_topic()</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>