| <!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::delivery_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 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 List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <div class="navpath"><b>mqtt</b>::<a class="el" href="classmqtt_1_1delivery__token.html">delivery_token</a> |
| </div> |
| </div> |
| <div class="contents"> |
| <h1>mqtt::delivery_token Class Reference</h1><!-- doxytag: class="mqtt::delivery_token" --><!-- doxytag: inherits="mqtt::idelivery_token,mqtt::token" --> |
| <p>Provides a mechanism to track the delivery progress 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 <<a class="el" href="delivery__token_8h_source.html">delivery_token.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for mqtt::delivery_token:</div> |
| <div class="dynsection"> |
| <div class="center"> |
| <img src="classmqtt_1_1delivery__token.gif" usemap="#mqtt::delivery_token_map" alt=""/> |
| <map id="mqtt::delivery_token_map" name="mqtt::delivery_token_map"> |
| <area href="classmqtt_1_1idelivery__token.html" alt="mqtt::idelivery_token" shape="rect" coords="0,56,125,80"/> |
| <area href="classmqtt_1_1token.html" alt="mqtt::token" shape="rect" coords="135,56,260,80"/> |
| <area href="classmqtt_1_1itoken.html" alt="mqtt::itoken" shape="rect" coords="0,0,125,24"/> |
| <area href="classmqtt_1_1itoken.html" alt="mqtt::itoken" shape="rect" coords="135,0,260,24"/> |
| </map> |
| </div> |
| </div> |
| |
| <p><a href="classmqtt_1_1delivery__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="a4c913bf67fcc303f2fae41b22c73164e"></a><!-- doxytag: member="mqtt::delivery_token::ptr_t" ref="a4c913bf67fcc303f2fae41b22c73164e" args="" --> |
| typedef std::shared_ptr<br class="typebreak"/> |
| < <a class="el" href="classmqtt_1_1delivery__token.html">delivery_token</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1delivery__token.html#a4c913bf67fcc303f2fae41b22c73164e">ptr_t</a></td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Smart/shared pointer to this class. <br/></td></tr> |
| <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21e968998bb4adb1c4c609d353b3d47f"></a><!-- doxytag: member="mqtt::delivery_token::delivery_token" ref="a21e968998bb4adb1c4c609d353b3d47f" args="(iasync_client &cli)" --> |
| </td><td class="memItemRight" valign="bottom"><b>delivery_token</b> (<a class="el" href="classmqtt_1_1iasync__client.html">iasync_client</a> &cli)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4b946aedd6a71c625ed63cffa722539"></a><!-- doxytag: member="mqtt::delivery_token::delivery_token" ref="aa4b946aedd6a71c625ed63cffa722539" args="(iasync_client &cli, const std::string &topic)" --> |
| </td><td class="memItemRight" valign="bottom"><b>delivery_token</b> (<a class="el" href="classmqtt_1_1iasync__client.html">iasync_client</a> &cli, const std::string &<a class="el" href="classmqtt_1_1topic.html">topic</a>)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ec9dc87f55d6c365d81bea3fc55378e"></a><!-- doxytag: member="mqtt::delivery_token::delivery_token" ref="a5ec9dc87f55d6c365d81bea3fc55378e" args="(iasync_client &cli, const std::vector< std::string > &topics)" --> |
| </td><td class="memItemRight" valign="bottom"><b>delivery_token</b> (<a class="el" href="classmqtt_1_1iasync__client.html">iasync_client</a> &cli, const std::vector< std::string > &topics)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">virtual message_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1delivery__token.html#a30e8217f6b395170fff24733c5716a08">get_message</a> () const </td></tr> |
| <tr><td class="mdescLeft"> </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="#a30e8217f6b395170fff24733c5716a08"></a><br/></td></tr> |
| <tr><td colspan="2"><h2>Friends</h2></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1delivery__token.html#ac39954340d8b15edaa883af1bcfcf7ae">async_client</a></td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Client has special access. <a href="#ac39954340d8b15edaa883af1bcfcf7ae"></a><br/></td></tr> |
| </table> |
| <hr/><a name="_details"></a><h2>Detailed Description</h2> |
| <p>Provides a mechanism to track the delivery progress 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> |
| <p>Used to track the the delivery progress 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> when a publish is executed in a non-blocking manner (run in the background) action. </p> |
| <hr/><h2>Member Function Documentation</h2> |
| <a class="anchor" id="a30e8217f6b395170fff24733c5716a08"></a><!-- doxytag: member="mqtt::delivery_token::get_message" ref="a30e8217f6b395170fff24733c5716a08" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual message_ptr mqtt::delivery_token::get_message </td> |
| <td>(</td> |
| <td class="paramname"></td> |
| <td> ) </td> |
| <td> const<code> [inline, 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><a class="el" href="classmqtt_1_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a> </dd></dl> |
| |
| <p>Implements <a class="el" href="classmqtt_1_1idelivery__token.html#a0893fbca7c700c4d2389ec180f4d3224">mqtt::idelivery_token</a>.</p> |
| |
| </div> |
| </div> |
| <hr/><h2>Friends And Related Function Documentation</h2> |
| <a class="anchor" id="ac39954340d8b15edaa883af1bcfcf7ae"></a><!-- doxytag: member="mqtt::delivery_token::async_client" ref="ac39954340d8b15edaa883af1bcfcf7ae" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">friend class <a class="el" href="classmqtt_1_1async__client.html">async_client</a><code> [friend]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Client has special access. </p> |
| |
| <p>Reimplemented from <a class="el" href="classmqtt_1_1token.html#ac39954340d8b15edaa883af1bcfcf7ae">mqtt::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 |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> |
| </body> |
| </html> |
