| <!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> |
| <link rel="canonical" href="https://ignite.apache.org/releases/latest/cppdoc/classignite_1_1thin_1_1IgniteClientConfiguration.html" /> |
| |
| |
| <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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title> Apache Ignite C++: ignite::thin::IgniteClientConfiguration 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="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-61232409-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script></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="ignite_logo.png"/></td> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname"> Apache Ignite C++ |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </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 id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1thin.html">thin</a></li><li class="navelem"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html">IgniteClientConfiguration</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classignite_1_1thin_1_1IgniteClientConfiguration-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">ignite::thin::IgniteClientConfiguration Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="classignite_1_1Ignite.html" title="Main interface to operate with Ignite. ">Ignite</a> thin client configuration. |
| <a href="classignite_1_1thin_1_1IgniteClientConfiguration.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="ignite__client__configuration_8h_source.html">ignite_client_configuration.h</a>></code></p> |
| <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:a65fedd44769a44fa94d68f15fb9168ce"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a65fedd44769a44fa94d68f15fb9168ce">IgniteClientConfiguration</a> ()</td></tr> |
| <tr class="memdesc:a65fedd44769a44fa94d68f15fb9168ce"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a65fedd44769a44fa94d68f15fb9168ce">More...</a><br /></td></tr> |
| <tr class="separator:a65fedd44769a44fa94d68f15fb9168ce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9a1c17fe01990a4dd1449aba41d3638c"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a9a1c17fe01990a4dd1449aba41d3638c">GetEndPoints</a> () const</td></tr> |
| <tr class="memdesc:a9a1c17fe01990a4dd1449aba41d3638c"><td class="mdescLeft"> </td><td class="mdescRight">Get server end points. <a href="#a9a1c17fe01990a4dd1449aba41d3638c">More...</a><br /></td></tr> |
| <tr class="separator:a9a1c17fe01990a4dd1449aba41d3638c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a57dbf8199cd60518c80dd95b0dead9e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a57dbf8199cd60518c80dd95b0dead9e8">SetEndPoints</a> (const std::string &endPoints)</td></tr> |
| <tr class="memdesc:a57dbf8199cd60518c80dd95b0dead9e8"><td class="mdescLeft"> </td><td class="mdescRight">Set addresses of the remote servers to connect. <a href="#a57dbf8199cd60518c80dd95b0dead9e8">More...</a><br /></td></tr> |
| <tr class="separator:a57dbf8199cd60518c80dd95b0dead9e8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adad70af902bc62cecbb4577af87e087d"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#adad70af902bc62cecbb4577af87e087d">GetUser</a> () const</td></tr> |
| <tr class="memdesc:adad70af902bc62cecbb4577af87e087d"><td class="mdescLeft"> </td><td class="mdescRight">Get user name used for the authentication. <a href="#adad70af902bc62cecbb4577af87e087d">More...</a><br /></td></tr> |
| <tr class="separator:adad70af902bc62cecbb4577af87e087d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2699b733dec083ad203827237da76cbe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a2699b733dec083ad203827237da76cbe">SetUser</a> (const std::string &user)</td></tr> |
| <tr class="memdesc:a2699b733dec083ad203827237da76cbe"><td class="mdescLeft"> </td><td class="mdescRight">Set user name to use for the authentication. <a href="#a2699b733dec083ad203827237da76cbe">More...</a><br /></td></tr> |
| <tr class="separator:a2699b733dec083ad203827237da76cbe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac5efa32c35ad40a309e4a0e7f6e85236"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#ac5efa32c35ad40a309e4a0e7f6e85236">GetPassword</a> () const</td></tr> |
| <tr class="memdesc:ac5efa32c35ad40a309e4a0e7f6e85236"><td class="mdescLeft"> </td><td class="mdescRight">Get password used for the authentication. <a href="#ac5efa32c35ad40a309e4a0e7f6e85236">More...</a><br /></td></tr> |
| <tr class="separator:ac5efa32c35ad40a309e4a0e7f6e85236"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abcb462bcae7e29f81d6ee9ff71e1321d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#abcb462bcae7e29f81d6ee9ff71e1321d">SetPassword</a> (const std::string &password)</td></tr> |
| <tr class="memdesc:abcb462bcae7e29f81d6ee9ff71e1321d"><td class="mdescLeft"> </td><td class="mdescRight">Set password to use for the authentication. <a href="#abcb462bcae7e29f81d6ee9ff71e1321d">More...</a><br /></td></tr> |
| <tr class="separator:abcb462bcae7e29f81d6ee9ff71e1321d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a014e63a9023de64e99fe70166382ae1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structignite_1_1thin_1_1SslMode.html#ad952e796d54c3c7e4ff72ce84762af8a">SslMode::Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a014e63a9023de64e99fe70166382ae1b">GetSslMode</a> () const</td></tr> |
| <tr class="memdesc:a014e63a9023de64e99fe70166382ae1b"><td class="mdescLeft"> </td><td class="mdescRight">Get SSL mode. <a href="#a014e63a9023de64e99fe70166382ae1b">More...</a><br /></td></tr> |
| <tr class="separator:a014e63a9023de64e99fe70166382ae1b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a254e0351a4430280c81ee7cb1ad324e3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a254e0351a4430280c81ee7cb1ad324e3">SetSslMode</a> (<a class="el" href="structignite_1_1thin_1_1SslMode.html#ad952e796d54c3c7e4ff72ce84762af8a">SslMode::Type</a> sslMode)</td></tr> |
| <tr class="memdesc:a254e0351a4430280c81ee7cb1ad324e3"><td class="mdescLeft"> </td><td class="mdescRight">Set SSL mode. <a href="#a254e0351a4430280c81ee7cb1ad324e3">More...</a><br /></td></tr> |
| <tr class="separator:a254e0351a4430280c81ee7cb1ad324e3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae1526edc00777c7afc4ba8fc3780cc3c"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#ae1526edc00777c7afc4ba8fc3780cc3c">GetSslCertFile</a> () const</td></tr> |
| <tr class="memdesc:ae1526edc00777c7afc4ba8fc3780cc3c"><td class="mdescLeft"> </td><td class="mdescRight">Get file path to SSL certificate to use during connection establishment. <a href="#ae1526edc00777c7afc4ba8fc3780cc3c">More...</a><br /></td></tr> |
| <tr class="separator:ae1526edc00777c7afc4ba8fc3780cc3c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a41b693eb6303d4617bc338b6afa77318"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a41b693eb6303d4617bc338b6afa77318">SetSslCertFile</a> (const std::string &sslCertFile)</td></tr> |
| <tr class="memdesc:a41b693eb6303d4617bc338b6afa77318"><td class="mdescLeft"> </td><td class="mdescRight">Set file path to SSL certificate to use during connection establishment. <a href="#a41b693eb6303d4617bc338b6afa77318">More...</a><br /></td></tr> |
| <tr class="separator:a41b693eb6303d4617bc338b6afa77318"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9695bedbd91dc4037c26d940afe68955"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a9695bedbd91dc4037c26d940afe68955">GetSslKeyFile</a> () const</td></tr> |
| <tr class="memdesc:a9695bedbd91dc4037c26d940afe68955"><td class="mdescLeft"> </td><td class="mdescRight">Get file path to SSL private key to use during connection establishment. <a href="#a9695bedbd91dc4037c26d940afe68955">More...</a><br /></td></tr> |
| <tr class="separator:a9695bedbd91dc4037c26d940afe68955"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa21d7538c5aebb18be6593eb629dc464"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#aa21d7538c5aebb18be6593eb629dc464">SetSslKeyFile</a> (const std::string &sslKeyFile)</td></tr> |
| <tr class="memdesc:aa21d7538c5aebb18be6593eb629dc464"><td class="mdescLeft"> </td><td class="mdescRight">Set file path to SSL private key to use during connection establishment. <a href="#aa21d7538c5aebb18be6593eb629dc464">More...</a><br /></td></tr> |
| <tr class="separator:aa21d7538c5aebb18be6593eb629dc464"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afb019c91d487e7eb9719ec192b7404ff"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#afb019c91d487e7eb9719ec192b7404ff">GetSslCaFile</a> () const</td></tr> |
| <tr class="memdesc:afb019c91d487e7eb9719ec192b7404ff"><td class="mdescLeft"> </td><td class="mdescRight">Get file path to SSL certificate authority to authenticate server certificate during connection establishment. <a href="#afb019c91d487e7eb9719ec192b7404ff">More...</a><br /></td></tr> |
| <tr class="separator:afb019c91d487e7eb9719ec192b7404ff"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaac36e365275decb20dc8767c3587cb5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#aaac36e365275decb20dc8767c3587cb5">SetSslCaFile</a> (const std::string &sslCaFile)</td></tr> |
| <tr class="memdesc:aaac36e365275decb20dc8767c3587cb5"><td class="mdescLeft"> </td><td class="mdescRight">Set file path to SSL certificate authority to authenticate server certificate during connection establishment. <a href="#aaac36e365275decb20dc8767c3587cb5">More...</a><br /></td></tr> |
| <tr class="separator:aaac36e365275decb20dc8767c3587cb5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9b85835768eae4e4c507016f8e92ca9f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a9b85835768eae4e4c507016f8e92ca9f">SetPartitionAwareness</a> (bool enable)</td></tr> |
| <tr class="memdesc:a9b85835768eae4e4c507016f8e92ca9f"><td class="mdescLeft"> </td><td class="mdescRight">Set Partition Awareness. <a href="#a9b85835768eae4e4c507016f8e92ca9f">More...</a><br /></td></tr> |
| <tr class="separator:a9b85835768eae4e4c507016f8e92ca9f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a645466ec426bb804250d3bc08eb24bc3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a645466ec426bb804250d3bc08eb24bc3">IsPartitionAwareness</a> () const</td></tr> |
| <tr class="memdesc:a645466ec426bb804250d3bc08eb24bc3"><td class="mdescLeft"> </td><td class="mdescRight">Get Partition Awareness flag. <a href="#a645466ec426bb804250d3bc08eb24bc3">More...</a><br /></td></tr> |
| <tr class="separator:a645466ec426bb804250d3bc08eb24bc3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classignite_1_1Ignite.html" title="Main interface to operate with Ignite. ">Ignite</a> thin client configuration. </p> |
| <p>Used to configure <a class="el" href="classignite_1_1thin_1_1IgniteClient.html" title="Ignite client class. ">IgniteClient</a>. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a65fedd44769a44fa94d68f15fb9168ce"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a65fedd44769a44fa94d68f15fb9168ce">◆ </a></span>IgniteClientConfiguration()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ignite::thin::IgniteClientConfiguration::IgniteClientConfiguration </td> |
| <td>(</td> |
| <td class="paramname"></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>Default constructor. </p> |
| <p>Constructs configuration with all parameters set to default values. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a9a1c17fe01990a4dd1449aba41d3638c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9a1c17fe01990a4dd1449aba41d3638c">◆ </a></span>GetEndPoints()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& ignite::thin::IgniteClientConfiguration::GetEndPoints </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>Get server end points. </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a57dbf8199cd60518c80dd95b0dead9e8" title="Set addresses of the remote servers to connect. ">SetEndPoints</a> for format. </dd></dl> |
| <dl class="section return"><dt>Returns</dt><dd>Server end points. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ac5efa32c35ad40a309e4a0e7f6e85236"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac5efa32c35ad40a309e4a0e7f6e85236">◆ </a></span>GetPassword()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& ignite::thin::IgniteClientConfiguration::GetPassword </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>Get password used for the authentication. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Password. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="afb019c91d487e7eb9719ec192b7404ff"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afb019c91d487e7eb9719ec192b7404ff">◆ </a></span>GetSslCaFile()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& ignite::thin::IgniteClientConfiguration::GetSslCaFile </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>Get file path to SSL certificate authority to authenticate server certificate during connection establishment. </p> |
| <dl class="section return"><dt>Returns</dt><dd>File path to SSL certificate authority. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae1526edc00777c7afc4ba8fc3780cc3c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae1526edc00777c7afc4ba8fc3780cc3c">◆ </a></span>GetSslCertFile()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& ignite::thin::IgniteClientConfiguration::GetSslCertFile </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>Get file path to SSL certificate to use during connection establishment. </p> |
| <dl class="section return"><dt>Returns</dt><dd>File path to SSL certificate. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a9695bedbd91dc4037c26d940afe68955"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9695bedbd91dc4037c26d940afe68955">◆ </a></span>GetSslKeyFile()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& ignite::thin::IgniteClientConfiguration::GetSslKeyFile </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>Get file path to SSL private key to use during connection establishment. </p> |
| <dl class="section return"><dt>Returns</dt><dd>File path to SSL private key. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a014e63a9023de64e99fe70166382ae1b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a014e63a9023de64e99fe70166382ae1b">◆ </a></span>GetSslMode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structignite_1_1thin_1_1SslMode.html#ad952e796d54c3c7e4ff72ce84762af8a">SslMode::Type</a> ignite::thin::IgniteClientConfiguration::GetSslMode </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>Get SSL mode. </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="structignite_1_1thin_1_1SslMode.html" title="SSL Mode. ">SslMode</a> for details.</dd></dl> |
| <dl class="section return"><dt>Returns</dt><dd>SSL mode. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="adad70af902bc62cecbb4577af87e087d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adad70af902bc62cecbb4577af87e087d">◆ </a></span>GetUser()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& ignite::thin::IgniteClientConfiguration::GetUser </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>Get user name used for the authentication. </p> |
| <dl class="section return"><dt>Returns</dt><dd>User name. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a645466ec426bb804250d3bc08eb24bc3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a645466ec426bb804250d3bc08eb24bc3">◆ </a></span>IsPartitionAwareness()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool ignite::thin::IgniteClientConfiguration::IsPartitionAwareness </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>Get Partition Awareness flag. </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a9b85835768eae4e4c507016f8e92ca9f" title="Set Partition Awareness. ">SetPartitionAwareness()</a> for details.</dd></dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> if partition awareness is enabled and <code>false</code> otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a57dbf8199cd60518c80dd95b0dead9e8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a57dbf8199cd60518c80dd95b0dead9e8">◆ </a></span>SetEndPoints()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::thin::IgniteClientConfiguration::SetEndPoints </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>endPoints</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>Set addresses of the remote servers to connect. </p> |
| <p>The format of the addresses is: <host>[:<port>[..<port_range>]]. If port is not specified, default port is used (10800). You can enlist several hosts separated by comma.</p> |
| <p>For example: "localhost,example.com:12345,127.0.0.1:10800..10900,192.168.3.80:5893".</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">endPoints</td><td>Addressess of the remote servers to connect. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a9b85835768eae4e4c507016f8e92ca9f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9b85835768eae4e4c507016f8e92ca9f">◆ </a></span>SetPartitionAwareness()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::thin::IgniteClientConfiguration::SetPartitionAwareness </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>enable</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>Set Partition Awareness. </p> |
| <p>Enable or disable feature that enables thin client to consider data affinity when making requests to the cluster. It means, thin client is going to connect to all available cluster servers listed by <a class="el" href="classignite_1_1thin_1_1IgniteClientConfiguration.html#a57dbf8199cd60518c80dd95b0dead9e8" title="Set addresses of the remote servers to connect. ">SetEndPoints()</a> method and try to send request to a node which stores related data.</p> |
| <p>Disabled by default.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">enable</td><td>Enable partition awareness. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="abcb462bcae7e29f81d6ee9ff71e1321d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abcb462bcae7e29f81d6ee9ff71e1321d">◆ </a></span>SetPassword()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::thin::IgniteClientConfiguration::SetPassword </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>password</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>Set password to use for the authentication. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">password</td><td>Password. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aaac36e365275decb20dc8767c3587cb5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaac36e365275decb20dc8767c3587cb5">◆ </a></span>SetSslCaFile()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::thin::IgniteClientConfiguration::SetSslCaFile </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>sslCaFile</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>Set file path to SSL certificate authority to authenticate server certificate during connection establishment. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sslCaFile</td><td>File path to SSL certificate authority. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a41b693eb6303d4617bc338b6afa77318"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a41b693eb6303d4617bc338b6afa77318">◆ </a></span>SetSslCertFile()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::thin::IgniteClientConfiguration::SetSslCertFile </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>sslCertFile</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>Set file path to SSL certificate to use during connection establishment. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sslCertFile</td><td>File path to SSL certificate. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aa21d7538c5aebb18be6593eb629dc464"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa21d7538c5aebb18be6593eb629dc464">◆ </a></span>SetSslKeyFile()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::thin::IgniteClientConfiguration::SetSslKeyFile </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>sslKeyFile</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>Set file path to SSL private key to use during connection establishment. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sslKeyFile</td><td>File path to SSL private key. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a254e0351a4430280c81ee7cb1ad324e3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a254e0351a4430280c81ee7cb1ad324e3">◆ </a></span>SetSslMode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::thin::IgniteClientConfiguration::SetSslMode </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structignite_1_1thin_1_1SslMode.html#ad952e796d54c3c7e4ff72ce84762af8a">SslMode::Type</a> </td> |
| <td class="paramname"><em>sslMode</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>Set SSL mode. </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="structignite_1_1thin_1_1SslMode.html" title="SSL Mode. ">SslMode</a> for details.</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sslMode</td><td>SSL mode. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a2699b733dec083ad203827237da76cbe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2699b733dec083ad203827237da76cbe">◆ </a></span>SetUser()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::thin::IgniteClientConfiguration::SetUser </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>user</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>Set user name to use for the authentication. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">user</td><td>User name. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="ignite__client__configuration_8h_source.html">ignite_client_configuration.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Feb 27 2020 14:01:15 for Apache Ignite C++ by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
