Google Git
Sign in
eclipse / gerrit / www.eclipse.org / paho / ab7f71ab2009ec884a9727a3ffd5fbd56609ca14 / . / files / cppdoc / classmqtt_1_1callback.html
blob: d82a71fa0f6bf6d8da81d8943dd33006dbbb2c15 [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"/>
<title>mqttpp: mqtt::callback Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>mqtt</b>::<a class="el" href="classmqtt_1_1callback.html">callback</a>
</div>
</div>
<div class="contents">
<h1>mqtt::callback Class Reference</h1><!-- doxytag: class="mqtt::callback" -->
<p>Provides a mechanism for tracking the completion of an asynchronous action.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="callback_8h_source.html">callback.h</a>&gt;</code></p>
<p><a href="classmqtt_1_1callback-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f39866872bb835e9753fb1157803e64"></a><!-- doxytag: member="mqtt::callback::ptr_t" ref="a5f39866872bb835e9753fb1157803e64" args="" -->
typedef std::shared_ptr&lt; <a class="el" href="classmqtt_1_1callback.html">callback</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>ptr_t</b></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1callback.html#acb9d07057bac61129d09b1fb0135bd66">connection_lost</a> (const std::string &amp;cause)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method is called when the connection to the server is lost. <a href="#acb9d07057bac61129d09b1fb0135bd66"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1callback.html#aa30a62d637c189c33534974788ef3073">message_arrived</a> (const std::string &amp;<a class="el" href="classmqtt_1_1topic.html">topic</a>, message_ptr msg)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method is called when a <a class="el" href="classmqtt_1_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a> arrives from the server. <a href="#aa30a62d637c189c33534974788ef3073"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1callback.html#a881d2572a78130d29c5ab8e4cd78520c">delivery_complete</a> (idelivery_token_ptr tok)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when delivery for a <a class="el" href="classmqtt_1_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a> has been completed, and all acknowledgments have been received. <a href="#a881d2572a78130d29c5ab8e4cd78520c"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Provides a mechanism for tracking the completion of an asynchronous action. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acb9d07057bac61129d09b1fb0135bd66"></a><!-- doxytag: member="mqtt::callback::connection_lost" ref="acb9d07057bac61129d09b1fb0135bd66" args="(const std::string &amp;cause)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mqtt::callback::connection_lost </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&nbsp;</td>
<td class="paramname"> <em>cause</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is called when the connection to the server is lost. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cause</em>&nbsp;</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a881d2572a78130d29c5ab8e4cd78520c"></a><!-- doxytag: member="mqtt::callback::delivery_complete" ref="a881d2572a78130d29c5ab8e4cd78520c" args="(idelivery_token_ptr tok)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mqtt::callback::delivery_complete </td>
<td>(</td>
<td class="paramtype">idelivery_token_ptr&nbsp;</td>
<td class="paramname"> <em>tok</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when delivery for a <a class="el" href="classmqtt_1_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a> has been completed, and all acknowledgments have been received. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classmqtt_1_1token.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">token</a></em>&nbsp;</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa30a62d637c189c33534974788ef3073"></a><!-- doxytag: member="mqtt::callback::message_arrived" ref="aa30a62d637c189c33534974788ef3073" args="(const std::string &amp;topic, message_ptr msg)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mqtt::callback::message_arrived </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&nbsp;</td>
<td class="paramname"> <em>topic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">message_ptr&nbsp;</td>
<td class="paramname"> <em>msg</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is called when a <a class="el" href="classmqtt_1_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a> arrives from the server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a></em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>mqtt/<a class="el" href="callback_8h_source.html">callback.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 30 Apr 2014 for mqttpp by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>