blob: 8cf94aeeafff18f5c57400b95a4d0e0859440320 [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.6"/>
<title>Paho C++: src/mqtt/response_options.h Source File</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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">Paho C++
&#160;<span id="projectnumber">1.0</span>
</div>
<div id="projectbrief">The Paho MQTT C++ Client Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</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('response__options_8h_source.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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Friends</a></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="headertitle">
<div class="title">response_options.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="response__options_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#ifndef __mqtt_response_options_h</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __mqtt_response_options_h</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;MQTTAsync.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="token_8h.html">mqtt/token.h</a>&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="delivery__token_8h.html">mqtt/delivery_token.h</a>&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">namespace </span>mqtt {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">class </span>response_options_test;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">class </span>delivery_response_options_test;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">class </span>token_test;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">// response_options</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classmqtt_1_1response__options.html"> 27</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmqtt_1_1response__options.html">response_options</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; MQTTAsync_responseOptions opts_;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classmqtt_1_1token.html#abfccc1dd02644f58b55671c69c85dc19">token::weak_ptr_t</a> tok_;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classmqtt_1_1response__options.html#ac39954340d8b15edaa883af1bcfcf7ae"> 36</a></span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classmqtt_1_1async__client.html">async_client</a>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span>response_options_test;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span>token_test;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="classmqtt_1_1response__options.html#a8ca50339acbcf9701bbc1f7ae754e41a">response_options</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="classmqtt_1_1response__options.html#a8ca50339acbcf9701bbc1f7ae754e41a">response_options</a>(<span class="keyword">const</span> token_ptr&amp; tok);</div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classmqtt_1_1response__options.html#a18e59d299922928bef2f1b67a05ca5f2"> 54</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1response__options.html#a18e59d299922928bef2f1b67a05ca5f2">set_token</a>(<span class="keyword">const</span> token_ptr&amp; tok) {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; tok_ = tok;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; opts_.context = tok.get();</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;};</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment">// delivery_response_options</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classmqtt_1_1delivery__response__options.html"> 68</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmqtt_1_1delivery__response__options.html">delivery_response_options</a></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;{</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; MQTTAsync_responseOptions opts_;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <a class="code" href="classmqtt_1_1delivery__token.html#af52a9beb73d62709cf153a1b098d0c11">delivery_token::weak_ptr_t</a> dtok_;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classmqtt_1_1delivery__response__options.html#ac39954340d8b15edaa883af1bcfcf7ae"> 77</a></span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classmqtt_1_1async__client.html">async_client</a>;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span>delivery_response_options_test;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <a class="code" href="classmqtt_1_1delivery__response__options.html#a704101f766f2ef60eb2aeb6b4e5caa93">delivery_response_options</a>();</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <a class="code" href="classmqtt_1_1delivery__response__options.html#a704101f766f2ef60eb2aeb6b4e5caa93">delivery_response_options</a>(<span class="keyword">const</span> delivery_token_ptr&amp; dtok);</div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classmqtt_1_1delivery__response__options.html#a9dd6f1113f207c65a167b6d88da10ff1"> 94</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1delivery__response__options.html#a9dd6f1113f207c65a167b6d88da10ff1">set_token</a>(<span class="keyword">const</span> delivery_token_ptr&amp; dtok) {</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; dtok_ = dtok;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; opts_.context = dtok.get();</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; }</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;};</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="comment">// end namespace &#39;mqtt&#39;</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;}</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="preprocessor">#endif // __mqtt_response_options_h</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="preprocessor"></span></div>
<div class="ttc" id="classmqtt_1_1delivery__response__options_html"><div class="ttname"><a href="classmqtt_1_1delivery__response__options.html">mqtt::delivery_response_options</a></div><div class="ttdoc">The response options for asynchronous calls targeted at delivery. </div><div class="ttdef"><b>Definition:</b> response_options.h:68</div></div>
<div class="ttc" id="classmqtt_1_1async__client_html"><div class="ttname"><a href="classmqtt_1_1async__client.html">mqtt::async_client</a></div><div class="ttdoc">Lightweight client for talking to an MQTT server using non-blocking methods that allow an operation t...</div><div class="ttdef"><b>Definition:</b> async_client.h:60</div></div>
<div class="ttc" id="classmqtt_1_1response__options_html_a18e59d299922928bef2f1b67a05ca5f2"><div class="ttname"><a href="classmqtt_1_1response__options.html#a18e59d299922928bef2f1b67a05ca5f2">mqtt::response_options::set_token</a></div><div class="ttdeci">void set_token(const token_ptr &amp;tok)</div><div class="ttdoc">Sets the callback context to a generic token. </div><div class="ttdef"><b>Definition:</b> response_options.h:54</div></div>
<div class="ttc" id="classmqtt_1_1token_html_abfccc1dd02644f58b55671c69c85dc19"><div class="ttname"><a href="classmqtt_1_1token.html#abfccc1dd02644f58b55671c69c85dc19">mqtt::token::weak_ptr_t</a></div><div class="ttdeci">std::weak_ptr&lt; token &gt; weak_ptr_t</div><div class="ttdoc">Weak pointer to an object of this class. </div><div class="ttdef"><b>Definition:</b> token.h:157</div></div>
<div class="ttc" id="classmqtt_1_1delivery__token_html_af52a9beb73d62709cf153a1b098d0c11"><div class="ttname"><a href="classmqtt_1_1delivery__token.html#af52a9beb73d62709cf153a1b098d0c11">mqtt::delivery_token::weak_ptr_t</a></div><div class="ttdeci">std::weak_ptr&lt; delivery_token &gt; weak_ptr_t</div><div class="ttdoc">Weak pointer to an object of this class. </div><div class="ttdef"><b>Definition:</b> delivery_token.h:61</div></div>
<div class="ttc" id="classmqtt_1_1delivery__response__options_html_a9dd6f1113f207c65a167b6d88da10ff1"><div class="ttname"><a href="classmqtt_1_1delivery__response__options.html#a9dd6f1113f207c65a167b6d88da10ff1">mqtt::delivery_response_options::set_token</a></div><div class="ttdeci">void set_token(const delivery_token_ptr &amp;dtok)</div><div class="ttdoc">Sets the callback context to a delivery token. </div><div class="ttdef"><b>Definition:</b> response_options.h:94</div></div>
<div class="ttc" id="delivery__token_8h_html"><div class="ttname"><a href="delivery__token_8h.html">delivery_token.h</a></div><div class="ttdoc">Declaration of MQTT delivery_token class. </div></div>
<div class="ttc" id="classmqtt_1_1response__options_html"><div class="ttname"><a href="classmqtt_1_1response__options.html">mqtt::response_options</a></div><div class="ttdoc">The response options for various asynchronous calls. </div><div class="ttdef"><b>Definition:</b> response_options.h:27</div></div>
<div class="ttc" id="classmqtt_1_1response__options_html_a8ca50339acbcf9701bbc1f7ae754e41a"><div class="ttname"><a href="classmqtt_1_1response__options.html#a8ca50339acbcf9701bbc1f7ae754e41a">mqtt::response_options::response_options</a></div><div class="ttdeci">response_options()</div><div class="ttdoc">Create an empty response object. </div></div>
<div class="ttc" id="classmqtt_1_1delivery__response__options_html_a704101f766f2ef60eb2aeb6b4e5caa93"><div class="ttname"><a href="classmqtt_1_1delivery__response__options.html#a704101f766f2ef60eb2aeb6b4e5caa93">mqtt::delivery_response_options::delivery_response_options</a></div><div class="ttdeci">delivery_response_options()</div><div class="ttdoc">Create an empty delivery response object. </div></div>
<div class="ttc" id="token_8h_html"><div class="ttname"><a href="token_8h.html">token.h</a></div><div class="ttdoc">Declaration of MQTT token class. </div></div>
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_503ebd9f384f44c9859dcb1451d026bc.html">mqtt</a></li><li class="navelem"><a class="el" href="response__options_8h.html">response_options.h</a></li>
<li class="footer">Generated on Sun Jul 23 2017 10:24:29 for Paho C++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>