| <!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/disconnect_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++ |
|  <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 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 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('disconnect__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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </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">disconnect_options.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="disconnect__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> </div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/****************************************************************************</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * Copyright (c) 2016-2017 Frank Pagliughi <fpagliughi@mindspring.com></span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * All rights reserved. This program and the accompanying materials</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * are made available under the terms of the Eclipse Public License v1.0</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * and Eclipse Distribution License v1.0 which accompany this distribution.</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * The Eclipse Public License is available at</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * http://www.eclipse.org/legal/epl-v10.html</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * and the Eclipse Distribution License is available at</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * http://www.eclipse.org/org/documents/edl-v10.php.</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Contributors:</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Frank Pagliughi - initial implementation and documentation</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> ***************************************************************************/</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef __mqtt_disconnect_options_h</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define __mqtt_disconnect_options_h</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "MQTTAsync.h"</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="token_8h.html">mqtt/token.h</a>"</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <chrono></span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span>mqtt {</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classmqtt_1_1disconnect__options.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="classmqtt_1_1disconnect__options.html">disconnect_options</a></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">static</span> <span class="keyword">const</span> MQTTAsync_disconnectOptions DFLT_C_STRUCT;</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  MQTTAsync_disconnectOptions opts_;</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  token_ptr tok_;</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> |
| <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classmqtt_1_1disconnect__options.html#ac39954340d8b15edaa883af1bcfcf7ae"> 49</a></span>  <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="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">friend</span> <span class="keyword">class </span>disconnect_options_test;</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classmqtt_1_1disconnect__options.html#a092adff3498c72f1d61aa9b3c8d14741">disconnect_options</a>();</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classmqtt_1_1disconnect__options.html#a092adff3498c72f1d61aa9b3c8d14741">disconnect_options</a>(<span class="keywordtype">int</span> timeout, <span class="keyword">const</span> token_ptr& tok);</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">template</span> <<span class="keyword">class</span> Rep, <span class="keyword">class</span> Period></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classmqtt_1_1disconnect__options.html#ad70bf9bddd21c2330da95b8f624cbd01"> 69</a></span>  <a class="code" href="classmqtt_1_1disconnect__options.html#ad70bf9bddd21c2330da95b8f624cbd01">disconnect_options</a>(<span class="keyword">const</span> std::chrono::duration<Rep, Period>& to,</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">const</span> token_ptr& tok) : <a class="code" href="classmqtt_1_1disconnect__options.html">disconnect_options</a>() {</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="classmqtt_1_1disconnect__options.html#a05ae3241cf829420e3e4666a96e07a9e">set_timeout</a>(to);</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classmqtt_1_1disconnect__options.html#a289955318ab951b13749fff88063bd5f">set_token</a>(tok);</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classmqtt_1_1disconnect__options.html#a092adff3498c72f1d61aa9b3c8d14741">disconnect_options</a>(<span class="keyword">const</span> <a class="code" href="classmqtt_1_1disconnect__options.html">disconnect_options</a>& opt);</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classmqtt_1_1disconnect__options.html#a092adff3498c72f1d61aa9b3c8d14741">disconnect_options</a>(<a class="code" href="classmqtt_1_1disconnect__options.html">disconnect_options</a>&& opt);</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classmqtt_1_1disconnect__options.html">disconnect_options</a>& <a class="code" href="classmqtt_1_1disconnect__options.html#a8d133724b76cf103389b425ac5afee7c">operator=</a>(<span class="keyword">const</span> <a class="code" href="classmqtt_1_1disconnect__options.html">disconnect_options</a>& opt);</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classmqtt_1_1disconnect__options.html">disconnect_options</a>& <a class="code" href="classmqtt_1_1disconnect__options.html#a8d133724b76cf103389b425ac5afee7c">operator=</a>(<a class="code" href="classmqtt_1_1disconnect__options.html">disconnect_options</a>&& opt);</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classmqtt_1_1disconnect__options.html#af935d6eecc113f6ff2f66f6d662f8e22"> 98</a></span>  std::chrono::milliseconds <a class="code" href="classmqtt_1_1disconnect__options.html#af935d6eecc113f6ff2f66f6d662f8e22">get_timeout</a>()<span class="keyword"> const </span>{</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">return</span> std::chrono::milliseconds(opts_.timeout);</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="classmqtt_1_1disconnect__options.html#a05ae3241cf829420e3e4666a96e07a9e"> 106</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1disconnect__options.html#a05ae3241cf829420e3e4666a96e07a9e">set_timeout</a>(<span class="keywordtype">int</span> timeout) { opts_.timeout = timeout; }</div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">template</span> <<span class="keyword">class</span> Rep, <span class="keyword">class</span> Period></div> |
| <div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classmqtt_1_1disconnect__options.html#a49e84404f8b8f9d91ad6fcd25416ac43"> 114</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1disconnect__options.html#a49e84404f8b8f9d91ad6fcd25416ac43">set_timeout</a>(<span class="keyword">const</span> std::chrono::duration<Rep, Period>& to) {</div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="comment">// TODO: check range</span></div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="classmqtt_1_1disconnect__options.html#a05ae3241cf829420e3e4666a96e07a9e">set_timeout</a>((<span class="keywordtype">int</span>) to_milliseconds_count(to));</div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  }</div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1disconnect__options.html#a289955318ab951b13749fff88063bd5f">set_token</a>(<span class="keyword">const</span> token_ptr& tok);</div> |
| <div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classmqtt_1_1disconnect__options.html#ab2bbe3ebd4201320a7a375525c37d192"> 127</a></span>  token_ptr <a class="code" href="classmqtt_1_1disconnect__options.html#ab2bbe3ebd4201320a7a375525c37d192">get_token</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> tok_; }</div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> };</div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">// end namespace 'mqtt'</span></div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> }</div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif // __mqtt_disconnect_options_h</span></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_1disconnect__options_html_ad70bf9bddd21c2330da95b8f624cbd01"><div class="ttname"><a href="classmqtt_1_1disconnect__options.html#ad70bf9bddd21c2330da95b8f624cbd01">mqtt::disconnect_options::disconnect_options</a></div><div class="ttdeci">disconnect_options(const std::chrono::duration< Rep, Period > &to, const token_ptr &tok)</div><div class="ttdoc">Creates disconnect options tied to the specific token. </div><div class="ttdef"><b>Definition:</b> disconnect_options.h:69</div></div> |
| <div class="ttc" id="classmqtt_1_1disconnect__options_html_a05ae3241cf829420e3e4666a96e07a9e"><div class="ttname"><a href="classmqtt_1_1disconnect__options.html#a05ae3241cf829420e3e4666a96e07a9e">mqtt::disconnect_options::set_timeout</a></div><div class="ttdeci">void set_timeout(int timeout)</div><div class="ttdoc">Sets the timeout for disconnecting. </div><div class="ttdef"><b>Definition:</b> disconnect_options.h:106</div></div> |
| <div class="ttc" id="classmqtt_1_1disconnect__options_html_af935d6eecc113f6ff2f66f6d662f8e22"><div class="ttname"><a href="classmqtt_1_1disconnect__options.html#af935d6eecc113f6ff2f66f6d662f8e22">mqtt::disconnect_options::get_timeout</a></div><div class="ttdeci">std::chrono::milliseconds get_timeout() const </div><div class="ttdoc">Gets the timeout used for disconnecting. </div><div class="ttdef"><b>Definition:</b> disconnect_options.h:98</div></div> |
| <div class="ttc" id="classmqtt_1_1disconnect__options_html_a289955318ab951b13749fff88063bd5f"><div class="ttname"><a href="classmqtt_1_1disconnect__options.html#a289955318ab951b13749fff88063bd5f">mqtt::disconnect_options::set_token</a></div><div class="ttdeci">void set_token(const token_ptr &tok)</div><div class="ttdoc">Sets the callback context to a delivery token. </div></div> |
| <div class="ttc" id="classmqtt_1_1disconnect__options_html_a49e84404f8b8f9d91ad6fcd25416ac43"><div class="ttname"><a href="classmqtt_1_1disconnect__options.html#a49e84404f8b8f9d91ad6fcd25416ac43">mqtt::disconnect_options::set_timeout</a></div><div class="ttdeci">void set_timeout(const std::chrono::duration< Rep, Period > &to)</div><div class="ttdoc">Sets the connect timeout with a chrono duration. </div><div class="ttdef"><b>Definition:</b> disconnect_options.h:114</div></div> |
| <div class="ttc" id="classmqtt_1_1disconnect__options_html_ab2bbe3ebd4201320a7a375525c37d192"><div class="ttname"><a href="classmqtt_1_1disconnect__options.html#ab2bbe3ebd4201320a7a375525c37d192">mqtt::disconnect_options::get_token</a></div><div class="ttdeci">token_ptr get_token() const </div><div class="ttdoc">Gets the callback context to a delivery token. </div><div class="ttdef"><b>Definition:</b> disconnect_options.h:127</div></div> |
| <div class="ttc" id="classmqtt_1_1disconnect__options_html"><div class="ttname"><a href="classmqtt_1_1disconnect__options.html">mqtt::disconnect_options</a></div><div class="ttdoc">Options for disconnecting from an MQTT broker. </div><div class="ttdef"><b>Definition:</b> disconnect_options.h:37</div></div> |
| <div class="ttc" id="classmqtt_1_1disconnect__options_html_a092adff3498c72f1d61aa9b3c8d14741"><div class="ttname"><a href="classmqtt_1_1disconnect__options.html#a092adff3498c72f1d61aa9b3c8d14741">mqtt::disconnect_options::disconnect_options</a></div><div class="ttdeci">disconnect_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 class="ttc" id="classmqtt_1_1disconnect__options_html_a8d133724b76cf103389b425ac5afee7c"><div class="ttname"><a href="classmqtt_1_1disconnect__options.html#a8d133724b76cf103389b425ac5afee7c">mqtt::disconnect_options::operator=</a></div><div class="ttdeci">disconnect_options & operator=(const disconnect_options &opt)</div><div class="ttdoc">Copy assignment. </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="disconnect__options_8h.html">disconnect_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> |
