| <!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++: mqtt::will_options Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><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="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><!-- 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('classmqtt_1_1will__options.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="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classmqtt_1_1will__options-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mqtt::will_options Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Holds the set of options that govern the Last Will and Testament feature. |
| <a href="classmqtt_1_1will__options.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="will__options_8h_source.html">will_options.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:ac56a7fbfa543f5c6ce01a2b2fdd1283c"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#ac56a7fbfa543f5c6ce01a2b2fdd1283c">ptr_t</a> = std::shared_ptr< <a class="el" href="classmqtt_1_1will__options.html">will_options</a> ></td></tr> |
| <tr class="memdesc:ac56a7fbfa543f5c6ce01a2b2fdd1283c"><td class="mdescLeft"> </td><td class="mdescRight">Smart/shared pointer to this class. <a href="#ac56a7fbfa543f5c6ce01a2b2fdd1283c">More...</a><br/></td></tr> |
| <tr class="separator:ac56a7fbfa543f5c6ce01a2b2fdd1283c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac86ef64ef281a3ecc461a8a869ef756c"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#ac86ef64ef281a3ecc461a8a869ef756c">const_ptr_t</a> = std::shared_ptr< const <a class="el" href="classmqtt_1_1will__options.html">will_options</a> ></td></tr> |
| <tr class="memdesc:ac86ef64ef281a3ecc461a8a869ef756c"><td class="mdescLeft"> </td><td class="mdescRight">Smart/shared pointer to a const object of this class. <a href="#ac86ef64ef281a3ecc461a8a869ef756c">More...</a><br/></td></tr> |
| <tr class="separator:ac86ef64ef281a3ecc461a8a869ef756c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:ab30a4a0063dfb1653ddf80e84c0d4bb9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab30a4a0063dfb1653ddf80e84c0d4bb9"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#ab30a4a0063dfb1653ddf80e84c0d4bb9">will_options</a> ()</td></tr> |
| <tr class="memdesc:ab30a4a0063dfb1653ddf80e84c0d4bb9"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new object using the default values. <br/></td></tr> |
| <tr class="separator:ab30a4a0063dfb1653ddf80e84c0d4bb9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:accc1b3e4b370a8ffff706758023f9e6e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#accc1b3e4b370a8ffff706758023f9e6e">will_options</a> (<a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> top, const void *payload, size_t payload_len, int qos=DFLT_QOS, bool retained=DFLT_RETAINED)</td></tr> |
| <tr class="memdesc:accc1b3e4b370a8ffff706758023f9e6e"><td class="mdescLeft"> </td><td class="mdescRight">Sets the "Last Will and Testament" (LWT) for the connection. <a href="#accc1b3e4b370a8ffff706758023f9e6e">More...</a><br/></td></tr> |
| <tr class="separator:accc1b3e4b370a8ffff706758023f9e6e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c6985131c5093a0701e8ac47a6ddbd9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a3c6985131c5093a0701e8ac47a6ddbd9">will_options</a> (const <a class="el" href="classmqtt_1_1topic.html">topic</a> &top, const void *payload, size_t payload_len, int qos=DFLT_QOS, bool retained=DFLT_RETAINED)</td></tr> |
| <tr class="memdesc:a3c6985131c5093a0701e8ac47a6ddbd9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the "Last Will and Testament" (LWT) for the connection. <a href="#a3c6985131c5093a0701e8ac47a6ddbd9">More...</a><br/></td></tr> |
| <tr class="separator:a3c6985131c5093a0701e8ac47a6ddbd9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3f74c4ed509e15acff2a9da7cfd117b0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a3f74c4ed509e15acff2a9da7cfd117b0">will_options</a> (<a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> top, <a class="el" href="classmqtt_1_1buffer__ref.html">binary_ref</a> payload, int qos=DFLT_QOS, bool retained=DFLT_RETAINED)</td></tr> |
| <tr class="memdesc:a3f74c4ed509e15acff2a9da7cfd117b0"><td class="mdescLeft"> </td><td class="mdescRight">Sets the "Last Will and Testament" (LWT) for the connection. <a href="#a3f74c4ed509e15acff2a9da7cfd117b0">More...</a><br/></td></tr> |
| <tr class="separator:a3f74c4ed509e15acff2a9da7cfd117b0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8b76174a3444e1c1747bc5224ab28611"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a8b76174a3444e1c1747bc5224ab28611">will_options</a> (<a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> top, const string &payload, int qos=DFLT_QOS, bool retained=DFLT_QOS)</td></tr> |
| <tr class="memdesc:a8b76174a3444e1c1747bc5224ab28611"><td class="mdescLeft"> </td><td class="mdescRight">Sets the "Last Will and Testament" (LWT) for the connection. <a href="#a8b76174a3444e1c1747bc5224ab28611">More...</a><br/></td></tr> |
| <tr class="separator:a8b76174a3444e1c1747bc5224ab28611"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5403217de3ed42bee690bfdc934a9235"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a5403217de3ed42bee690bfdc934a9235">will_options</a> (const <a class="el" href="classmqtt_1_1message.html">message</a> &msg)</td></tr> |
| <tr class="memdesc:a5403217de3ed42bee690bfdc934a9235"><td class="mdescLeft"> </td><td class="mdescRight">Sets the "Last Will and Testament" (LWT) for the connection. <a href="#a5403217de3ed42bee690bfdc934a9235">More...</a><br/></td></tr> |
| <tr class="separator:a5403217de3ed42bee690bfdc934a9235"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac84faf9ea32564d7dafd3195e1dd9c62"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#ac84faf9ea32564d7dafd3195e1dd9c62">will_options</a> (const <a class="el" href="classmqtt_1_1will__options.html">will_options</a> &opt)</td></tr> |
| <tr class="memdesc:ac84faf9ea32564d7dafd3195e1dd9c62"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor for the LWT options. <a href="#ac84faf9ea32564d7dafd3195e1dd9c62">More...</a><br/></td></tr> |
| <tr class="separator:ac84faf9ea32564d7dafd3195e1dd9c62"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8e2a0464b613425f8b829165cf00438b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a8e2a0464b613425f8b829165cf00438b">will_options</a> (<a class="el" href="classmqtt_1_1will__options.html">will_options</a> &&opt)</td></tr> |
| <tr class="memdesc:a8e2a0464b613425f8b829165cf00438b"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor for the LWT options. <a href="#a8e2a0464b613425f8b829165cf00438b">More...</a><br/></td></tr> |
| <tr class="separator:a8e2a0464b613425f8b829165cf00438b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a38b0ebea7545384f9871920810163834"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmqtt_1_1will__options.html">will_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a38b0ebea7545384f9871920810163834">operator=</a> (const <a class="el" href="classmqtt_1_1will__options.html">will_options</a> &opt)</td></tr> |
| <tr class="memdesc:a38b0ebea7545384f9871920810163834"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment for the LWT options. <a href="#a38b0ebea7545384f9871920810163834">More...</a><br/></td></tr> |
| <tr class="separator:a38b0ebea7545384f9871920810163834"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3585e7d7dbb471d616737b8bf14602b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmqtt_1_1will__options.html">will_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a3585e7d7dbb471d616737b8bf14602b8">operator=</a> (<a class="el" href="classmqtt_1_1will__options.html">will_options</a> &&opt)</td></tr> |
| <tr class="memdesc:a3585e7d7dbb471d616737b8bf14602b8"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment for the LWT options. <a href="#a3585e7d7dbb471d616737b8bf14602b8">More...</a><br/></td></tr> |
| <tr class="separator:a3585e7d7dbb471d616737b8bf14602b8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3ace4c9e5aef81654cdb5795c0926523"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a3ace4c9e5aef81654cdb5795c0926523">get_topic</a> () const </td></tr> |
| <tr class="memdesc:a3ace4c9e5aef81654cdb5795c0926523"><td class="mdescLeft"> </td><td class="mdescRight">Gets the LWT message topic name. <a href="#a3ace4c9e5aef81654cdb5795c0926523">More...</a><br/></td></tr> |
| <tr class="separator:a3ace4c9e5aef81654cdb5795c0926523"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acba39c10d33a6e3c0245b25830f1ee0c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classmqtt_1_1buffer__ref.html">binary_ref</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#acba39c10d33a6e3c0245b25830f1ee0c">get_payload</a> () const </td></tr> |
| <tr class="memdesc:acba39c10d33a6e3c0245b25830f1ee0c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the LWT message payload. <a href="#acba39c10d33a6e3c0245b25830f1ee0c">More...</a><br/></td></tr> |
| <tr class="separator:acba39c10d33a6e3c0245b25830f1ee0c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa6fe0b0fae3537609bc54e746aed07ed"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#aa6fe0b0fae3537609bc54e746aed07ed">get_payload_str</a> () const </td></tr> |
| <tr class="memdesc:aa6fe0b0fae3537609bc54e746aed07ed"><td class="mdescLeft"> </td><td class="mdescRight">Gets the LWT message payload as a string. <a href="#aa6fe0b0fae3537609bc54e746aed07ed">More...</a><br/></td></tr> |
| <tr class="separator:aa6fe0b0fae3537609bc54e746aed07ed"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1876b5c2b1176c2759755f225a91e7c3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a1876b5c2b1176c2759755f225a91e7c3">get_qos</a> () const </td></tr> |
| <tr class="memdesc:a1876b5c2b1176c2759755f225a91e7c3"><td class="mdescLeft"> </td><td class="mdescRight">Gets the QoS value for the LWT message. <a href="#a1876b5c2b1176c2759755f225a91e7c3">More...</a><br/></td></tr> |
| <tr class="separator:a1876b5c2b1176c2759755f225a91e7c3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa9202a426bed90785d641f57cae5925e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#aa9202a426bed90785d641f57cae5925e">is_retained</a> () const </td></tr> |
| <tr class="memdesc:aa9202a426bed90785d641f57cae5925e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the 'retained' flag for the LWT message. <a href="#aa9202a426bed90785d641f57cae5925e">More...</a><br/></td></tr> |
| <tr class="separator:aa9202a426bed90785d641f57cae5925e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5ee824476eb40b39aabc18ed0feb158b"><td class="memItemLeft" align="right" valign="top">const_message_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a5ee824476eb40b39aabc18ed0feb158b">get_message</a> () const </td></tr> |
| <tr class="memdesc:a5ee824476eb40b39aabc18ed0feb158b"><td class="mdescLeft"> </td><td class="mdescRight">Gets the LWT message as a message object. <a href="#a5ee824476eb40b39aabc18ed0feb158b">More...</a><br/></td></tr> |
| <tr class="separator:a5ee824476eb40b39aabc18ed0feb158b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6f7d6e083440de05cfd631cc3f063240"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a6f7d6e083440de05cfd631cc3f063240">set_topic</a> (<a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> top)</td></tr> |
| <tr class="memdesc:a6f7d6e083440de05cfd631cc3f063240"><td class="mdescLeft"> </td><td class="mdescRight">Sets the LWT message topic name. <a href="#a6f7d6e083440de05cfd631cc3f063240">More...</a><br/></td></tr> |
| <tr class="separator:a6f7d6e083440de05cfd631cc3f063240"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a132976bc745ba889a4aae76173f2c569"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a132976bc745ba889a4aae76173f2c569">set_payload</a> (<a class="el" href="classmqtt_1_1buffer__ref.html">binary_ref</a> msg)</td></tr> |
| <tr class="memdesc:a132976bc745ba889a4aae76173f2c569"><td class="mdescLeft"> </td><td class="mdescRight">Sets the LWT message text. <a href="#a132976bc745ba889a4aae76173f2c569">More...</a><br/></td></tr> |
| <tr class="separator:a132976bc745ba889a4aae76173f2c569"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7412354ed5599b9bc267464bbacae972"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a7412354ed5599b9bc267464bbacae972">set_payload</a> (string msg)</td></tr> |
| <tr class="memdesc:a7412354ed5599b9bc267464bbacae972"><td class="mdescLeft"> </td><td class="mdescRight">Sets the LWT message text. <a href="#a7412354ed5599b9bc267464bbacae972">More...</a><br/></td></tr> |
| <tr class="separator:a7412354ed5599b9bc267464bbacae972"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a37b9e92e0b9d339af19bba3a0b30c2c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a37b9e92e0b9d339af19bba3a0b30c2c4">set_qos</a> (const int qos)</td></tr> |
| <tr class="memdesc:a37b9e92e0b9d339af19bba3a0b30c2c4"><td class="mdescLeft"> </td><td class="mdescRight">Sets the QoS value. <a href="#a37b9e92e0b9d339af19bba3a0b30c2c4">More...</a><br/></td></tr> |
| <tr class="separator:a37b9e92e0b9d339af19bba3a0b30c2c4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5767dc68cb8bfec285ffcfaf71a5c077"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#a5767dc68cb8bfec285ffcfaf71a5c077">set_retained</a> (bool retained)</td></tr> |
| <tr class="memdesc:a5767dc68cb8bfec285ffcfaf71a5c077"><td class="mdescLeft"> </td><td class="mdescRight">Sets the retained flag. <a href="#a5767dc68cb8bfec285ffcfaf71a5c077">More...</a><br/></td></tr> |
| <tr class="separator:a5767dc68cb8bfec285ffcfaf71a5c077"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:ab5e824c91a65212d9b79c704c6ae6f29"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5e824c91a65212d9b79c704c6ae6f29"></a> |
| class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1will__options.html#ab5e824c91a65212d9b79c704c6ae6f29">connect_options</a></td></tr> |
| <tr class="memdesc:ab5e824c91a65212d9b79c704c6ae6f29"><td class="mdescLeft"> </td><td class="mdescRight">The connect options has special access. <br/></td></tr> |
| <tr class="separator:ab5e824c91a65212d9b79c704c6ae6f29"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a622f44bfef637607b9070710bf9911"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a622f44bfef637607b9070710bf9911"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>connect_options_test</b></td></tr> |
| <tr class="separator:a2a622f44bfef637607b9070710bf9911"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adca10bccf960edb6b2c7900c246c646d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adca10bccf960edb6b2c7900c246c646d"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>will_options_test</b></td></tr> |
| <tr class="separator:adca10bccf960edb6b2c7900c246c646d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Holds the set of options that govern the Last Will and Testament feature. </p> |
| <dl class="section note"><dt>Note</dt><dd>This wraps struct v1 of the C library's MQTTAsync_willOptions structure. It sets the LWT binary payload, via the 'payload' struct field, and leaves the 'message' field as a nullptr. </dd></dl> |
| </div><h2 class="groupheader">Member Typedef Documentation</h2> |
| <a class="anchor" id="ac86ef64ef281a3ecc461a8a869ef756c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">using <a class="el" href="classmqtt_1_1will__options.html#ac86ef64ef281a3ecc461a8a869ef756c">mqtt::will_options::const_ptr_t</a> = std::shared_ptr<const <a class="el" href="classmqtt_1_1will__options.html">will_options</a>></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Smart/shared pointer to a const object of this class. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac56a7fbfa543f5c6ce01a2b2fdd1283c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">using <a class="el" href="classmqtt_1_1will__options.html#ac56a7fbfa543f5c6ce01a2b2fdd1283c">mqtt::will_options::ptr_t</a> = std::shared_ptr<<a class="el" href="classmqtt_1_1will__options.html">will_options</a>></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Smart/shared pointer to this class. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="accc1b3e4b370a8ffff706758023f9e6e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::will_options::will_options </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> </td> |
| <td class="paramname"><em>top</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></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>payload_len</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>qos</em> = <code>DFLT_QOS</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>retained</em> = <code>DFLT_RETAINED</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the "Last Will and Testament" (LWT) for the connection. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">top</td><td>The LWT message is published to the this topic. </td></tr> |
| <tr><td class="paramname">payload</td><td>The message that is published to the Will Topic. </td></tr> |
| <tr><td class="paramname">payload_len</td><td>The message size in bytes </td></tr> |
| <tr><td class="paramname">qos</td><td>The message Quality of Service. </td></tr> |
| <tr><td class="paramname">retained</td><td>Tell the broker to keep the LWT message after send to subscribers. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3c6985131c5093a0701e8ac47a6ddbd9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::will_options::will_options </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmqtt_1_1topic.html">topic</a> & </td> |
| <td class="paramname"><em>top</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></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>payload_len</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>qos</em> = <code>DFLT_QOS</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>retained</em> = <code>DFLT_RETAINED</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the "Last Will and Testament" (LWT) for the connection. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">top</td><td>The LWT message is published to the this topic. </td></tr> |
| <tr><td class="paramname">payload</td><td>The message that is published to the Will Topic. </td></tr> |
| <tr><td class="paramname">payload_len</td><td>The message size in bytes. </td></tr> |
| <tr><td class="paramname">qos</td><td>The message Quality of Service. </td></tr> |
| <tr><td class="paramname">retained</td><td>Tell the broker to keep the LWT message after send to subscribers. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3f74c4ed509e15acff2a9da7cfd117b0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::will_options::will_options </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> </td> |
| <td class="paramname"><em>top</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1buffer__ref.html">binary_ref</a> </td> |
| <td class="paramname"><em>payload</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>qos</em> = <code>DFLT_QOS</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>retained</em> = <code>DFLT_RETAINED</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the "Last Will and Testament" (LWT) for the connection. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">top</td><td>The LWT message is published to the this topic. </td></tr> |
| <tr><td class="paramname">payload</td><td>The message payload that is published to the Will Topic. </td></tr> |
| <tr><td class="paramname">qos</td><td>The message Quality of Service. </td></tr> |
| <tr><td class="paramname">retained</td><td>Tell the broker to keep the LWT message after send to subscribers. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8b76174a3444e1c1747bc5224ab28611"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::will_options::will_options </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> </td> |
| <td class="paramname"><em>top</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const string & </td> |
| <td class="paramname"><em>payload</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>qos</em> = <code>DFLT_QOS</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>retained</em> = <code>DFLT_QOS</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the "Last Will and Testament" (LWT) for the connection. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">top</td><td>The LWT message is published to the this topic. </td></tr> |
| <tr><td class="paramname">payload</td><td>The message payload that is published to the Will Topic, as a string. </td></tr> |
| <tr><td class="paramname">qos</td><td>The message Quality of Service. </td></tr> |
| <tr><td class="paramname">retained</td><td>Tell the broker to keep the LWT message after send to subscribers. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5403217de3ed42bee690bfdc934a9235"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::will_options::will_options </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmqtt_1_1message.html">message</a> & </td> |
| <td class="paramname"><em>msg</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the "Last Will and Testament" (LWT) for the connection. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">msg</td><td>The message that is published to the Will Topic. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac84faf9ea32564d7dafd3195e1dd9c62"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::will_options::will_options </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmqtt_1_1will__options.html">will_options</a> & </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy constructor for the LWT options. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>The other options. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8e2a0464b613425f8b829165cf00438b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::will_options::will_options </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1will__options.html">will_options</a> && </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Move constructor for the LWT options. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>The other options. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a5ee824476eb40b39aabc18ed0feb158b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const_message_ptr mqtt::will_options::get_message </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the LWT message as a message object. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A pointer to a copy of the LWT message. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acba39c10d33a6e3c0245b25830f1ee0c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classmqtt_1_1buffer__ref.html">binary_ref</a>& mqtt::will_options::get_payload </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the LWT message payload. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The LWT message payload. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa6fe0b0fae3537609bc54e746aed07ed"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string mqtt::will_options::get_payload_str </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the LWT message payload as a string. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The LWT message payload as a string. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1876b5c2b1176c2759755f225a91e7c3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int mqtt::will_options::get_qos </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the QoS value for the LWT message. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The QoS value for the LWT message. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3ace4c9e5aef81654cdb5795c0926523"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string mqtt::will_options::get_topic </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the LWT message topic name. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The LWT message topic name. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa9202a426bed90785d641f57cae5925e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mqtt::will_options::is_retained </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the 'retained' flag for the LWT message. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The 'retained' flag for the LWT message. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a38b0ebea7545384f9871920810163834"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmqtt_1_1will__options.html">will_options</a>& mqtt::will_options::operator= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmqtt_1_1will__options.html">will_options</a> & </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy assignment for the LWT options. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>The other options. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3585e7d7dbb471d616737b8bf14602b8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmqtt_1_1will__options.html">will_options</a>& mqtt::will_options::operator= </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1will__options.html">will_options</a> && </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Move assignment for the LWT options. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>The other options. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a132976bc745ba889a4aae76173f2c569"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::will_options::set_payload </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1buffer__ref.html">binary_ref</a> </td> |
| <td class="paramname"><em>msg</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the LWT message text. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">msg</td><td>The LWT message </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7412354ed5599b9bc267464bbacae972"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::will_options::set_payload </td> |
| <td>(</td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>msg</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the LWT message text. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">msg</td><td>The LWT message </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a37b9e92e0b9d339af19bba3a0b30c2c4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::will_options::set_qos </td> |
| <td>(</td> |
| <td class="paramtype">const int </td> |
| <td class="paramname"><em>qos</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the QoS value. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">qos</td><td>The LWT message QoS </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5767dc68cb8bfec285ffcfaf71a5c077"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::will_options::set_retained </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>retained</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the retained flag. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">retained</td><td>Tell the broker to keep the LWT message after send to subscribers. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6f7d6e083440de05cfd631cc3f063240"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::will_options::set_topic </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1buffer__ref.html">string_ref</a> </td> |
| <td class="paramname"><em>top</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the LWT message topic name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">top</td><td>The topic where to sent the message </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/mqtt/<a class="el" href="will__options_8h_source.html">will_options.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><b>mqtt</b></li><li class="navelem"><a class="el" href="classmqtt_1_1will__options.html">will_options</a></li> |
| <li class="footer">Generated on Sun Jul 23 2017 10:24:30 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> |
