blob: adee7754990a2652b256eb323a4d3c474cda7730 [file] [log] [blame]
<!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/2.7.0/cppdoc/ignite__client_8h_source.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<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.11"/>
<title>&nbsp; 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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">&nbsp; Apache Ignite C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</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>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<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>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<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>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<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>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<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>&#160;<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>&#160;<span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef _IGNITE_THIN_IGNITE_CLIENT</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define _IGNITE_THIN_IGNITE_CLIENT</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;ignite/common/concurrent.h&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="ignite__client__configuration_8h.html">ignite/thin/ignite_client_configuration.h</a>&gt;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="cache__client_8h.html">ignite/thin/cache/cache_client.h</a>&gt;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceignite.html">ignite</a></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;{</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">namespace </span>thin</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; {</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1IgniteClient.html"> 47</a></span>&#160; <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="l00048"></a><span class="lineno"> 48</span>&#160; {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">typedef</span> common::concurrent::SharedPointer&lt;void&gt; SP_Void;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1IgniteClient.html#a340b55483d03ddd8e4e293934052bcf8"> 54</a></span>&#160; <a class="code" href="classignite_1_1thin_1_1IgniteClient.html#a340b55483d03ddd8e4e293934052bcf8">IgniteClient</a>()</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// No-op.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; ~<a class="code" href="classignite_1_1thin_1_1IgniteClient.html">IgniteClient</a>();</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <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>&amp; cfg);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> K, <span class="keyword">typename</span> V&gt;</div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1IgniteClient.html#ae797fffa5c9b81af56ff016b4d8a2204"> 80</a></span>&#160; <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient&lt;K, V&gt;</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="l00081"></a><span class="lineno"> 81</span>&#160; {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient&lt;K, V&gt;</a>(InternalGetCache(name));</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> K, <span class="keyword">typename</span> V&gt;</div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1IgniteClient.html#a68ebd383b6d261dcbea7e4e1ddbccdf7"> 92</a></span>&#160; <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient&lt;K, V&gt;</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="l00093"></a><span class="lineno"> 93</span>&#160; {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient&lt;K, V&gt;</a>(InternalGetOrCreateCache(name));</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; }</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> K, <span class="keyword">typename</span> V&gt;</div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1IgniteClient.html#ae07b0dbd827326f1c8eb3d34f1d886ee"> 104</a></span>&#160; <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient&lt;K, V&gt;</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="l00105"></a><span class="lineno"> 105</span>&#160; {</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classignite_1_1thin_1_1cache_1_1CacheClient.html">cache::CacheClient&lt;K, V&gt;</a>(InternalCreateCache(name));</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; }</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordtype">void</span> DestroyCache(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordtype">void</span> GetCacheNames(std::vector&lt;std::string&gt;&amp; cacheNames);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; SP_Void InternalGetCache(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; SP_Void InternalGetOrCreateCache(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; SP_Void InternalCreateCache(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <a class="code" href="classignite_1_1thin_1_1IgniteClient.html">IgniteClient</a>(SP_Void&amp; impl);</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; SP_Void impl;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; };</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; }</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;}</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;<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&lt; K, V &gt; GetOrCreateCache(const char *name)</div><div class="ttdoc">Get or create cache. </div><div class="ttdef"><b>Definition:</b> ignite_client.h:92</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&lt; K, V &gt; GetCache(const char *name)</div><div class="ttdoc">Get cache. </div><div class="ttdef"><b>Definition:</b> ignite_client.h:80</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:54</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:56</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&lt; K, V &gt; CreateCache(const char *name)</div><div class="ttdoc">Create cache. </div><div class="ttdef"><b>Definition:</b> ignite_client.h:104</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:47</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Nov 30 2018 20:09:21 for &nbsp; Apache Ignite C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>