| <!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::ssl_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_1ssl__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_1ssl__options-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mqtt::ssl_options Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Holds the set of SSL options for connection. |
| <a href="classmqtt_1_1ssl__options.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="ssl__options_8h_source.html">ssl_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:a99a903f26c0ead60bf090c396287b5e8"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a99a903f26c0ead60bf090c396287b5e8">ptr_t</a> = std::shared_ptr< <a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> ></td></tr> |
| <tr class="memdesc:a99a903f26c0ead60bf090c396287b5e8"><td class="mdescLeft"> </td><td class="mdescRight">Smart/shared pointer to an object of this class. <a href="#a99a903f26c0ead60bf090c396287b5e8">More...</a><br/></td></tr> |
| <tr class="separator:a99a903f26c0ead60bf090c396287b5e8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2861413516a77fbc60964b10a0366f98"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a2861413516a77fbc60964b10a0366f98">const_ptr_t</a> = std::shared_ptr< const <a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> ></td></tr> |
| <tr class="memdesc:a2861413516a77fbc60964b10a0366f98"><td class="mdescLeft"> </td><td class="mdescRight">Smart/shared pointer to a const object of this class. <a href="#a2861413516a77fbc60964b10a0366f98">More...</a><br/></td></tr> |
| <tr class="separator:a2861413516a77fbc60964b10a0366f98"><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:adc0f2a7d60a63e85328d3db2ac9e3414"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc0f2a7d60a63e85328d3db2ac9e3414"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#adc0f2a7d60a63e85328d3db2ac9e3414">ssl_options</a> ()</td></tr> |
| <tr class="memdesc:adc0f2a7d60a63e85328d3db2ac9e3414"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new MqttConnectOptions object using the default values. <br/></td></tr> |
| <tr class="separator:adc0f2a7d60a63e85328d3db2ac9e3414"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a795b4816e2e4f92afd4342a6c6067183"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a795b4816e2e4f92afd4342a6c6067183">ssl_options</a> (const string &trustStore, const string &keyStore, const string &privateKey, const string &privateKeyPassword, const string &enabledCipherSuites, bool enableServerCertAuth)</td></tr> |
| <tr class="memdesc:a795b4816e2e4f92afd4342a6c6067183"><td class="mdescLeft"> </td><td class="mdescRight">Argument constructor. <a href="#a795b4816e2e4f92afd4342a6c6067183">More...</a><br/></td></tr> |
| <tr class="separator:a795b4816e2e4f92afd4342a6c6067183"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a737c181858109f5dba08d45e1798b4d9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a737c181858109f5dba08d45e1798b4d9">ssl_options</a> (const <a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> &opt)</td></tr> |
| <tr class="memdesc:a737c181858109f5dba08d45e1798b4d9"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a737c181858109f5dba08d45e1798b4d9">More...</a><br/></td></tr> |
| <tr class="separator:a737c181858109f5dba08d45e1798b4d9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad0f8a554ad6fc9c34e5c2d216591659d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#ad0f8a554ad6fc9c34e5c2d216591659d">ssl_options</a> (<a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> &&opt)</td></tr> |
| <tr class="memdesc:ad0f8a554ad6fc9c34e5c2d216591659d"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <a href="#ad0f8a554ad6fc9c34e5c2d216591659d">More...</a><br/></td></tr> |
| <tr class="separator:ad0f8a554ad6fc9c34e5c2d216591659d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6eaa6b6a0fd4be1a566e00438709f8ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a6eaa6b6a0fd4be1a566e00438709f8ea">operator=</a> (const <a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> &opt)</td></tr> |
| <tr class="memdesc:a6eaa6b6a0fd4be1a566e00438709f8ea"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment. <a href="#a6eaa6b6a0fd4be1a566e00438709f8ea">More...</a><br/></td></tr> |
| <tr class="separator:a6eaa6b6a0fd4be1a566e00438709f8ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2511b1d8b581a54a3f084a4388ad331b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a2511b1d8b581a54a3f084a4388ad331b">operator=</a> (<a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> &&opt)</td></tr> |
| <tr class="memdesc:a2511b1d8b581a54a3f084a4388ad331b"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment. <a href="#a2511b1d8b581a54a3f084a4388ad331b">More...</a><br/></td></tr> |
| <tr class="separator:a2511b1d8b581a54a3f084a4388ad331b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2b12e5aa88a2fd3a7d357cd26bb7a7e5"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a2b12e5aa88a2fd3a7d357cd26bb7a7e5">get_trust_store</a> () const </td></tr> |
| <tr class="memdesc:a2b12e5aa88a2fd3a7d357cd26bb7a7e5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file containing the public digital certificates trusted by the client. <a href="#a2b12e5aa88a2fd3a7d357cd26bb7a7e5">More...</a><br/></td></tr> |
| <tr class="separator:a2b12e5aa88a2fd3a7d357cd26bb7a7e5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3fb020bc1c137bab4f419a346cba3d62"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a3fb020bc1c137bab4f419a346cba3d62">get_key_store</a> () const </td></tr> |
| <tr class="memdesc:a3fb020bc1c137bab4f419a346cba3d62"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file containing the public certificate chain of the client. <a href="#a3fb020bc1c137bab4f419a346cba3d62">More...</a><br/></td></tr> |
| <tr class="separator:a3fb020bc1c137bab4f419a346cba3d62"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a22ecb55b2b132cc1805ec23c1f00060e"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a22ecb55b2b132cc1805ec23c1f00060e">get_private_key</a> () const </td></tr> |
| <tr class="memdesc:a22ecb55b2b132cc1805ec23c1f00060e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file containing the client's private key. <a href="#a22ecb55b2b132cc1805ec23c1f00060e">More...</a><br/></td></tr> |
| <tr class="separator:a22ecb55b2b132cc1805ec23c1f00060e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac73a5dfbbc8ba4d2ef2747e44cfcf3af"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#ac73a5dfbbc8ba4d2ef2747e44cfcf3af">get_private_key_password</a> () const </td></tr> |
| <tr class="memdesc:ac73a5dfbbc8ba4d2ef2747e44cfcf3af"><td class="mdescLeft"> </td><td class="mdescRight">Returns the password to load the client's privateKey if encrypted. <a href="#ac73a5dfbbc8ba4d2ef2747e44cfcf3af">More...</a><br/></td></tr> |
| <tr class="separator:ac73a5dfbbc8ba4d2ef2747e44cfcf3af"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a97f843305731f50708cdb51373845dcf"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a97f843305731f50708cdb51373845dcf">get_enabled_cipher_suites</a> () const </td></tr> |
| <tr class="memdesc:a97f843305731f50708cdb51373845dcf"><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of cipher suites that the client will present to the server during the SSL handshake. <a href="#a97f843305731f50708cdb51373845dcf">More...</a><br/></td></tr> |
| <tr class="separator:a97f843305731f50708cdb51373845dcf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaedf93daa36cb17e7dc1d63d3b347a96"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#aaedf93daa36cb17e7dc1d63d3b347a96">get_enable_server_cert_auth</a> () const </td></tr> |
| <tr class="memdesc:aaedf93daa36cb17e7dc1d63d3b347a96"><td class="mdescLeft"> </td><td class="mdescRight">Returns the true/false to enable verification of the server certificate . <a href="#aaedf93daa36cb17e7dc1d63d3b347a96">More...</a><br/></td></tr> |
| <tr class="separator:aaedf93daa36cb17e7dc1d63d3b347a96"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa3b98b5f6fccca749c962775dbd1c8c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#aa3b98b5f6fccca749c962775dbd1c8c4">set_trust_store</a> (const string &trustStore)</td></tr> |
| <tr class="memdesc:aa3b98b5f6fccca749c962775dbd1c8c4"><td class="mdescLeft"> </td><td class="mdescRight">Sets the file containing the public digital certificates trusted by the client. <a href="#aa3b98b5f6fccca749c962775dbd1c8c4">More...</a><br/></td></tr> |
| <tr class="separator:aa3b98b5f6fccca749c962775dbd1c8c4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2735d35b147f612f644546394ad952a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a2735d35b147f612f644546394ad952a8">set_key_store</a> (const string &keyStore)</td></tr> |
| <tr class="memdesc:a2735d35b147f612f644546394ad952a8"><td class="mdescLeft"> </td><td class="mdescRight">Sets the file containing the public certificate chain of the client. <a href="#a2735d35b147f612f644546394ad952a8">More...</a><br/></td></tr> |
| <tr class="separator:a2735d35b147f612f644546394ad952a8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afe9b7afbe701d59b0390515dcce563c7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#afe9b7afbe701d59b0390515dcce563c7">set_private_key</a> (const string &privateKey)</td></tr> |
| <tr class="memdesc:afe9b7afbe701d59b0390515dcce563c7"><td class="mdescLeft"> </td><td class="mdescRight">Sets the file containing the client's private key. <a href="#afe9b7afbe701d59b0390515dcce563c7">More...</a><br/></td></tr> |
| <tr class="separator:afe9b7afbe701d59b0390515dcce563c7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c33a1ee28d093a6779b47536e998cb4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a3c33a1ee28d093a6779b47536e998cb4">set_private_key_password</a> (const string &privateKeyPassword)</td></tr> |
| <tr class="memdesc:a3c33a1ee28d093a6779b47536e998cb4"><td class="mdescLeft"> </td><td class="mdescRight">Sets the password to load the client's privateKey if encrypted. <a href="#a3c33a1ee28d093a6779b47536e998cb4">More...</a><br/></td></tr> |
| <tr class="separator:a3c33a1ee28d093a6779b47536e998cb4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0baaa0acc9ee34059116cc976e067ed9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#a0baaa0acc9ee34059116cc976e067ed9">set_enabled_cipher_suites</a> (const string &enabledCipherSuites)</td></tr> |
| <tr class="memdesc:a0baaa0acc9ee34059116cc976e067ed9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the list of cipher suites that the client will present to the server during the SSL handshake. <a href="#a0baaa0acc9ee34059116cc976e067ed9">More...</a><br/></td></tr> |
| <tr class="separator:a0baaa0acc9ee34059116cc976e067ed9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad9ae3ac9f11beb1303522c92c2241550"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1ssl__options.html#ad9ae3ac9f11beb1303522c92c2241550">set_enable_server_cert_auth</a> (bool enablServerCertAuth)</td></tr> |
| <tr class="memdesc:ad9ae3ac9f11beb1303522c92c2241550"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables verification of the server certificate. <a href="#ad9ae3ac9f11beb1303522c92c2241550">More...</a><br/></td></tr> |
| <tr class="separator:ad9ae3ac9f11beb1303522c92c2241550"><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_1ssl__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:a22ee6c8572f60d56b4ce02d5b5439d15"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22ee6c8572f60d56b4ce02d5b5439d15"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>ssl_options_test</b></td></tr> |
| <tr class="separator:a22ee6c8572f60d56b4ce02d5b5439d15"><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 SSL options for connection. </p> |
| </div><h2 class="groupheader">Member Typedef Documentation</h2> |
| <a class="anchor" id="a2861413516a77fbc60964b10a0366f98"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">using <a class="el" href="classmqtt_1_1ssl__options.html#a2861413516a77fbc60964b10a0366f98">mqtt::ssl_options::const_ptr_t</a> = std::shared_ptr<const <a class="el" href="classmqtt_1_1ssl__options.html">ssl_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="a99a903f26c0ead60bf090c396287b5e8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">using <a class="el" href="classmqtt_1_1ssl__options.html#a99a903f26c0ead60bf090c396287b5e8">mqtt::ssl_options::ptr_t</a> = std::shared_ptr<<a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a>></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Smart/shared pointer to an object of this class. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a795b4816e2e4f92afd4342a6c6067183"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::ssl_options::ssl_options </td> |
| <td>(</td> |
| <td class="paramtype">const string & </td> |
| <td class="paramname"><em>trustStore</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const string & </td> |
| <td class="paramname"><em>keyStore</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const string & </td> |
| <td class="paramname"><em>privateKey</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const string & </td> |
| <td class="paramname"><em>privateKeyPassword</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const string & </td> |
| <td class="paramname"><em>enabledCipherSuites</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>enableServerCertAuth</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Argument constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">trustStore</td><td>The file containing the public digital certificates trusted by the client. </td></tr> |
| <tr><td class="paramname">keyStore</td><td>The file containing the public certificate chain of the client. </td></tr> |
| <tr><td class="paramname">privateKey</td><td>The file containing the client's private key. </td></tr> |
| <tr><td class="paramname">privateKeyPassword</td><td>The password to load the client's privateKey if encrypted. </td></tr> |
| <tr><td class="paramname">enabledCipherSuites</td><td>The list of cipher suites that the client will present to the server during the SSL handshake. </td></tr> |
| <tr><td class="paramname">enableServerCertAuth</td><td>True/False option to enable verification of the server certificate </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a737c181858109f5dba08d45e1798b4d9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::ssl_options::ssl_options </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> & </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>The other options to copy. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad0f8a554ad6fc9c34e5c2d216591659d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mqtt::ssl_options::ssl_options </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> && </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Move constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>The other options to move to this one. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="aaedf93daa36cb17e7dc1d63d3b347a96"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool mqtt::ssl_options::get_enable_server_cert_auth </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>Returns the true/false to enable verification of the server certificate . </p> |
| <dl class="section return"><dt>Returns</dt><dd>bool </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a97f843305731f50708cdb51373845dcf"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string mqtt::ssl_options::get_enabled_cipher_suites </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>Returns the list of cipher suites that the client will present to the server during the SSL handshake. </p> |
| <dl class="section return"><dt>Returns</dt><dd>string </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3fb020bc1c137bab4f419a346cba3d62"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string mqtt::ssl_options::get_key_store </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>Returns the file containing the public certificate chain of the client. </p> |
| <dl class="section return"><dt>Returns</dt><dd>string </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a22ecb55b2b132cc1805ec23c1f00060e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string mqtt::ssl_options::get_private_key </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>Returns the file containing the client's private key. </p> |
| <dl class="section return"><dt>Returns</dt><dd>string </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac73a5dfbbc8ba4d2ef2747e44cfcf3af"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string mqtt::ssl_options::get_private_key_password </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>Returns the password to load the client's privateKey if encrypted. </p> |
| <dl class="section return"><dt>Returns</dt><dd>string </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2b12e5aa88a2fd3a7d357cd26bb7a7e5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string mqtt::ssl_options::get_trust_store </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>Returns the file containing the public digital certificates trusted by the client. </p> |
| <dl class="section return"><dt>Returns</dt><dd>string </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6eaa6b6a0fd4be1a566e00438709f8ea"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a>& mqtt::ssl_options::operator= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> & </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy assignment. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>The other options to copy. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A reference to this object. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2511b1d8b581a54a3f084a4388ad331b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a>& mqtt::ssl_options::operator= </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmqtt_1_1ssl__options.html">ssl_options</a> && </td> |
| <td class="paramname"><em>opt</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Move assignment. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">opt</td><td>The other options to move to this one. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A reference to this object. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad9ae3ac9f11beb1303522c92c2241550"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::ssl_options::set_enable_server_cert_auth </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>enablServerCertAuth</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Enables or disables verification of the server certificate. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">enablServerCertAuth</td><td>enable/disable verification of the server certificate </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0baaa0acc9ee34059116cc976e067ed9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::ssl_options::set_enabled_cipher_suites </td> |
| <td>(</td> |
| <td class="paramtype">const string & </td> |
| <td class="paramname"><em>enabledCipherSuites</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the list of cipher suites that the client will present to the server during the SSL handshake. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">enabledCipherSuites</td><td>The list of cipher suites that the client will present to the server during the SSL handshake. For a full explanation of the cipher list format, please see the OpenSSL on-line documentation: <a href="http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT">http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT</a> If this setting is ommitted, its default value will be "ALL", that is, all the cipher suites -excluding those offering no encryption- will be considered. This setting can be used to set an SSL anonymous connection (empty string value, for instance). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2735d35b147f612f644546394ad952a8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::ssl_options::set_key_store </td> |
| <td>(</td> |
| <td class="paramtype">const string & </td> |
| <td class="paramname"><em>keyStore</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the file containing the public certificate chain of the client. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">keyStore</td><td>The file in PEM format containing the public certificate chain of the client. It may also include the client's private key. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="afe9b7afbe701d59b0390515dcce563c7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::ssl_options::set_private_key </td> |
| <td>(</td> |
| <td class="paramtype">const string & </td> |
| <td class="paramname"><em>privateKey</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the file containing the client's private key. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">privateKey</td><td>If not included in the sslKeyStore, this is the file in PEM format containing the client's private key. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3c33a1ee28d093a6779b47536e998cb4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::ssl_options::set_private_key_password </td> |
| <td>(</td> |
| <td class="paramtype">const string & </td> |
| <td class="paramname"><em>privateKeyPassword</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the password to load the client's privateKey if encrypted. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">privateKeyPassword</td><td>The password to load the privateKey if encrypted. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa3b98b5f6fccca749c962775dbd1c8c4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mqtt::ssl_options::set_trust_store </td> |
| <td>(</td> |
| <td class="paramtype">const string & </td> |
| <td class="paramname"><em>trustStore</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the file containing the public digital certificates trusted by the client. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">trustStore</td><td>The file in PEM format containing the public digital certificates trusted by the client. </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="ssl__options_8h_source.html">ssl_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_1ssl__options.html">ssl_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> |
