| <!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/callback.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('callback_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">callback.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="callback_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="l00008"></a><span class="lineno"> 8</span> <span class="comment">/*******************************************************************************</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Copyright (c) 2013-2016 Frank Pagliughi <fpagliughi@mindspring.com></span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * All rights reserved. This program and the accompanying materials</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * are made available under the terms of the Eclipse Public License v1.0</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * and Eclipse Distribution License v1.0 which accompany this distribution.</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * The Eclipse Public License is available at</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * http://www.eclipse.org/legal/epl-v10.html</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * and the Eclipse Distribution License is available at</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * http://www.eclipse.org/org/documents/edl-v10.php.</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Contributors:</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * Frank Pagliughi - initial implementation and documentation</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *******************************************************************************/</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef __mqtt_callback_h</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span><span class="preprocessor">#define __mqtt_callback_h</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "MQTTAsync.h"</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="delivery__token_8h.html">mqtt/delivery_token.h</a>"</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="types_8h.html">mqtt/types.h</a>"</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">namespace </span>mqtt {</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classmqtt_1_1callback.html"> 41</a></span> <span class="keyword">class </span><a class="code" href="classmqtt_1_1callback.html">callback</a></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmqtt_1_1callback.html#a40562ff84237a6935d804c3bf47a6a66"> 45</a></span>  <span class="keyword">using</span> <a class="code" href="classmqtt_1_1callback.html#a40562ff84237a6935d804c3bf47a6a66">ptr_t</a> = std::shared_ptr<callback>;</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classmqtt_1_1callback.html#a18487d400efd4b64c9e29261a42b79fe"> 47</a></span>  <span class="keyword">using</span> <a class="code" href="classmqtt_1_1callback.html#a18487d400efd4b64c9e29261a42b79fe">const_ptr_t</a> = std::shared_ptr<const callback>;</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classmqtt_1_1callback.html#a55f55da1b60e5f0d0f87e45dbe8538ff"> 52</a></span>  <span class="keyword">virtual</span> <a class="code" href="classmqtt_1_1callback.html#a55f55da1b60e5f0d0f87e45dbe8538ff">~callback</a>() {}</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> |
| <div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classmqtt_1_1callback.html#a831d2270e3296527fce29852c2822c86"> 58</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1callback.html#a831d2270e3296527fce29852c2822c86">connected</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>& cause) {}</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classmqtt_1_1callback.html#ad33f388261c80db6d529089a9561c69d"> 63</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1callback.html#ad33f388261c80db6d529089a9561c69d">connection_lost</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>& cause) {}</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classmqtt_1_1callback.html#ae18e49acbf085b2e419d43916a5150c8"> 68</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1callback.html#ae18e49acbf085b2e419d43916a5150c8">message_arrived</a>(const_message_ptr msg) {}</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classmqtt_1_1callback.html#a7165d51b17104475f679254d25b4ba97"> 74</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmqtt_1_1callback.html#a7165d51b17104475f679254d25b4ba97">delivery_complete</a>(delivery_token_ptr tok) {}</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> };</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">using</span> callback_ptr = <a class="code" href="classmqtt_1_1callback.html#a40562ff84237a6935d804c3bf47a6a66">callback::ptr_t</a>;</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">using</span> const_callback_ptr = <a class="code" href="classmqtt_1_1callback.html#a18487d400efd4b64c9e29261a42b79fe">callback::const_ptr_t</a>;</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// end namespace mqtt</span></div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> }</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#endif // __mqtt_callback_h</span></div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor"></span></div> |
| <div class="ttc" id="classmqtt_1_1callback_html_a40562ff84237a6935d804c3bf47a6a66"><div class="ttname"><a href="classmqtt_1_1callback.html#a40562ff84237a6935d804c3bf47a6a66">mqtt::callback::ptr_t</a></div><div class="ttdeci">std::shared_ptr< callback > ptr_t</div><div class="ttdoc">Smart/shared pointer to an object of this type. </div><div class="ttdef"><b>Definition:</b> callback.h:45</div></div> |
| <div class="ttc" id="types_8h_html"><div class="ttname"><a href="types_8h.html">types.h</a></div><div class="ttdoc">Basic types and type conversions for the Paho MQTT C++ library. </div></div> |
| <div class="ttc" id="classmqtt_1_1callback_html_ad33f388261c80db6d529089a9561c69d"><div class="ttname"><a href="classmqtt_1_1callback.html#ad33f388261c80db6d529089a9561c69d">mqtt::callback::connection_lost</a></div><div class="ttdeci">virtual void connection_lost(const string &cause)</div><div class="ttdoc">This method is called when the connection to the server is lost. </div><div class="ttdef"><b>Definition:</b> callback.h:63</div></div> |
| <div class="ttc" id="classmqtt_1_1callback_html_a831d2270e3296527fce29852c2822c86"><div class="ttname"><a href="classmqtt_1_1callback.html#a831d2270e3296527fce29852c2822c86">mqtt::callback::connected</a></div><div class="ttdeci">virtual void connected(const string &cause)</div><div class="ttdoc">This method is called when the client is connected. </div><div class="ttdef"><b>Definition:</b> callback.h:58</div></div> |
| <div class="ttc" id="classmqtt_1_1callback_html_a7165d51b17104475f679254d25b4ba97"><div class="ttname"><a href="classmqtt_1_1callback.html#a7165d51b17104475f679254d25b4ba97">mqtt::callback::delivery_complete</a></div><div class="ttdeci">virtual void delivery_complete(delivery_token_ptr tok)</div><div class="ttdoc">Called when delivery for a message has been completed, and all acknowledgments have been received...</div><div class="ttdef"><b>Definition:</b> callback.h:74</div></div> |
| <div class="ttc" id="classmqtt_1_1callback_html_a18487d400efd4b64c9e29261a42b79fe"><div class="ttname"><a href="classmqtt_1_1callback.html#a18487d400efd4b64c9e29261a42b79fe">mqtt::callback::const_ptr_t</a></div><div class="ttdeci">std::shared_ptr< const callback > const_ptr_t</div><div class="ttdoc">Smart/shared pointer to a const object of this type. </div><div class="ttdef"><b>Definition:</b> callback.h:47</div></div> |
| <div class="ttc" id="classmqtt_1_1callback_html"><div class="ttname"><a href="classmqtt_1_1callback.html">mqtt::callback</a></div><div class="ttdoc">Provides a mechanism for tracking the completion of an asynchronous action. </div><div class="ttdef"><b>Definition:</b> callback.h:41</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_1callback_html_a55f55da1b60e5f0d0f87e45dbe8538ff"><div class="ttname"><a href="classmqtt_1_1callback.html#a55f55da1b60e5f0d0f87e45dbe8538ff">mqtt::callback::~callback</a></div><div class="ttdeci">virtual ~callback()</div><div class="ttdoc">Virtual destructor. </div><div class="ttdef"><b>Definition:</b> callback.h:52</div></div> |
| <div class="ttc" id="classmqtt_1_1callback_html_ae18e49acbf085b2e419d43916a5150c8"><div class="ttname"><a href="classmqtt_1_1callback.html#ae18e49acbf085b2e419d43916a5150c8">mqtt::callback::message_arrived</a></div><div class="ttdeci">virtual void message_arrived(const_message_ptr msg)</div><div class="ttdoc">This method is called when a message arrives from the server. </div><div class="ttdef"><b>Definition:</b> callback.h:68</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="callback_8h.html">callback.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> |
