blob: 50171b5fc95643017dfc20cb3f7c8af2708d6a40 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<link rel="canonical" href="https://ignite.apache.org/releases/2.4.0/dotnetdoc/api/Apache.Ignite.Core.Cache.Affinity.AffinityKey.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Struct AffinityKey
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Struct AffinityKey
| 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.Cache.Affinity.AffinityKey">
<h1 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey" class="text-break">Struct AffinityKey
</h1>
<div class="markdown level0 summary"><p>Optional wrapper for cache keys to provide support for custom affinity mapping.
The value returned by <a class="xref" href="Apache.Ignite.Core.Cache.Affinity.AffinityKey.html#Apache_Ignite_Core_Cache_Affinity_AffinityKey_Affinity">Affinity</a> will be used for key-to-node affinity.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IEquatable</span>&lt;<a class="xref" href="Apache.Ignite.Core.Cache.Affinity.AffinityKey.html">AffinityKey</a>&gt;</div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.Core.Cache.Affinity.html">Apache.Ignite.Core.Cache.Affinity</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
<h5 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public struct AffinityKey : IEquatable&lt;AffinityKey&gt;, IBinaryWriteAware</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Apache_Ignite_Core_Cache_Affinity_AffinityKey__ctor_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey__ctor_System_Object_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.#ctor(System.Object)">AffinityKey(Object)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Cache.Affinity.AffinityKey.html">AffinityKey</a> struct.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AffinityKey(object key)</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.Object</span></td>
<td><span class="parametername">key</span></td>
<td><p>The key.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Affinity_AffinityKey__ctor_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey__ctor_System_Object_System_Object_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.#ctor(System.Object,System.Object)">AffinityKey(Object, Object)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Cache.Affinity.AffinityKey.html">AffinityKey</a> struct.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AffinityKey(object key, object affinity)</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.Object</span></td>
<td><span class="parametername">key</span></td>
<td><p>The key.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Object</span></td>
<td><span class="parametername">affinity</span></td>
<td><p>The affinity key.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_Affinity_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.Affinity*"></a>
<h4 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_Affinity" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.Affinity">Affinity</h4>
<div class="markdown level1 summary"><p>Gets the affinity key.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object Affinity { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Object</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_Key_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.Key*"></a>
<h4 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_Key" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.Key">Key</h4>
<div class="markdown level1 summary"><p>Gets the key.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object Key { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Object</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_Equals_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.Equals*"></a>
<h4 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_Equals_Apache_Ignite_Core_Cache_Affinity_AffinityKey_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.Equals(Apache.Ignite.Core.Cache.Affinity.AffinityKey)">Equals(AffinityKey)</h4>
<div class="markdown level1 summary"><p>Indicates whether the current object is equal to another object of the same type.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Equals(AffinityKey other)</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><a class="xref" href="Apache.Ignite.Core.Cache.Affinity.AffinityKey.html">AffinityKey</a></td>
<td><span class="parametername">other</span></td>
<td><p>An object to compare with this object.</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><span class="xref">System.Boolean</span></td>
<td><p>true if the current object is equal to the <code data-dev-comment-type="paramref" class="paramref">other</code> parameter; otherwise, false.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_Equals_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.Equals*"></a>
<h4 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_Equals_System_Object_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.Equals(System.Object)">Equals(Object)</h4>
<div class="markdown level1 summary"><p>Determines whether the specified <span class="xref">System.Object</span>, is equal to this instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool Equals(object obj)</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.Object</span></td>
<td><span class="parametername">obj</span></td>
<td><p>The <span class="xref">System.Object</span> to compare with this instance.</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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if the specified <span class="xref">System.Object</span> is equal to this instance; otherwise, <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.ValueType.Equals(System.Object)</span></div>
<a id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_GetHashCode_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.GetHashCode*"></a>
<h4 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_GetHashCode" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.GetHashCode">GetHashCode()</h4>
<div class="markdown level1 summary"><p>Returns a hash code for this instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int GetHashCode()</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.Int32</span></td>
<td><p>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. </p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.ValueType.GetHashCode()</span></div>
<a id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_ToString_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.ToString*"></a>
<h4 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_ToString" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.ToString">ToString()</h4>
<div class="markdown level1 summary"><p>Returns a <span class="xref">System.String</span> that represents this instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString()</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.String</span></td>
<td><p>A <span class="xref">System.String</span> that represents this instance.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.ValueType.ToString()</span></div>
<a id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_WriteBinary_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.WriteBinary*"></a>
<h4 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_WriteBinary_Apache_Ignite_Core_Binary_IBinaryWriter_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.WriteBinary(Apache.Ignite.Core.Binary.IBinaryWriter)">WriteBinary(IBinaryWriter)</h4>
<div class="markdown level1 summary"><p>Writes this object to the given writer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void WriteBinary(IBinaryWriter writer)</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><a class="xref" href="Apache.Ignite.Core.Binary.IBinaryWriter.html">IBinaryWriter</a></td>
<td><span class="parametername">writer</span></td>
<td><p>Writer.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="operators">Operators
</h3>
<a id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_op_Equality_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.op_Equality*"></a>
<h4 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_op_Equality_Apache_Ignite_Core_Cache_Affinity_AffinityKey_Apache_Ignite_Core_Cache_Affinity_AffinityKey_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.op_Equality(Apache.Ignite.Core.Cache.Affinity.AffinityKey,Apache.Ignite.Core.Cache.Affinity.AffinityKey)">Equality(AffinityKey, AffinityKey)</h4>
<div class="markdown level1 summary"><p>Implements the operator ==.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool operator ==(AffinityKey left, AffinityKey right)</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><a class="xref" href="Apache.Ignite.Core.Cache.Affinity.AffinityKey.html">AffinityKey</a></td>
<td><span class="parametername">left</span></td>
<td><p>The left.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Cache.Affinity.AffinityKey.html">AffinityKey</a></td>
<td><span class="parametername">right</span></td>
<td><p>The right.</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><span class="xref">System.Boolean</span></td>
<td><p>The result of the operator.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_op_Inequality_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.op_Inequality*"></a>
<h4 id="Apache_Ignite_Core_Cache_Affinity_AffinityKey_op_Inequality_Apache_Ignite_Core_Cache_Affinity_AffinityKey_Apache_Ignite_Core_Cache_Affinity_AffinityKey_" data-uid="Apache.Ignite.Core.Cache.Affinity.AffinityKey.op_Inequality(Apache.Ignite.Core.Cache.Affinity.AffinityKey,Apache.Ignite.Core.Cache.Affinity.AffinityKey)">Inequality(AffinityKey, AffinityKey)</h4>
<div class="markdown level1 summary"><p>Implements the operator !=.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool operator !=(AffinityKey left, AffinityKey right)</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><a class="xref" href="Apache.Ignite.Core.Cache.Affinity.AffinityKey.html">AffinityKey</a></td>
<td><span class="parametername">left</span></td>
<td><p>The left.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Cache.Affinity.AffinityKey.html">AffinityKey</a></td>
<td><span class="parametername">right</span></td>
<td><p>The right.</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><span class="xref">System.Boolean</span></td>
<td><p>The result of the operator.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IEquatable&lt;T&gt;</span>
</div>
</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 - 2018 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>