blob: 4207a1f01a96d0d83f9218e00ccb26f77cfa678b [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<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/dotnetdoc/api/Apache.Ignite.Core.Client.IClientClusterGroup.html" />
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IClientClusterGroup
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IClientClusterGroup
| Apache Ignite.NET ">
<meta name="generator" content="docfx 2.24.0.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
<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 data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo_ignite_32_32.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items"></div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup">
<h1 id="Apache_Ignite_Core_Client_IClientClusterGroup" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup" class="text-break">Interface IClientClusterGroup
</h1>
<div class="markdown level0 summary"><p>Defines grid projection which represents a common functionality over a group of nodes.
Grid projection allows to group Ignite nodes into various subgroups to perform distributed
operations on them. All ForXXX(...)&apos; methods will create a child grid projection
from existing projection. If you create a new projection from current one, then the resulting
projection will include a subset of nodes from current projection. The following code snippet
shows how to create grid projections:</p>
<pre><code>var g = Ignition.StartClient().GetCluster();
// Projection over .NET nodes.
var remoteNodes = g.ForDotNet();
// Projection over server nodes.
var randomNode = g.ForServers();
// Projection over all nodes that have user attribute &quot;group&quot; set to value &quot;worker&quot;.
var workerNodes = g.ForAttribute(&quot;group&quot;, &quot;worker&quot;);</code></pre>
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.Core.Client.html">Apache.Ignite.Core.Client</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
<h5 id="Apache_Ignite_Core_Client_IClientClusterGroup_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IClientClusterGroup</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<a id="Apache_Ignite_Core_Client_IClientClusterGroup_ForAttribute_" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.ForAttribute*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientClusterGroup_ForAttribute_System_String_System_String_" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.ForAttribute(System.String,System.String)">ForAttribute(String, String)</h4>
<div class="markdown level1 summary"><p>Creates projection for nodes containing given name and value
specified in user attributes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IClientClusterGroup ForAttribute(string name, string val)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>Name of the attribute.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">val</span></td>
<td><p>Optional attribute value to match.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Client.IClientClusterGroup.html">IClientClusterGroup</a></td>
<td><p>Grid projection for nodes containing specified attribute.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IClientClusterGroup_ForDotNet_" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.ForDotNet*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientClusterGroup_ForDotNet" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.ForDotNet">ForDotNet()</h4>
<div class="markdown level1 summary"><p>Creates grid projection for nodes supporting .NET, i.e. for nodes started with Apache.Ignite.exe.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IClientClusterGroup ForDotNet()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Client.IClientClusterGroup.html">IClientClusterGroup</a></td>
<td><p>Grid projection for nodes supporting .NET.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IClientClusterGroup_ForPredicate_" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.ForPredicate*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientClusterGroup_ForPredicate_System_Func_Apache_Ignite_Core_Client_IClientClusterNode_System_Boolean__" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.ForPredicate(System.Func{Apache.Ignite.Core.Client.IClientClusterNode,System.Boolean})">ForPredicate(Func&lt;IClientClusterNode, Boolean&gt;)</h4>
<div class="markdown level1 summary"><p>Creates a grid projection which includes all nodes that pass the given predicate filter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IClientClusterGroup ForPredicate(Func&lt;IClientClusterNode, bool&gt; p)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Func</span>&lt;<a class="xref" href="Apache.Ignite.Core.Client.IClientClusterNode.html">IClientClusterNode</a>, <span class="xref">System.Boolean</span>&gt;</td>
<td><span class="parametername">p</span></td>
<td><p>Predicate filter for nodes to include into this projection.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Client.IClientClusterGroup.html">IClientClusterGroup</a></td>
<td><p>Grid projection for nodes that passed the predicate filter.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IClientClusterGroup_ForServers_" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.ForServers*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientClusterGroup_ForServers" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.ForServers">ForServers()</h4>
<div class="markdown level1 summary"><p>Creates a cluster group of nodes started in server mode (<a class="xref" href="Apache.Ignite.Core.IgniteConfiguration.html#Apache_Ignite_Core_IgniteConfiguration_ClientMode">ClientMode</a>).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IClientClusterGroup ForServers()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Client.IClientClusterGroup.html">IClientClusterGroup</a></td>
<td><p>Cluster group of nodes started in server mode.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IClientClusterGroup_GetCompute_" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.GetCompute*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientClusterGroup_GetCompute" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.GetCompute">GetCompute()</h4>
<div class="markdown level1 summary"><p>Gets compute functionality over this grid projection. All operations
on the returned compute instance will only include nodes from this projection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IComputeClient GetCompute()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Client.Compute.IComputeClient.html">IComputeClient</a></td>
<td><p>Compute instance over this grid projection.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IClientClusterGroup_GetNode_" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.GetNode*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientClusterGroup_GetNode" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.GetNode">GetNode()</h4>
<div class="markdown level1 summary"><p>Gets first node from the list of nodes in this projection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IClientClusterNode GetNode()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Client.IClientClusterNode.html">IClientClusterNode</a></td>
<td><p>Node.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IClientClusterGroup_GetNode_" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.GetNode*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientClusterGroup_GetNode_System_Guid_" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.GetNode(System.Guid)">GetNode(Guid)</h4>
<div class="markdown level1 summary"><p>Gets a node for given ID from this grid projection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IClientClusterNode GetNode(Guid id)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Guid</span></td>
<td><span class="parametername">id</span></td>
<td><p>Node ID.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Client.IClientClusterNode.html">IClientClusterNode</a></td>
<td><p>Node with given ID from this projection or null if such node does not
exist in this projection.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IClientClusterGroup_GetNodes_" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.GetNodes*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientClusterGroup_GetNodes" data-uid="Apache.Ignite.Core.Client.IClientClusterGroup.GetNodes">GetNodes()</h4>
<div class="markdown level1 summary"><p>Gets read-only collections of nodes in this projection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">ICollection&lt;IClientClusterNode&gt; GetNodes()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.ICollection</span>&lt;<a class="xref" href="Apache.Ignite.Core.Client.IClientClusterNode.html">IClientClusterNode</a>&gt;</td>
<td><p>All nodes in this projection.</p>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
© 2015 - 2019 The Apache Software Foundation
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>