blob: 75827524407afa15970974c643f15e761070e2de [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>&nbsp; Apache Ignite C++: cluster_node.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" />
</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.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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_65daadc4bf270603bcffbf0e824043f9.html">cluster</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">cluster_node.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="cluster__node_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_CLUSTER_CLUSTER_NODE</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define _IGNITE_CLUSTER_CLUSTER_NODE</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;ignite/impl/cluster/cluster_node_impl.h&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="keyword">namespace </span><a class="code" href="namespaceignite.html">ignite</a></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="keyword">namespace </span>cluster</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; {</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classignite_1_1cluster_1_1ClusterNode.html"> 36</a></span>&#160; <span class="keyword">class </span>IGNITE_IMPORT_EXPORT <a class="code" href="classignite_1_1cluster_1_1ClusterNode.html">ClusterNode</a></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="classignite_1_1cluster_1_1ClusterNode.html">ClusterNode</a>(common::concurrent::SharedPointer&lt;ignite::impl::cluster::ClusterNodeImpl&gt; impl);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; GetAddresses() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">bool</span> IsAttributeSet(std::string name) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classignite_1_1cluster_1_1ClusterNode.html#a45d3c90df5cb5261e3166fc2ade130b0"> 71</a></span>&#160; T <a class="code" href="classignite_1_1cluster_1_1ClusterNode.html#a45d3c90df5cb5261e3166fc2ade130b0">GetAttribute</a>(std::string name)<span class="keyword"> const</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordflow">return</span> impl.Get()-&gt;GetAttribute&lt;T&gt;(name);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; }</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; std::vector&lt;std::string&gt; GetAttributes() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; std::string GetConsistentId() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; GetHostNames() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <a class="code" href="classignite_1_1Guid.html">Guid</a> GetId() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordtype">bool</span> IsClient() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordtype">bool</span> IsDaemon() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">bool</span> IsLocal() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; int64_t GetOrder() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keyword">const</span> <a class="code" href="structignite_1_1IgniteProductVersion.html">IgniteProductVersion</a>&amp; GetVersion() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; </div>
<div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="classignite_1_1cluster_1_1ClusterNode.html#a40423141e36ed3aeb78265ef111bdc2d"> 146</a></span>&#160; <span class="keyword">friend</span> IGNITE_IMPORT_EXPORT <span class="keywordtype">bool</span> <a class="code" href="classignite_1_1cluster_1_1ClusterNode.html#a40423141e36ed3aeb78265ef111bdc2d">operator&lt;</a>(<span class="keyword">const</span> <a class="code" href="classignite_1_1cluster_1_1ClusterNode.html">ClusterNode</a>&amp; lnode, <span class="keyword">const</span> <a class="code" href="classignite_1_1cluster_1_1ClusterNode.html">ClusterNode</a>&amp; rnode)</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; {</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keywordflow">return</span> lnode.<a class="code" href="classignite_1_1cluster_1_1ClusterNode.html#a25db252bc63707a17ef1dac359a802eb">GetId</a>() &lt; rnode.<a class="code" href="classignite_1_1cluster_1_1ClusterNode.html#a25db252bc63707a17ef1dac359a802eb">GetId</a>();</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; }</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; common::concurrent::SharedPointer&lt;ignite::impl::cluster::ClusterNodeImpl&gt; impl;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; };</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; }</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;}</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; </div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;<span class="preprocessor">#endif //_IGNITE_CLUSTER_CLUSTER_NODE</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespaceignite_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="astructignite_1_1IgniteProductVersion_html"><div class="ttname"><a href="structignite_1_1IgniteProductVersion.html">ignite::IgniteProductVersion</a></div><div class="ttdoc">Ignite product version.</div><div class="ttdef"><b>Definition:</b> ignite_product_version.h:36</div></div>
<div class="ttc" id="aclassignite_1_1Guid_html"><div class="ttname"><a href="classignite_1_1Guid.html">ignite::Guid</a></div><div class="ttdoc">Global universally unique identifier (GUID).</div><div class="ttdef"><b>Definition:</b> guid.h:36</div></div>
<div class="ttc" id="aclassignite_1_1cluster_1_1ClusterNode_html_a25db252bc63707a17ef1dac359a802eb"><div class="ttname"><a href="classignite_1_1cluster_1_1ClusterNode.html#a25db252bc63707a17ef1dac359a802eb">ignite::cluster::ClusterNode::GetId</a></div><div class="ttdeci">Guid GetId() const</div><div class="ttdoc">Get globally unique node ID.</div><div class="ttdef"><b>Definition:</b> cluster_node.cpp:58</div></div>
<div class="ttc" id="aclassignite_1_1cluster_1_1ClusterNode_html_a45d3c90df5cb5261e3166fc2ade130b0"><div class="ttname"><a href="classignite_1_1cluster_1_1ClusterNode.html#a45d3c90df5cb5261e3166fc2ade130b0">ignite::cluster::ClusterNode::GetAttribute</a></div><div class="ttdeci">T GetAttribute(std::string name) const</div><div class="ttdoc">Get a node attribute.</div><div class="ttdef"><b>Definition:</b> cluster_node.h:71</div></div>
<div class="ttc" id="aclassignite_1_1cluster_1_1ClusterNode_html_a40423141e36ed3aeb78265ef111bdc2d"><div class="ttname"><a href="classignite_1_1cluster_1_1ClusterNode.html#a40423141e36ed3aeb78265ef111bdc2d">ignite::cluster::ClusterNode::operator&lt;</a></div><div class="ttdeci">friend IGNITE_IMPORT_EXPORT bool operator&lt;(const ClusterNode &amp;lnode, const ClusterNode &amp;rnode)</div><div class="ttdoc">Define &quot;less&quot; operator to allow Cluster Node usage as STL container key.</div><div class="ttdef"><b>Definition:</b> cluster_node.h:146</div></div>
<div class="ttc" id="aclassignite_1_1cluster_1_1ClusterNode_html"><div class="ttname"><a href="classignite_1_1cluster_1_1ClusterNode.html">ignite::cluster::ClusterNode</a></div><div class="ttdoc">Interface representing a single cluster node.</div><div class="ttdef"><b>Definition:</b> cluster_node.h:36</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 10 2022 11:02:04 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.17
</small></address>
</body>
</html>