| <!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::topic 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_1topic.html">topic</a> |
| </div> |
| </div> |
| <div class="contents"> |
| <h1>mqtt::topic Class Reference</h1><!-- doxytag: class="mqtt::topic" --> |
| <p>Represents a <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a> destination, used for publish/subscribe messaging. |
| <a href="#_details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="topic_8h_source.html">topic.h</a>></code></p> |
| |
| <p><a href="classmqtt_1_1topic-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="af035614b0ad217daa65a3831c80f60b4"></a><!-- doxytag: member="mqtt::topic::ptr_t" ref="af035614b0ad217daa65a3831c80f60b4" args="" --> |
| typedef std::shared_ptr< <a class="el" href="classmqtt_1_1topic.html">topic</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1topic.html#af035614b0ad217daa65a3831c80f60b4">ptr_t</a></td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">A 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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1topic.html#a527098a2f88c9113a858b01aecc8badb">topic</a> (const std::string &name, <a class="el" href="classmqtt_1_1async__client.html">async_client</a> &cli)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an MQTT <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a> destination for messages. <a href="#a527098a2f88c9113a858b01aecc8badb"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1topic.html#af55ba2eb3d5c795eca0a82e6fc9567be">get_name</a> () const </td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the queue or <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a>. <a href="#af55ba2eb3d5c795eca0a82e6fc9567be"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">idelivery_token_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1topic.html#a21149c4145a34578d5c7c26c2a335cf9">publish</a> (const void *payload, size_t n, int qos, bool retained)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Publishes 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> on the <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a>. <a href="#a21149c4145a34578d5c7c26c2a335cf9"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">idelivery_token_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1topic.html#a665a350303825e457a99c701aac57d93">publish</a> (const std::string &str, int qos, bool retained)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Publishes 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> on the <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a>. <a href="#a665a350303825e457a99c701aac57d93"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">idelivery_token_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1topic.html#a8aef9d8378aad57fb6db93f78ac40c38">publish</a> (message_ptr msg)</td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Publishes the specified <a class="el" href="classmqtt_1_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a> to this <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a>, but does not wait for delivery of 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> to complete. <a href="#a8aef9d8378aad57fb6db93f78ac40c38"></a><br/></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1topic.html#ae6664d8e74d0c12e55e8c4986cee1857">to_str</a> () const </td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a string representation of this <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a>. <a href="#ae6664d8e74d0c12e55e8c4986cee1857"></a><br/></td></tr> |
| </table> |
| <hr/><a name="_details"></a><h2>Detailed Description</h2> |
| <p>Represents a <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a> destination, used for publish/subscribe messaging. </p> |
| <hr/><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a527098a2f88c9113a858b01aecc8badb"></a><!-- doxytag: member="mqtt::topic::topic" ref="a527098a2f88c9113a858b01aecc8badb" args="(const std::string &name, async_client &cli)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::topic::topic </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"> <em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1async__client.html">async_client</a> & </td> |
| <td class="paramname"> <em>cli</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td><code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Construct an MQTT <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a> destination for messages. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td></td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>cli</em> </td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/><h2>Member Function Documentation</h2> |
| <a class="anchor" id="af55ba2eb3d5c795eca0a82e6fc9567be"></a><!-- doxytag: member="mqtt::topic::get_name" ref="af55ba2eb3d5c795eca0a82e6fc9567be" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string mqtt::topic::get_name </td> |
| <td>(</td> |
| <td class="paramname"></td> |
| <td> ) </td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Returns the name of the queue or <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a>. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>std::string </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8aef9d8378aad57fb6db93f78ac40c38"></a><!-- doxytag: member="mqtt::topic::publish" ref="a8aef9d8378aad57fb6db93f78ac40c38" args="(message_ptr msg)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">idelivery_token_ptr mqtt::topic::publish </td> |
| <td>(</td> |
| <td class="paramtype">message_ptr </td> |
| <td class="paramname"> <em>msg</em></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Publishes the specified <a class="el" href="classmqtt_1_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a> to this <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a>, but does not wait for delivery of 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> to complete. </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_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a></em> </td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classmqtt_1_1delivery__token.html" title="Provides a mechanism to track the delivery progress of a message.">delivery_token</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a665a350303825e457a99c701aac57d93"></a><!-- doxytag: member="mqtt::topic::publish" ref="a665a350303825e457a99c701aac57d93" args="(const std::string &str, int qos, bool retained)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">idelivery_token_ptr mqtt::topic::publish </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"> <em>str</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"> <em>qos</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"> <em>retained</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td><code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Publishes 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> on the <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a>. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>payload</em> </td><td></td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>qos</em> </td><td></td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>retained</em> </td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classmqtt_1_1delivery__token.html" title="Provides a mechanism to track the delivery progress of a message.">delivery_token</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a21149c4145a34578d5c7c26c2a335cf9"></a><!-- doxytag: member="mqtt::topic::publish" ref="a21149c4145a34578d5c7c26c2a335cf9" args="(const void *payload, size_t n, int qos, bool retained)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">idelivery_token_ptr mqtt::topic::publish </td> |
| <td>(</td> |
| <td class="paramtype">const void * </td> |
| <td class="paramname"> <em>payload</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"> <em>n</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"> <em>qos</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"> <em>retained</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Publishes 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> on the <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a>. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>payload</em> </td><td></td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>n</em> </td><td></td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>qos</em> </td><td></td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>retained</em> </td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classmqtt_1_1delivery__token.html" title="Provides a mechanism to track the delivery progress of a message.">delivery_token</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae6664d8e74d0c12e55e8c4986cee1857"></a><!-- doxytag: member="mqtt::topic::to_str" ref="ae6664d8e74d0c12e55e8c4986cee1857" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string mqtt::topic::to_str </td> |
| <td>(</td> |
| <td class="paramname"></td> |
| <td> ) </td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Returns a string representation of this <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a>. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>std::string </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>mqtt/<a class="el" href="topic_8h_source.html">topic.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> |
