blob: faca0888a96b8f7666e23da01dc55600ebee5920 [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::idelivery_token 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_1idelivery__token.html">idelivery_token</a>
</div>
</div>
<div class="contents">
<h1>mqtt::idelivery_token Class Reference</h1><!-- doxytag: class="mqtt::idelivery_token" --><!-- doxytag: inherits="mqtt::itoken" -->
<p>Provides a mechanism for tracking the delivery of 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>.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="delivery__token_8h_source.html">delivery_token.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mqtt::idelivery_token:</div>
<div class="dynsection">
<div class="center">
<img src="classmqtt_1_1idelivery__token.gif" usemap="#mqtt::idelivery_token_map" alt=""/>
<map id="mqtt::idelivery_token_map" name="mqtt::idelivery_token_map">
<area href="classmqtt_1_1itoken.html" alt="mqtt::itoken" shape="rect" coords="0,0,125,24"/>
<area href="classmqtt_1_1delivery__token.html" alt="mqtt::delivery_token" shape="rect" coords="0,112,125,136"/>
</map>
</div>
</div>
<p><a href="classmqtt_1_1idelivery__token-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="a9146ca3f8350e4b3bb055fdfe95cc28c"></a><!-- doxytag: member="mqtt::idelivery_token::ptr_t" ref="a9146ca3f8350e4b3bb055fdfe95cc28c" args="" -->
typedef std::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="classmqtt_1_1idelivery__token.html">idelivery_token</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 message_ptr&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1idelivery__token.html#a0893fbca7c700c4d2389ec180f4d3224">get_message</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the <a class="el" href="classmqtt_1_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a> associated with this <a class="el" href="classmqtt_1_1token.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">token</a>. <a href="#a0893fbca7c700c4d2389ec180f4d3224"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Provides a mechanism for tracking the delivery of 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>. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0893fbca7c700c4d2389ec180f4d3224"></a><!-- doxytag: member="mqtt::idelivery_token::get_message" ref="a0893fbca7c700c4d2389ec180f4d3224" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual message_ptr mqtt::idelivery_token::get_message </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the <a class="el" href="classmqtt_1_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a> associated with this <a class="el" href="classmqtt_1_1token.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">token</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="el" href="classmqtt_1_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a> associated with this <a class="el" href="classmqtt_1_1token.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">token</a>. </dd></dl>
<p>Implemented in <a class="el" href="classmqtt_1_1delivery__token.html#a30e8217f6b395170fff24733c5716a08">mqtt::delivery_token</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>mqtt/<a class="el" href="delivery__token_8h_source.html">delivery_token.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>