files/cppdoc/classmqtt_1_1connect__options.html - gerrit/www.eclipse.org/paho - Git at Google

 <!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::connect_options 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_1connect__options.html">connect_options</a>
   </div>
 </div>
 <div class="contents">
 <h1>mqtt::connect_options Class Reference</h1><!-- doxytag: class="mqtt::connect_options" -->
 <p>Holds the set of options that control how the <a class="el" href="classmqtt_1_1client.html" title="Lightweight client for talking to an MQTT server using methods that block until an...">client</a> connects to a server.
 <a href="#_details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="connect__options_8h_source.html">connect_options.h</a>&gt;</code></p>

 <p><a href="classmqtt_1_1connect__options-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="a7e8d78cc1d555b18e74f5ce2a52d4caa"></a><!-- doxytag: member="mqtt::connect_options::ptr_t" ref="a7e8d78cc1d555b18e74f5ce2a52d4caa" args="" -->
 typedef std::shared_ptr<br class="typebreak"/>
 &lt; <a class="el" href="classmqtt_1_1connect__options.html">connect_options</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a7e8d78cc1d555b18e74f5ce2a52d4caa">ptr_t</a></td></tr>
 <tr><td class="mdescLeft">&nbsp;</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="a5811ad2a2bbbb02b04d79b08530349a3"></a><!-- doxytag: member="mqtt::connect_options::connect_options" ref="a5811ad2a2bbbb02b04d79b08530349a3" args="()" -->
 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a5811ad2a2bbbb02b04d79b08530349a3">connect_options</a> ()</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a new MqttConnectOptions object using the default values. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a259f3095aef935973902485c9716fa18">get_connection_timeout</a> () const </td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the connection timeout value.  <a href="#a259f3095aef935973902485c9716fa18"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a5e774ce28ff7bdcebd0f49b5620596a7">get_keep_alive_interval</a> () const </td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the "keep alive" interval.  <a href="#a5e774ce28ff7bdcebd0f49b5620596a7"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#aa651f99bb39cf32a7bbd4a006747cfa6">get_password</a> () const </td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the password to use for the connection.  <a href="#aa651f99bb39cf32a7bbd4a006747cfa6"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ab1f82172788574ffbba8ea9211261a56">get_user_name</a> () const </td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the socket factory that will be used when connecting, or null if one has not been set.  <a href="#ab1f82172788574ffbba8ea9211261a56"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a3f0b0c3d2d2cc2719fd7c681c2c13689">get_will_destination</a> () const </td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a> to be used for last will and testament (LWT).  <a href="#a3f0b0c3d2d2cc2719fd7c681c2c13689"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmqtt_1_1message.html">message</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a087b0be7949039373eb83c885fe41aea">get_will_message</a> () const </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> to be sent as last will and testament (LWT).  <a href="#a087b0be7949039373eb83c885fe41aea"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a062dd43eb33c096559678777a9a7f2fe">is_clean_session</a> () const </td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether the server should remember state for the <a class="el" href="classmqtt_1_1client.html" title="Lightweight client for talking to an MQTT server using methods that block until an...">client</a> across reconnects.  <a href="#a062dd43eb33c096559678777a9a7f2fe"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a403bdb15d0383f160e590cdb19039c30">set_clean_session</a> (bool cleanSession)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets whether the server should remember state for the <a class="el" href="classmqtt_1_1client.html" title="Lightweight client for talking to an MQTT server using methods that block until an...">client</a> across reconnects.  <a href="#a403bdb15d0383f160e590cdb19039c30"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a21d0565ce539b40097bb911c50ecbc60">set_connection_timeout</a> (int timeout)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the connection timeout value.  <a href="#a21d0565ce539b40097bb911c50ecbc60"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a8f7c99d453da95192b15641a80286441">set_keep_alive_interval</a> (int keepAliveInterval)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the "keep alive" interval.  <a href="#a8f7c99d453da95192b15641a80286441"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca62e4465ce0c18f9442ff160be26a7f"></a><!-- doxytag: member="mqtt::connect_options::set_password" ref="aca62e4465ce0c18f9442ff160be26a7f" args="(const std::string &amp;password)" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#aca62e4465ce0c18f9442ff160be26a7f">set_password</a> (const std::string &amp;password)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the password to use for the connection. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a4ff426fbb1c7d68294da67b9d5e1062f">set_user_name</a> (const std::string &amp;userName)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the SocketFactory to use.  <a href="#a4ff426fbb1c7d68294da67b9d5e1062f"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#a73bfee26dd549531fc7095e2d43496bc">set_will</a> (const <a class="el" href="classmqtt_1_1topic.html">topic</a> &amp;top, void *payload, size_t n, int qos, bool retained)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the "Last Will and Testament" (LWT) for the connection.  <a href="#a73bfee26dd549531fc7095e2d43496bc"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#acd9951bb9a28a3c9f2d5926057f16d5a">set_will</a> (const std::string &amp;top, void *payload, size_t n, int qos, bool retained)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the "Last Will and Testament" (LWT) for the connection.  <a href="#acd9951bb9a28a3c9f2d5926057f16d5a"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ad25ff3c16c02bbae614c78f7be44d1e2">set_will</a> (const std::string &amp;top, <a class="el" href="classmqtt_1_1message.html">message</a> msg, int qos, bool retained)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets up the will information, based on the supplied parameters.  <a href="#ad25ff3c16c02bbae614c78f7be44d1e2"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05882d1647d91dcf01184cf63ca95de8"></a><!-- doxytag: member="mqtt::connect_options::to_str" ref="a05882d1647d91dcf01184cf63ca95de8" args="() const " -->
 std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>to_str</b> () const </td></tr>
 <tr><td colspan="2"><h2>Friends</h2></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac39954340d8b15edaa883af1bcfcf7ae"></a><!-- doxytag: member="mqtt::connect_options::async_client" ref="ac39954340d8b15edaa883af1bcfcf7ae" args="" -->
 class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1connect__options.html#ac39954340d8b15edaa883af1bcfcf7ae">async_client</a></td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The <a class="el" href="classmqtt_1_1client.html" title="Lightweight client for talking to an MQTT server using methods that block until an...">client</a> has special access. <br/></td></tr>
 </table>
 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 <p>Holds the set of options that control how the <a class="el" href="classmqtt_1_1client.html" title="Lightweight client for talking to an MQTT server using methods that block until an...">client</a> connects to a server. </p>
 <hr/><h2>Member Function Documentation</h2>
 <a class="anchor" id="a259f3095aef935973902485c9716fa18"></a><!-- doxytag: member="mqtt::connect_options::get_connection_timeout" ref="a259f3095aef935973902485c9716fa18" args="() const " -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">int mqtt::connect_options::get_connection_timeout </td>
           <td>(</td>
           <td class="paramname"></td>
           <td>&nbsp;)&nbsp;</td>
           <td> const</td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Returns the connection timeout value. </p>
 <dl class="return"><dt><b>Returns:</b></dt><dd>int </dd></dl>

 </div>
 </div>
 <a class="anchor" id="a5e774ce28ff7bdcebd0f49b5620596a7"></a><!-- doxytag: member="mqtt::connect_options::get_keep_alive_interval" ref="a5e774ce28ff7bdcebd0f49b5620596a7" args="() const " -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">int mqtt::connect_options::get_keep_alive_interval </td>
           <td>(</td>
           <td class="paramname"></td>
           <td>&nbsp;)&nbsp;</td>
           <td> const<code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Returns the "keep alive" interval. </p>
 <dl class="return"><dt><b>Returns:</b></dt><dd>int </dd></dl>

 </div>
 </div>
 <a class="anchor" id="aa651f99bb39cf32a7bbd4a006747cfa6"></a><!-- doxytag: member="mqtt::connect_options::get_password" ref="aa651f99bb39cf32a7bbd4a006747cfa6" args="() const " -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">std::string mqtt::connect_options::get_password </td>
           <td>(</td>
           <td class="paramname"></td>
           <td>&nbsp;)&nbsp;</td>
           <td> const<code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Returns the password to use for the connection. </p>
 <dl class="return"><dt><b>Returns:</b></dt><dd>std::string </dd></dl>

 </div>
 </div>
 <a class="anchor" id="ab1f82172788574ffbba8ea9211261a56"></a><!-- doxytag: member="mqtt::connect_options::get_user_name" ref="ab1f82172788574ffbba8ea9211261a56" args="() const " -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">std::string mqtt::connect_options::get_user_name </td>
           <td>(</td>
           <td class="paramname"></td>
           <td>&nbsp;)&nbsp;</td>
           <td> const<code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Returns the socket factory that will be used when connecting, or null if one has not been set. </p>
 <p>Returns the SSL properties for the connection. Returns the user name to use for the connection. </p>
 <dl class="return"><dt><b>Returns:</b></dt><dd>std::string </dd></dl>

 </div>
 </div>
 <a class="anchor" id="a3f0b0c3d2d2cc2719fd7c681c2c13689"></a><!-- doxytag: member="mqtt::connect_options::get_will_destination" ref="a3f0b0c3d2d2cc2719fd7c681c2c13689" args="() const " -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">std::string mqtt::connect_options::get_will_destination </td>
           <td>(</td>
           <td class="paramname"></td>
           <td>&nbsp;)&nbsp;</td>
           <td> const</td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Returns the <a class="el" href="classmqtt_1_1topic.html" title="Represents a topic destination, used for publish/subscribe messaging.">topic</a> to be used for last will and testament (LWT). </p>
 <dl class="return"><dt><b>Returns:</b></dt><dd>std::string </dd></dl>

 </div>
 </div>
 <a class="anchor" id="a087b0be7949039373eb83c885fe41aea"></a><!-- doxytag: member="mqtt::connect_options::get_will_message" ref="a087b0be7949039373eb83c885fe41aea" args="() const " -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname"><a class="el" href="classmqtt_1_1message.html">message</a> mqtt::connect_options::get_will_message </td>
           <td>(</td>
           <td class="paramname"></td>
           <td>&nbsp;)&nbsp;</td>
           <td> const</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> to be sent as last will and testament (LWT). </p>
 <dl class="return"><dt><b>Returns:</b></dt><dd>MqttMessage </dd></dl>

 </div>
 </div>
 <a class="anchor" id="a062dd43eb33c096559678777a9a7f2fe"></a><!-- doxytag: member="mqtt::connect_options::is_clean_session" ref="a062dd43eb33c096559678777a9a7f2fe" args="() const " -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">bool mqtt::connect_options::is_clean_session </td>
           <td>(</td>
           <td class="paramname"></td>
           <td>&nbsp;)&nbsp;</td>
           <td> const<code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Returns whether the server should remember state for the <a class="el" href="classmqtt_1_1client.html" title="Lightweight client for talking to an MQTT server using methods that block until an...">client</a> across reconnects. </p>
 <dl class="return"><dt><b>Returns:</b></dt><dd>bool </dd></dl>

 </div>
 </div>
 <a class="anchor" id="a403bdb15d0383f160e590cdb19039c30"></a><!-- doxytag: member="mqtt::connect_options::set_clean_session" ref="a403bdb15d0383f160e590cdb19039c30" args="(bool cleanSession)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void mqtt::connect_options::set_clean_session </td>
           <td>(</td>
           <td class="paramtype">bool&nbsp;</td>
           <td class="paramname"> <em>cleanSession</em></td>
           <td>&nbsp;)&nbsp;</td>
           <td><code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Sets whether the server should remember state for the <a class="el" href="classmqtt_1_1client.html" title="Lightweight client for talking to an MQTT server using methods that block until an...">client</a> across reconnects. </p>
 <dl><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>cleanSession</em>&nbsp;</td><td></td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <a class="anchor" id="a21d0565ce539b40097bb911c50ecbc60"></a><!-- doxytag: member="mqtt::connect_options::set_connection_timeout" ref="a21d0565ce539b40097bb911c50ecbc60" args="(int timeout)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void mqtt::connect_options::set_connection_timeout </td>
           <td>(</td>
           <td class="paramtype">int&nbsp;</td>
           <td class="paramname"> <em>timeout</em></td>
           <td>&nbsp;)&nbsp;</td>
           <td><code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Sets the connection timeout value. </p>
 <dl><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td></td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <a class="anchor" id="a8f7c99d453da95192b15641a80286441"></a><!-- doxytag: member="mqtt::connect_options::set_keep_alive_interval" ref="a8f7c99d453da95192b15641a80286441" args="(int keepAliveInterval)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void mqtt::connect_options::set_keep_alive_interval </td>
           <td>(</td>
           <td class="paramtype">int&nbsp;</td>
           <td class="paramname"> <em>keepAliveInterval</em></td>
           <td>&nbsp;)&nbsp;</td>
           <td><code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Sets the "keep alive" interval. </p>
 <dl><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>keepAliveInterval</em>&nbsp;</td><td></td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <a class="anchor" id="a4ff426fbb1c7d68294da67b9d5e1062f"></a><!-- doxytag: member="mqtt::connect_options::set_user_name" ref="a4ff426fbb1c7d68294da67b9d5e1062f" args="(const std::string &amp;userName)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void mqtt::connect_options::set_user_name </td>
           <td>(</td>
           <td class="paramtype">const std::string &amp;&nbsp;</td>
           <td class="paramname"> <em>userName</em></td>
           <td>&nbsp;)&nbsp;</td>
           <td></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Sets the SocketFactory to use. </p>
 <p>Sets the SSL properties for the connection. Sets the user name to use for the connection. </p>
 <dl><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>userName</em>&nbsp;</td><td></td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <a class="anchor" id="ad25ff3c16c02bbae614c78f7be44d1e2"></a><!-- doxytag: member="mqtt::connect_options::set_will" ref="ad25ff3c16c02bbae614c78f7be44d1e2" args="(const std::string &amp;top, message msg, int qos, bool retained)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void mqtt::connect_options::set_will </td>
           <td>(</td>
           <td class="paramtype">const std::string &amp;&nbsp;</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_1message.html">message</a>&nbsp;</td>
           <td class="paramname"> <em>msg</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">int&nbsp;</td>
           <td class="paramname"> <em>qos</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">bool&nbsp;</td>
           <td class="paramname"> <em>retained</em></td><td>&nbsp;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td><td></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Sets up the will information, based on the supplied parameters. </p>
 <dl><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>top</em>&nbsp;</td><td></td></tr>
     <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td></td></tr>
     <tr><td valign="top"></td><td valign="top"><em>qos</em>&nbsp;</td><td></td></tr>
     <tr><td valign="top"></td><td valign="top"><em>retained</em>&nbsp;</td><td></td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <a class="anchor" id="acd9951bb9a28a3c9f2d5926057f16d5a"></a><!-- doxytag: member="mqtt::connect_options::set_will" ref="acd9951bb9a28a3c9f2d5926057f16d5a" args="(const std::string &amp;top, void *payload, size_t n, int qos, bool retained)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void mqtt::connect_options::set_will </td>
           <td>(</td>
           <td class="paramtype">const std::string &amp;&nbsp;</td>
           <td class="paramname"> <em>top</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">void *&nbsp;</td>
           <td class="paramname"> <em>payload</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">size_t&nbsp;</td>
           <td class="paramname"> <em>n</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">int&nbsp;</td>
           <td class="paramname"> <em>qos</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">bool&nbsp;</td>
           <td class="paramname"> <em>retained</em></td><td>&nbsp;</td>
         </tr>
         <tr>
           <td></td>
           <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><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>top</em>&nbsp;</td><td></td></tr>
     <tr><td valign="top"></td><td valign="top"><em>payload</em>&nbsp;</td><td></td></tr>
     <tr><td valign="top"></td><td valign="top"><em>n</em>&nbsp;</td><td></td></tr>
     <tr><td valign="top"></td><td valign="top"><em>qos</em>&nbsp;</td><td></td></tr>
     <tr><td valign="top"></td><td valign="top"><em>retained</em>&nbsp;</td><td></td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <a class="anchor" id="a73bfee26dd549531fc7095e2d43496bc"></a><!-- doxytag: member="mqtt::connect_options::set_will" ref="a73bfee26dd549531fc7095e2d43496bc" args="(const topic &amp;top, void *payload, size_t n, int qos, bool retained)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void mqtt::connect_options::set_will </td>
           <td>(</td>
           <td class="paramtype">const <a class="el" href="classmqtt_1_1topic.html">topic</a> &amp;&nbsp;</td>
           <td class="paramname"> <em>top</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">void *&nbsp;</td>
           <td class="paramname"> <em>payload</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">size_t&nbsp;</td>
           <td class="paramname"> <em>n</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">int&nbsp;</td>
           <td class="paramname"> <em>qos</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">bool&nbsp;</td>
           <td class="paramname"> <em>retained</em></td><td>&nbsp;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td><td><code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Sets the "Last Will and Testament" (LWT) for the connection. </p>
 <dl><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>top</em>&nbsp;</td><td></td></tr>
     <tr><td valign="top"></td><td valign="top"><em>payload</em>&nbsp;</td><td></td></tr>
     <tr><td valign="top"></td><td valign="top"><em>n</em>&nbsp;</td><td></td></tr>
     <tr><td valign="top"></td><td valign="top"><em>qos</em>&nbsp;</td><td></td></tr>
     <tr><td valign="top"></td><td valign="top"><em>retained</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="connect__options_8h_source.html">connect_options.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>