| <!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> |
| <!-- Yandex.Metrika counter --> |
| <script type="text/javascript" > |
| (function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)}; |
| m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)}) |
| (window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym"); |
| |
| ym(72949126, "init", { |
| clickmap:true, |
| trackLinks:true, |
| accurateTrackBounce:true, |
| webvisor:true |
| }); |
| </script> |
| <noscript><div><img src="https://mc.yandex.ru/watch/72949126" style="position:absolute; left:-9999px;" alt="" /></div></noscript> |
| <!-- /Yandex.Metrika counter --> |
| <script type='text/javascript'> |
| window.__lo_site_id = 284467; |
| |
| (function() { |
| var wa = document.createElement('script'); wa.type = 'text/javascript'; wa.async = true; |
| wa.src = 'https://d10lpsik1i8c69.cloudfront.net/w.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(wa, s); |
| })(); |
| </script> |
| <link rel="canonical" href="https://ignite.apache.org/releases/latest/cppdoc/ignite__client_8h_source.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_client.h Source File</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 async src="https://www.googletagmanager.com/gtag/js?id=UA-61232409-1"></script> |
| <script> |
| window.dataLayer = window.dataLayer || []; |
| function gtag(){dataLayer.push(arguments);} |
| gtag('js', new Date()); |
| |
| gtag('config', 'UA-61232409-1'); |
| </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="dir_6917c354dff0dc051d18bd3bcc3faea1.html">include</a></li><li class="navelem"><a class="el" href="dir_3785354546cb37560a212b468c73f89f.html">ignite</a></li><li class="navelem"><a class="el" href="dir_097f68cb7241bfc683e7bdc6c58a7783.html">thin</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">ignite_client.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="ignite__client_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef _IGNITE_THIN_IGNITE_CLIENT</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define _IGNITE_THIN_IGNITE_CLIENT</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <ignite/common/concurrent.h></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <<a class="code" href="ignite__client__configuration_8h.html">ignite/thin/ignite_client_configuration.h</a>></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <<a class="code" href="cache__client_8h.html">ignite/thin/cache/cache_client.h</a>></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <ignite/thin/transactions/transactions.h></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span><a class="code" href="namespaceignite.html">ignite</a></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">namespace </span>thin</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1IgniteClient.html"> 48</a></span>  <span class="keyword">class </span>IGNITE_IMPORT_EXPORT <a class="code" href="classignite_1_1thin_1_1IgniteClient.html">IgniteClient</a></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">typedef</span> common::concurrent::SharedPointer<void> SP_Void;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1IgniteClient.html#a340b55483d03ddd8e4e293934052bcf8"> 55</a></span>  <a class="code" href="classignite_1_1thin_1_1IgniteClient.html#a340b55483d03ddd8e4e293934052bcf8">IgniteClient</a>()</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// No-op.</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  ~<a class="code" href="classignite_1_1thin_1_1IgniteClient.html">IgniteClient</a>();</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> <a class="code" href="classignite_1_1thin_1_1IgniteClient.html">IgniteClient</a> Start(<span class="keyword">const</span> <a class="code" href="classignite_1_1thin_1_1IgniteClientConfiguration.html">IgniteClientConfiguration</a>& cfg);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">template</span><<span class="keyword">typename</span> K, <span class="keyword">typename</span> V></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1IgniteClient.html#ae797fffa5c9b81af56ff016b4d8a2204"> 81</a></span>  <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient<K, V></a> <a class="code" href="classignite_1_1thin_1_1IgniteClient.html#ae797fffa5c9b81af56ff016b4d8a2204">GetCache</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name)</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span> <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient<K, V></a>(InternalGetCache(name));</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">template</span><<span class="keyword">typename</span> K, <span class="keyword">typename</span> V></div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1IgniteClient.html#a68ebd383b6d261dcbea7e4e1ddbccdf7"> 93</a></span>  <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient<K, V></a> <a class="code" href="classignite_1_1thin_1_1IgniteClient.html#a68ebd383b6d261dcbea7e4e1ddbccdf7">GetOrCreateCache</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name)</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">return</span> <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient<K, V></a>(InternalGetOrCreateCache(name));</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">template</span><<span class="keyword">typename</span> K, <span class="keyword">typename</span> V></div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1IgniteClient.html#ae07b0dbd827326f1c8eb3d34f1d886ee"> 105</a></span>  <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient<K, V></a> <a class="code" href="classignite_1_1thin_1_1IgniteClient.html#ae07b0dbd827326f1c8eb3d34f1d886ee">CreateCache</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name)</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  {</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordflow">return</span> <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient<K, V></a>(InternalCreateCache(name));</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  }</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">void</span> DestroyCache(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">void</span> GetCacheNames(std::vector<std::string>& cacheNames);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1IgniteClient.html#a1f4711ef2e87f10bca8cbfd290916ee3"> 128</a></span>  <a class="code" href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html">transactions::ClientTransactions</a> <a class="code" href="classignite_1_1thin_1_1IgniteClient.html#a1f4711ef2e87f10bca8cbfd290916ee3">ClientTransactions</a>()</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  {</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordflow">return</span> <a class="code" href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html">transactions::ClientTransactions</a>(InternalTransactions());</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  }</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  SP_Void InternalGetCache(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  SP_Void InternalGetOrCreateCache(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  SP_Void InternalCreateCache(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  SP_Void InternalTransactions();</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <a class="code" href="classignite_1_1thin_1_1IgniteClient.html">IgniteClient</a>(SP_Void& impl);</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  SP_Void impl;</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  };</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  }</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> }</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="preprocessor">#endif // _IGNITE_THIN_IGNITE_CLIENT</span></div><div class="ttc" id="cache__client_8h_html"><div class="ttname"><a href="cache__client_8h.html">cache_client.h</a></div><div class="ttdoc">Declares ignite::thin::cache::CacheClient. </div></div> |
| <div class="ttc" id="classignite_1_1thin_1_1IgniteClient_html_a68ebd383b6d261dcbea7e4e1ddbccdf7"><div class="ttname"><a href="classignite_1_1thin_1_1IgniteClient.html#a68ebd383b6d261dcbea7e4e1ddbccdf7">ignite::thin::IgniteClient::GetOrCreateCache</a></div><div class="ttdeci">cache::CacheClient< K, V > GetOrCreateCache(const char *name)</div><div class="ttdoc">Get or create cache. </div><div class="ttdef"><b>Definition:</b> ignite_client.h:93</div></div> |
| <div class="ttc" id="classignite_1_1thin_1_1IgniteClient_html_ae797fffa5c9b81af56ff016b4d8a2204"><div class="ttname"><a href="classignite_1_1thin_1_1IgniteClient.html#ae797fffa5c9b81af56ff016b4d8a2204">ignite::thin::IgniteClient::GetCache</a></div><div class="ttdeci">cache::CacheClient< K, V > GetCache(const char *name)</div><div class="ttdoc">Get cache. </div><div class="ttdef"><b>Definition:</b> ignite_client.h:81</div></div> |
| <div class="ttc" id="classignite_1_1thin_1_1IgniteClient_html_a340b55483d03ddd8e4e293934052bcf8"><div class="ttname"><a href="classignite_1_1thin_1_1IgniteClient.html#a340b55483d03ddd8e4e293934052bcf8">ignite::thin::IgniteClient::IgniteClient</a></div><div class="ttdeci">IgniteClient()</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> ignite_client.h:55</div></div> |
| <div class="ttc" id="classignite_1_1thin_1_1IgniteClientConfiguration_html"><div class="ttname"><a href="classignite_1_1thin_1_1IgniteClientConfiguration.html">ignite::thin::IgniteClientConfiguration</a></div><div class="ttdoc">Ignite thin client configuration. </div><div class="ttdef"><b>Definition:</b> ignite_client_configuration.h:39</div></div> |
| <div class="ttc" id="classignite_1_1thin_1_1cache_1_1CacheClient_html"><div class="ttname"><a href="classignite_1_1thin_1_1cache_1_1CacheClient.html">ignite::thin::cache::CacheClient</a></div><div class="ttdoc">Cache client class template. </div><div class="ttdef"><b>Definition:</b> cache_client.h:59</div></div> |
| <div class="ttc" id="classignite_1_1thin_1_1IgniteClient_html_ae07b0dbd827326f1c8eb3d34f1d886ee"><div class="ttname"><a href="classignite_1_1thin_1_1IgniteClient.html#ae07b0dbd827326f1c8eb3d34f1d886ee">ignite::thin::IgniteClient::CreateCache</a></div><div class="ttdeci">cache::CacheClient< K, V > CreateCache(const char *name)</div><div class="ttdoc">Create cache. </div><div class="ttdef"><b>Definition:</b> ignite_client.h:105</div></div> |
| <div class="ttc" id="classignite_1_1thin_1_1transactions_1_1ClientTransactions_html"><div class="ttname"><a href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html">ignite::thin::transactions::ClientTransactions</a></div><div class="ttdoc">Transactions client. </div><div class="ttdef"><b>Definition:</b> thin-client/include/ignite/thin/transactions/transactions.h:43</div></div> |
| <div class="ttc" id="ignite__client__configuration_8h_html"><div class="ttname"><a href="ignite__client__configuration_8h.html">ignite_client_configuration.h</a></div><div class="ttdoc">Declares ignite::thin::IgniteClientConfiguration class. </div></div> |
| <div class="ttc" id="namespaceignite_html"><div class="ttname"><a href="namespaceignite.html">ignite</a></div><div class="ttdoc">Apache Ignite API. </div><div class="ttdef"><b>Definition:</b> cache.h:48</div></div> |
| <div class="ttc" id="classignite_1_1thin_1_1IgniteClient_html"><div class="ttname"><a href="classignite_1_1thin_1_1IgniteClient.html">ignite::thin::IgniteClient</a></div><div class="ttdoc">Ignite client class. </div><div class="ttdef"><b>Definition:</b> ignite_client.h:48</div></div> |
| <div class="ttc" id="classignite_1_1thin_1_1IgniteClient_html_a1f4711ef2e87f10bca8cbfd290916ee3"><div class="ttname"><a href="classignite_1_1thin_1_1IgniteClient.html#a1f4711ef2e87f10bca8cbfd290916ee3">ignite::thin::IgniteClient::ClientTransactions</a></div><div class="ttdeci">transactions::ClientTransactions ClientTransactions()</div><div class="ttdoc">Starts transactions. </div><div class="ttdef"><b>Definition:</b> ignite_client.h:128</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sat Sep 11 2021 21:14:00 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> |
