| <!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::AttributesMutator< TKey, TValue > Class Template 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('a00402.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> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::AttributesMutator< TKey, TValue > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Supports modification of certain region attributes after the region has been created. |
| <a href="a00402.html#details">More...</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:aca55d391d65a087739bb23d3ef41bb1b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#aca55d391d65a087739bb23d3ef41bb1b">SetCacheListener</a> (<a class="el" href="a00906.html">ICacheListener</a>< TKey, TValue >^ cacheListener)</td></tr> |
| <tr class="memdesc:aca55d391d65a087739bb23d3ef41bb1b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the CacheListener for the region. <a href="#aca55d391d65a087739bb23d3ef41bb1b">More...</a><br /></td></tr> |
| <tr class="separator:aca55d391d65a087739bb23d3ef41bb1b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0ac0d6789b7d23c70bc29e9acfd3392d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#a0ac0d6789b7d23c70bc29e9acfd3392d">SetCacheListener</a> (String^ libPath, String^ factoryFunctionName)</td></tr> |
| <tr class="memdesc:a0ac0d6789b7d23c70bc29e9acfd3392d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the library path for the library that will be invoked for the listener of the region. <a href="#a0ac0d6789b7d23c70bc29e9acfd3392d">More...</a><br /></td></tr> |
| <tr class="separator:a0ac0d6789b7d23c70bc29e9acfd3392d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad8457fc08a0db37208f447d4da48d9a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#ad8457fc08a0db37208f447d4da48d9a1">SetCacheLoader</a> (<a class="el" href="a00914.html">ICacheLoader</a>< TKey, TValue >^ cacheLoader)</td></tr> |
| <tr class="memdesc:ad8457fc08a0db37208f447d4da48d9a1"><td class="mdescLeft"> </td><td class="mdescRight">Sets the <a class="el" href="a00910.html" title="CacheLoader">CacheLoader</a> for the region. <a href="#ad8457fc08a0db37208f447d4da48d9a1">More...</a><br /></td></tr> |
| <tr class="separator:ad8457fc08a0db37208f447d4da48d9a1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a32bcb4cf4a81d81aa55d10e2145d66f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#a32bcb4cf4a81d81aa55d10e2145d66f4">SetCacheLoader</a> (String^ libPath, String^ factoryFunctionName)</td></tr> |
| <tr class="memdesc:a32bcb4cf4a81d81aa55d10e2145d66f4"><td class="mdescLeft"> </td><td class="mdescRight">Sets the library path for the library that will be invoked for the loader of the region. <a href="#a32bcb4cf4a81d81aa55d10e2145d66f4">More...</a><br /></td></tr> |
| <tr class="separator:a32bcb4cf4a81d81aa55d10e2145d66f4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3a149fe966e798fd0907317f87139dea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#a3a149fe966e798fd0907317f87139dea">SetCacheWriter</a> (<a class="el" href="a00918.html">ICacheWriter</a>< TKey, TValue >^ cacheWriter)</td></tr> |
| <tr class="memdesc:a3a149fe966e798fd0907317f87139dea"><td class="mdescLeft"> </td><td class="mdescRight">Sets the CacheListener for the region. <a href="#a3a149fe966e798fd0907317f87139dea">More...</a><br /></td></tr> |
| <tr class="separator:a3a149fe966e798fd0907317f87139dea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16d1adc66975a9209b1d5992d0947067"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#a16d1adc66975a9209b1d5992d0947067">SetCacheWriter</a> (String^ libPath, String^ factoryFunctionName)</td></tr> |
| <tr class="memdesc:a16d1adc66975a9209b1d5992d0947067"><td class="mdescLeft"> </td><td class="mdescRight">Sets the library path for the library that will be invoked for the writer of the region. <a href="#a16d1adc66975a9209b1d5992d0947067">More...</a><br /></td></tr> |
| <tr class="separator:a16d1adc66975a9209b1d5992d0947067"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afd0202e11f52a8e56603f62348308f6d"><td class="memItemLeft" align="right" valign="top">TimeSpan </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#afd0202e11f52a8e56603f62348308f6d">SetEntryIdleTimeout</a> (TimeSpan idleTimeout)</td></tr> |
| <tr class="memdesc:afd0202e11f52a8e56603f62348308f6d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the idleTimeout duration for region entries. <a href="#afd0202e11f52a8e56603f62348308f6d">More...</a><br /></td></tr> |
| <tr class="separator:afd0202e11f52a8e56603f62348308f6d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a856f7344f40446a6f399dcc18155d8bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#a856f7344f40446a6f399dcc18155d8bd">SetEntryIdleTimeoutAction</a> (<a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> action)</td></tr> |
| <tr class="memdesc:a856f7344f40446a6f399dcc18155d8bd"><td class="mdescLeft"> </td><td class="mdescRight">Sets the idleTimeout action for region entries. <a href="#a856f7344f40446a6f399dcc18155d8bd">More...</a><br /></td></tr> |
| <tr class="separator:a856f7344f40446a6f399dcc18155d8bd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a06c1f626bb5419fbdf083609d3c9a7fe"><td class="memItemLeft" align="right" valign="top">TimeSpan </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#a06c1f626bb5419fbdf083609d3c9a7fe">SetEntryTimeToLive</a> (TimeSpan timeToLive)</td></tr> |
| <tr class="memdesc:a06c1f626bb5419fbdf083609d3c9a7fe"><td class="mdescLeft"> </td><td class="mdescRight">Sets the timeToLive duration for region entries. <a href="#a06c1f626bb5419fbdf083609d3c9a7fe">More...</a><br /></td></tr> |
| <tr class="separator:a06c1f626bb5419fbdf083609d3c9a7fe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8243d3f214ea3727ab1f700057e1f2f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#a8243d3f214ea3727ab1f700057e1f2f7">SetEntryTimeToLiveAction</a> (<a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> action)</td></tr> |
| <tr class="memdesc:a8243d3f214ea3727ab1f700057e1f2f7"><td class="mdescLeft"> </td><td class="mdescRight">Set the timeToLive action for region entries. <a href="#a8243d3f214ea3727ab1f700057e1f2f7">More...</a><br /></td></tr> |
| <tr class="separator:a8243d3f214ea3727ab1f700057e1f2f7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a08902671c0c0a49fbd45dbb53914d54e"><td class="memItemLeft" align="right" valign="top">System::UInt32 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#a08902671c0c0a49fbd45dbb53914d54e">SetLruEntriesLimit</a> (System::UInt32 entriesLimit)</td></tr> |
| <tr class="memdesc:a08902671c0c0a49fbd45dbb53914d54e"><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum entry count in the region before LRU eviction. <a href="#a08902671c0c0a49fbd45dbb53914d54e">More...</a><br /></td></tr> |
| <tr class="separator:a08902671c0c0a49fbd45dbb53914d54e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae82765ffa4933e29b71e899e9df0c6e5"><td class="memItemLeft" align="right" valign="top">TimeSpan </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#ae82765ffa4933e29b71e899e9df0c6e5">SetRegionIdleTimeout</a> (TimeSpan idleTimeout)</td></tr> |
| <tr class="memdesc:ae82765ffa4933e29b71e899e9df0c6e5"><td class="mdescLeft"> </td><td class="mdescRight">Sets the idleTimeout duration for the region itself. <a href="#ae82765ffa4933e29b71e899e9df0c6e5">More...</a><br /></td></tr> |
| <tr class="separator:ae82765ffa4933e29b71e899e9df0c6e5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a95a2a37f81015bdd5352278e8fa62f0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#a95a2a37f81015bdd5352278e8fa62f0c">SetRegionIdleTimeoutAction</a> (<a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> action)</td></tr> |
| <tr class="memdesc:a95a2a37f81015bdd5352278e8fa62f0c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the idleTimeout action for the region itself. <a href="#a95a2a37f81015bdd5352278e8fa62f0c">More...</a><br /></td></tr> |
| <tr class="separator:a95a2a37f81015bdd5352278e8fa62f0c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa2816d3b0b54d13432efa8796799cb0a"><td class="memItemLeft" align="right" valign="top">TimeSpan </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#aa2816d3b0b54d13432efa8796799cb0a">SetRegionTimeToLive</a> (TimeSpan timeToLive)</td></tr> |
| <tr class="memdesc:aa2816d3b0b54d13432efa8796799cb0a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the timeToLive duration for the region itself. <a href="#aa2816d3b0b54d13432efa8796799cb0a">More...</a><br /></td></tr> |
| <tr class="separator:aa2816d3b0b54d13432efa8796799cb0a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8d7293fe0e09e7bc470175327dae45c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00402.html#a8d7293fe0e09e7bc470175327dae45c2">SetRegionTimeToLiveAction</a> (<a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> action)</td></tr> |
| <tr class="memdesc:a8d7293fe0e09e7bc470175327dae45c2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the timeToLive action for the region itself. <a href="#a8d7293fe0e09e7bc470175327dae45c2">More...</a><br /></td></tr> |
| <tr class="separator:a8d7293fe0e09e7bc470175327dae45c2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<class TKey, class TValue><br /> |
| class Apache::Geode::Client::AttributesMutator< TKey, TValue ></h3> |
| |
| <p>Supports modification of certain region attributes after the region has been created. </p> |
| <p>It is required that the attributes be completely initialized using an <a class="el" href="a01098.html" title="Factory class to create instances of RegionAttributes.">RegionAttributesFactory</a> before creating the region. <a class="el" href="a00402.html" title="Supports modification of certain region attributes after the region has been created.">AttributesMutator</a> can be applied to adjusting and tuning a subset of attributes that are modifiable at runtime. </p> |
| <p>The setter methods all return the previous value of the attribute. </p> |
| <dl class="section see"><dt>See also</dt><dd>Region.AttributesMutator, <a class="el" href="a01010.html" title="Defines attributes for configuring a region.">RegionAttributes</a>, <a class="el" href="a01098.html" title="Factory class to create instances of RegionAttributes.">RegionAttributesFactory</a></dd></dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aca55d391d65a087739bb23d3ef41bb1b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aca55d391d65a087739bb23d3ef41bb1b">◆ </a></span>SetCacheListener() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetCacheListener </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00906.html">ICacheListener</a>< TKey, TValue >^ </td> |
| <td class="paramname"><em>cacheListener</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the CacheListener for the region. </p> |
| <p>The previous cache listener (if any) will be replaced with the given <code>cacheListener</code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">cacheListener</td><td>user-defined cache listener, or null for no cache listener </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a0ac0d6789b7d23c70bc29e9acfd3392d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0ac0d6789b7d23c70bc29e9acfd3392d">◆ </a></span>SetCacheListener() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetCacheListener </td> |
| <td>(</td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>libPath</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>factoryFunctionName</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the library path for the library that will be invoked for the listener of the region. </p> |
| <p>The previous cache listener will be replaced with a listener created using the factory function provided in the given library. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">libPath</td><td>library pathname containing the factory function. </td></tr> |
| <tr><td class="paramname">factoryFunctionName</td><td>Name of factory function that creates a <code>CacheListener</code> for a native library, or the name of the method in the form {Namespace}.{Class Name}.{Method Name} that creates an <code><a class="el" href="a00906.html" title="An application plug-in that can be installed on a region.">ICacheListener</a></code> for a managed library. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ad8457fc08a0db37208f447d4da48d9a1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad8457fc08a0db37208f447d4da48d9a1">◆ </a></span>SetCacheLoader() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetCacheLoader </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00914.html">ICacheLoader</a>< TKey, TValue >^ </td> |
| <td class="paramname"><em>cacheLoader</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the <a class="el" href="a00910.html" title="CacheLoader">CacheLoader</a> for the region. </p> |
| <p>The previous cache loader (if any) will be replaced with the given <code>cacheLoader</code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">cacheLoader</td><td>user-defined cache loader, or null for no cache loader </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a32bcb4cf4a81d81aa55d10e2145d66f4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a32bcb4cf4a81d81aa55d10e2145d66f4">◆ </a></span>SetCacheLoader() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetCacheLoader </td> |
| <td>(</td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>libPath</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>factoryFunctionName</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the library path for the library that will be invoked for the loader of the region. </p> |
| <p>The previous cache loader will be replaced with a loader created using the factory function provided in the given library. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">libPath</td><td>library pathname containing the factory function. </td></tr> |
| <tr><td class="paramname">factoryFunctionName</td><td>Name of factory function that creates a <code><a class="el" href="a00910.html" title="CacheLoader">CacheLoader</a></code> for a native library, or the name of the method in the form {Namespace}.{Class Name}.{Method Name} that creates an <code><a class="el" href="a00914.html" title="A data-loading application plug-in that can be installed on a region.">ICacheLoader</a></code> for a managed library. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a3a149fe966e798fd0907317f87139dea"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3a149fe966e798fd0907317f87139dea">◆ </a></span>SetCacheWriter() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetCacheWriter </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00918.html">ICacheWriter</a>< TKey, TValue >^ </td> |
| <td class="paramname"><em>cacheWriter</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the CacheListener for the region. </p> |
| <p>The previous cache writer (if any) will be replaced with the given <code>cacheWriter</code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">cacheWriter</td><td>user-defined cache writer, or null for no cache writer </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a16d1adc66975a9209b1d5992d0947067"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a16d1adc66975a9209b1d5992d0947067">◆ </a></span>SetCacheWriter() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetCacheWriter </td> |
| <td>(</td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>libPath</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>factoryFunctionName</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the library path for the library that will be invoked for the writer of the region. </p> |
| <p>The previous cache writer will be replaced with a writer created using the factory function provided in the given library. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">libPath</td><td>library pathname containing the factory function. </td></tr> |
| <tr><td class="paramname">factoryFunctionName</td><td>Name of factory function that creates a <code>CacheWriter</code> for a native library, or the name of the method in the form {Namespace}.{Class Name}.{Method Name} that creates an <code><a class="el" href="a00918.html" title="An application plug-in that can be installed on a region.">ICacheWriter</a></code> for a managed library. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="afd0202e11f52a8e56603f62348308f6d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afd0202e11f52a8e56603f62348308f6d">◆ </a></span>SetEntryIdleTimeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">TimeSpan <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetEntryIdleTimeout </td> |
| <td>(</td> |
| <td class="paramtype">TimeSpan </td> |
| <td class="paramname"><em>idleTimeout</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the idleTimeout duration for region entries. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">idleTimeout</td><td>the idleTimeout in seconds for entries in this region, or 0 for no idle timeout </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous value</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00638.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>if the new idleTimeout changes entry expiration from disabled to enabled or enabled to disabled. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a856f7344f40446a6f399dcc18155d8bd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a856f7344f40446a6f399dcc18155d8bd">◆ </a></span>SetEntryIdleTimeoutAction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetEntryIdleTimeoutAction </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> </td> |
| <td class="paramname"><em>action</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the idleTimeout action for region entries. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">action</td><td>the idleTimeout action for entries in this region </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous action</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a06c1f626bb5419fbdf083609d3c9a7fe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a06c1f626bb5419fbdf083609d3c9a7fe">◆ </a></span>SetEntryTimeToLive()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">TimeSpan <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetEntryTimeToLive </td> |
| <td>(</td> |
| <td class="paramtype">TimeSpan </td> |
| <td class="paramname"><em>timeToLive</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the timeToLive duration for region entries. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">timeToLive</td><td>the timeToLive in seconds for entries in this region, or 0 to disable time-to-live </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous value</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00638.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>if the new timeToLive changes entry expiration from disabled to enabled or enabled to disabled </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a8243d3f214ea3727ab1f700057e1f2f7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8243d3f214ea3727ab1f700057e1f2f7">◆ </a></span>SetEntryTimeToLiveAction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetEntryTimeToLiveAction </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> </td> |
| <td class="paramname"><em>action</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the timeToLive action for region entries. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">action</td><td>the timeToLive action for entries in this region </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous action</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a08902671c0c0a49fbd45dbb53914d54e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a08902671c0c0a49fbd45dbb53914d54e">◆ </a></span>SetLruEntriesLimit()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System::UInt32 <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetLruEntriesLimit </td> |
| <td>(</td> |
| <td class="paramtype">System::UInt32 </td> |
| <td class="paramname"><em>entriesLimit</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the maximum entry count in the region before LRU eviction. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">entriesLimit</td><td>the number of entries to allow, or 0 to disable LRU</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous value</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00638.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>if the new entriesLimit changes LRU from disabled to enabled or enabled to disabled. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ae82765ffa4933e29b71e899e9df0c6e5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae82765ffa4933e29b71e899e9df0c6e5">◆ </a></span>SetRegionIdleTimeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">TimeSpan <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetRegionIdleTimeout </td> |
| <td>(</td> |
| <td class="paramtype">TimeSpan </td> |
| <td class="paramname"><em>idleTimeout</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the idleTimeout duration for the region itself. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">idleTimeout</td><td>the idleTimeout for this region, in seconds, or 0 to disable idle timeout </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous value</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00638.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>if the new idleTimeout changes region expiration from disabled to enabled or enabled to disabled. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a95a2a37f81015bdd5352278e8fa62f0c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a95a2a37f81015bdd5352278e8fa62f0c">◆ </a></span>SetRegionIdleTimeoutAction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetRegionIdleTimeoutAction </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> </td> |
| <td class="paramname"><em>action</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the idleTimeout action for the region itself. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">action</td><td>the idleTimeout action for this region </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous action</dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa2816d3b0b54d13432efa8796799cb0a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa2816d3b0b54d13432efa8796799cb0a">◆ </a></span>SetRegionTimeToLive()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">TimeSpan <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetRegionTimeToLive </td> |
| <td>(</td> |
| <td class="paramtype">TimeSpan </td> |
| <td class="paramname"><em>timeToLive</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the timeToLive duration for the region itself. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">timeToLive</td><td>the timeToLive for this region, in seconds, or 0 to disable time-to-live </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous value</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00638.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>if the new timeToLive changes region expiration from disabled to enabled or enabled to disabled. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a8d7293fe0e09e7bc470175327dae45c2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8d7293fe0e09e7bc470175327dae45c2">◆ </a></span>SetRegionTimeToLiveAction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> <a class="el" href="a00402.html">Apache::Geode::Client::AttributesMutator</a>< TKey, TValue >::SetRegionTimeToLiveAction </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> </td> |
| <td class="paramname"><em>action</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the timeToLive action for the region itself. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">action</td><td>the timeToLiv eaction for this region </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous action</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> |