| <!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.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Geode Native .NET Reference: Apache::Geode::Client::ICacheableKey Interface Reference</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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</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="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Geode Native .NET Reference |
|  <span id="projectnumber">1.13.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00902.html','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- 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 class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::ICacheableKey Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>This interface class is the superclass of all user objects in the cache that can be used as a key. |
| <a href="a00902.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="a01022.html">Apache::Geode::Client::ISerializable</a>.</p> |
| |
| <p>Inherited by <a class="el" href="a00462.html">Apache::Geode::Client::CacheableDate</a>, <a class="el" href="a00466.html">Apache::Geode::Client::CacheableFileName</a>, and <a class="el" href="a00498.html">Apache::Geode::Client::CacheableKey</a>.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:abbc184ea4c9355db33f21213f978edf4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00902.html#abbc184ea4c9355db33f21213f978edf4">Equals</a> (<a class="el" href="a00902.html">ICacheableKey</a>^ other)</td></tr> |
| <tr class="memdesc:abbc184ea4c9355db33f21213f978edf4"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this <code><a class="el" href="a00902.html" title="This interface class is the superclass of all user objects in the cache that can be used as a key.">ICacheableKey</a></code> matches the other. <a href="#abbc184ea4c9355db33f21213f978edf4">More...</a><br /></td></tr> |
| <tr class="separator:abbc184ea4c9355db33f21213f978edf4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a541fd0835dd2941b0e84c9115cddaf5d"><td class="memItemLeft" align="right" valign="top">System::Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00902.html#a541fd0835dd2941b0e84c9115cddaf5d">GetHashCode</a> ()</td></tr> |
| <tr class="memdesc:a541fd0835dd2941b0e84c9115cddaf5d"><td class="mdescLeft"> </td><td class="mdescRight">Get the hash code for this object. <a href="#a541fd0835dd2941b0e84c9115cddaf5d">More...</a><br /></td></tr> |
| <tr class="separator:a541fd0835dd2941b0e84c9115cddaf5d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a335290fd15fd41d39bc73a7ca10d19bd"><td class="memItemLeft" align="right" valign="top">String ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a01022.html#a335290fd15fd41d39bc73a7ca10d19bd">ToString</a> ()</td></tr> |
| <tr class="memdesc:a335290fd15fd41d39bc73a7ca10d19bd"><td class="mdescLeft"> </td><td class="mdescRight">Return a string representation of the object. <a href="#a335290fd15fd41d39bc73a7ca10d19bd">More...</a><br /></td></tr> |
| <tr class="separator:a335290fd15fd41d39bc73a7ca10d19bd"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a961265733e9d83372f8facb7d88b4c78"><td class="memItemLeft" align="right" valign="top">System::UInt64 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01022.html#a961265733e9d83372f8facb7d88b4c78">ObjectSize</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a961265733e9d83372f8facb7d88b4c78"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of this object in bytes. <a href="#a961265733e9d83372f8facb7d88b4c78">More...</a><br /></td></tr> |
| <tr class="separator:a961265733e9d83372f8facb7d88b4c78"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>This interface class is the superclass of all user objects in the cache that can be used as a key. </p> |
| <p>If an implementation is required to act as a key in the cache, then it must implement this interface and preferably override <code>System.Object.ToString</code> to obtain proper string representation. Note that this interface requires that the class overrides <code>Object.GetHashCode</code>. Though this is not enforced, the default implementation in <code>System.Object</code> is almost certainly incorrect and will not work correctly. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="abbc184ea4c9355db33f21213f978edf4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abbc184ea4c9355db33f21213f978edf4">◆ </a></span>Equals()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache::Geode::Client::ICacheableKey::Equals </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00902.html">ICacheableKey</a>^ </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns true if this <code><a class="el" href="a00902.html" title="This interface class is the superclass of all user objects in the cache that can be used as a key.">ICacheableKey</a></code> matches the other. </p> |
| |
| <p>Implemented in <a class="el" href="a00462.html#a00cc151d977af2887ebdef9d7aa6ce99">Apache::Geode::Client::CacheableDate</a>, <a class="el" href="a00522.html#a8a2460e9d4406ee59ce66c69e7fd1b58">Apache::Geode::Client::CacheableString</a>, <a class="el" href="a00418.html#a0cde4d19021ec7c00c9024d1f8a439ec">Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID ></a>, <a class="el" href="a00418.html#a0cde4d19021ec7c00c9024d1f8a439ec">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt32, System::Int32, static_cast< int8_t >(DSCode::CacheableInt32)></a>, <a class="el" href="a00418.html#a0cde4d19021ec7c00c9024d1f8a439ec">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt16, System::Int16, static_cast< int8_t >(DSCode::CacheableInt16)></a>, <a class="el" href="a00418.html#a0cde4d19021ec7c00c9024d1f8a439ec">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableCharacter, Char, static_cast< int8_t >(DSCode::CacheableCharacter)></a>, <a class="el" href="a00418.html#a0cde4d19021ec7c00c9024d1f8a439ec">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableFloat, Single, static_cast< int8_t >(DSCode::CacheableFloat)></a>, <a class="el" href="a00418.html#a0cde4d19021ec7c00c9024d1f8a439ec">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt64, System::Int64, static_cast< int8_t >(DSCode::CacheableInt64)></a>, <a class="el" href="a00418.html#a0cde4d19021ec7c00c9024d1f8a439ec">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableDouble, Double, static_cast< int8_t >(DSCode::CacheableDouble)></a>, <a class="el" href="a00418.html#a0cde4d19021ec7c00c9024d1f8a439ec">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableByte, Byte, static_cast< int8_t >(DSCode::CacheableByte)></a>, <a class="el" href="a00418.html#a0cde4d19021ec7c00c9024d1f8a439ec">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableBoolean, bool, static_cast< int8_t >(DSCode::CacheableBoolean)></a>, <a class="el" href="a00466.html#a7f316d2639f1514738ce226e81d5e8fa">Apache::Geode::Client::CacheableFileName</a>, and <a class="el" href="a00498.html#a5431c8fb0bc4b2fed7e18efdb994e57d">Apache::Geode::Client::CacheableKey</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a541fd0835dd2941b0e84c9115cddaf5d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a541fd0835dd2941b0e84c9115cddaf5d">◆ </a></span>GetHashCode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System::Int32 Apache::Geode::Client::ICacheableKey::GetHashCode </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the hash code for this object. </p> |
| <p>This is used in the internal hash tables and so must have a nice distribution pattern. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The hashcode for this object. </dd></dl> |
| |
| <p>Implemented in <a class="el" href="a00522.html#a77581c5e5934134d743f4c09bcc20264">Apache::Geode::Client::CacheableString</a>, <a class="el" href="a00462.html#a80c2721902b8549b4c0287bea06e8d15">Apache::Geode::Client::CacheableDate</a>, <a class="el" href="a00466.html#adccf5ff1b95bb25fb751f735d37a428c">Apache::Geode::Client::CacheableFileName</a>, and <a class="el" href="a00498.html#a9a88344340ac7b9d298672439f264997">Apache::Geode::Client::CacheableKey</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a335290fd15fd41d39bc73a7ca10d19bd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a335290fd15fd41d39bc73a7ca10d19bd">◆ </a></span>ToString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String ^ Apache::Geode::Client::ISerializable::ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inherited</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return a string representation of the object. </p> |
| |
| <p>Implemented in <a class="el" href="a00422.html#ab8b28a924b843eefd2a668687d291d44">Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID ></a>, <a class="el" href="a00422.html#ab8b28a924b843eefd2a668687d291d44">Apache::Geode::Client::CacheableBuiltinArray< NativeArray, NativeArray, ManagedType, DsCode ></a>, <a class="el" href="a00406.html#a3d05e2243bcdfd0e4a3ad715bc6ccc07">Apache::Geode::Client::Properties< TPropKey, TPropValue ></a>, <a class="el" href="a00406.html#a3d05e2243bcdfd0e4a3ad715bc6ccc07">Apache::Geode::Client::Properties< String^, String^></a>, <a class="el" href="a00462.html#ad2444cf71a9a38173aceab2f04dd971b">Apache::Geode::Client::CacheableDate</a>, <a class="el" href="a00522.html#a5bbf6e7b40afcdb5f34d7c26fb14b5ca">Apache::Geode::Client::CacheableString</a>, <a class="el" href="a00526.html#a778f034e0dcec70fa8f9f18ba1546ee4">Apache::Geode::Client::CacheableStringArray</a>, <a class="el" href="a01114.html#aab399122dadac5f60090908915eb174e">Apache::Geode::Client::Serializable</a>, <a class="el" href="a00514.html#acb81de701828d0a509b62c2df1cb9be4">Apache::Geode::Client::CacheableObjectXml</a>, <a class="el" href="a00506.html#a76344b40a20a6ac6b207d71210bdc0c6">Apache::Geode::Client::CacheableObject</a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID ></a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt32, System::Int32, static_cast< int8_t >(DSCode::CacheableInt32)></a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt16, System::Int16, static_cast< int8_t >(DSCode::CacheableInt16)></a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableCharacter, Char, static_cast< int8_t >(DSCode::CacheableCharacter)></a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableFloat, Single, static_cast< int8_t >(DSCode::CacheableFloat)></a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt64, System::Int64, static_cast< int8_t >(DSCode::CacheableInt64)></a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableDouble, Double, static_cast< int8_t >(DSCode::CacheableDouble)></a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableByte, Byte, static_cast< int8_t >(DSCode::CacheableByte)></a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey< native::CacheableBoolean, bool, static_cast< int8_t >(DSCode::CacheableBoolean)></a>, and <a class="el" href="a00466.html#a70b00e8aa0f34bbbbfb07aabf3c4b67a">Apache::Geode::Client::CacheableFileName</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a961265733e9d83372f8facb7d88b4c78"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a961265733e9d83372f8facb7d88b4c78">◆ </a></span>ObjectSize</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System:: UInt64 Apache::Geode::Client::ISerializable::ObjectSize</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">inherited</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the size of this object in bytes. </p> |
| <p>This is only needed if you use the HeapLRU feature. </p> |
| <p>Note that you can simply return zero if you are not using the HeapLRU feature. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the size of this object in bytes.</dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <HR><address style="align: right;"><small>Apache Geode C++ Cache .NET API Documentation</small></address> |
