| <!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 C++ Reference: apache::geode::client::AttributesMutator Class 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 C++ 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('a00275.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 Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Supports modification of certain region attributes after the region has been created. |
| <a href="a00275.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:a757368afb9b227286dcffab5722db145"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a757368afb9b227286dcffab5722db145">AttributesMutator</a> (const std::shared_ptr< <a class="el" href="a00815.html">Region</a> > &region)</td></tr> |
| <tr class="memdesc:a757368afb9b227286dcffab5722db145"><td class="mdescLeft"> </td><td class="mdescRight">Internal constructor. <a href="#a757368afb9b227286dcffab5722db145">More...</a><br /></td></tr> |
| <tr class="separator:a757368afb9b227286dcffab5722db145"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6e3b9ff1d43662a39ad1dd2d6a42c717"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a6e3b9ff1d43662a39ad1dd2d6a42c717">setCacheListener</a> (const std::shared_ptr< <a class="el" href="a00375.html">CacheListener</a> > &aListener)</td></tr> |
| <tr class="memdesc:a6e3b9ff1d43662a39ad1dd2d6a42c717"><td class="mdescLeft"> </td><td class="mdescRight">Sets cache listener for region. <a href="#a6e3b9ff1d43662a39ad1dd2d6a42c717">More...</a><br /></td></tr> |
| <tr class="separator:a6e3b9ff1d43662a39ad1dd2d6a42c717"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a643fa1b12368d3e1f0195ad91805cb68"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a643fa1b12368d3e1f0195ad91805cb68">setCacheListener</a> (const std::string &libpath, const std::string &factoryFuncName)</td></tr> |
| <tr class="memdesc:a643fa1b12368d3e1f0195ad91805cb68"><td class="mdescLeft"> </td><td class="mdescRight">Sets cache listener for region. <a href="#a643fa1b12368d3e1f0195ad91805cb68">More...</a><br /></td></tr> |
| <tr class="separator:a643fa1b12368d3e1f0195ad91805cb68"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a12dd1f9832306addcff86742d5e98402"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a12dd1f9832306addcff86742d5e98402">setCacheLoader</a> (const std::shared_ptr< <a class="el" href="a00379.html">CacheLoader</a> > &aLoader)</td></tr> |
| <tr class="memdesc:a12dd1f9832306addcff86742d5e98402"><td class="mdescLeft"> </td><td class="mdescRight">Sets cache loader for region. <a href="#a12dd1f9832306addcff86742d5e98402">More...</a><br /></td></tr> |
| <tr class="separator:a12dd1f9832306addcff86742d5e98402"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adc32f8c1acc074b655bb7be724886ec5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#adc32f8c1acc074b655bb7be724886ec5">setCacheLoader</a> (const std::string &libpath, const std::string &factoryFuncName)</td></tr> |
| <tr class="memdesc:adc32f8c1acc074b655bb7be724886ec5"><td class="mdescLeft"> </td><td class="mdescRight">Sets cache loader for region. <a href="#adc32f8c1acc074b655bb7be724886ec5">More...</a><br /></td></tr> |
| <tr class="separator:adc32f8c1acc074b655bb7be724886ec5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a62c037d2190aaf97727a1e965ce8d441"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a62c037d2190aaf97727a1e965ce8d441">setCacheWriter</a> (const std::shared_ptr< <a class="el" href="a00391.html">CacheWriter</a> > &aWriter)</td></tr> |
| <tr class="memdesc:a62c037d2190aaf97727a1e965ce8d441"><td class="mdescLeft"> </td><td class="mdescRight">Sets cache writer for region. <a href="#a62c037d2190aaf97727a1e965ce8d441">More...</a><br /></td></tr> |
| <tr class="separator:a62c037d2190aaf97727a1e965ce8d441"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6b136882df993cbe9b6a4b188f55d6dd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a6b136882df993cbe9b6a4b188f55d6dd">setCacheWriter</a> (const std::string &libpath, const std::string &factoryFuncName)</td></tr> |
| <tr class="memdesc:a6b136882df993cbe9b6a4b188f55d6dd"><td class="mdescLeft"> </td><td class="mdescRight">Sets cache writer for region. <a href="#a6b136882df993cbe9b6a4b188f55d6dd">More...</a><br /></td></tr> |
| <tr class="separator:a6b136882df993cbe9b6a4b188f55d6dd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9211a39c69327dbc15ba1b75b57a1e1b"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a9211a39c69327dbc15ba1b75b57a1e1b">setEntryIdleTimeout</a> (std::chrono::seconds idleTimeout)</td></tr> |
| <tr class="memdesc:a9211a39c69327dbc15ba1b75b57a1e1b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the idleTimeout duration for region entries. <a href="#a9211a39c69327dbc15ba1b75b57a1e1b">More...</a><br /></td></tr> |
| <tr class="separator:a9211a39c69327dbc15ba1b75b57a1e1b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab7ec0506ae2dec959664ce1939b98907"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00895.html">ExpirationAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#ab7ec0506ae2dec959664ce1939b98907">setEntryIdleTimeoutAction</a> (<a class="el" href="a00895.html">ExpirationAction</a> action)</td></tr> |
| <tr class="memdesc:ab7ec0506ae2dec959664ce1939b98907"><td class="mdescLeft"> </td><td class="mdescRight">Set the idleTimeout Action for region entries. <a href="#ab7ec0506ae2dec959664ce1939b98907">More...</a><br /></td></tr> |
| <tr class="separator:ab7ec0506ae2dec959664ce1939b98907"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a63c92ad7301574ed03918958d995ba09"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a63c92ad7301574ed03918958d995ba09">setEntryTimeToLive</a> (std::chrono::seconds timeToLive)</td></tr> |
| <tr class="memdesc:a63c92ad7301574ed03918958d995ba09"><td class="mdescLeft"> </td><td class="mdescRight">Sets the timeToLive duration for region entries. <a href="#a63c92ad7301574ed03918958d995ba09">More...</a><br /></td></tr> |
| <tr class="separator:a63c92ad7301574ed03918958d995ba09"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a10a385f3489d1a539e64c2969ae85bfd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00895.html">ExpirationAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a10a385f3489d1a539e64c2969ae85bfd">setEntryTimeToLiveAction</a> (<a class="el" href="a00895.html">ExpirationAction</a> action)</td></tr> |
| <tr class="memdesc:a10a385f3489d1a539e64c2969ae85bfd"><td class="mdescLeft"> </td><td class="mdescRight">Set the timeToLive Action for region entries. <a href="#a10a385f3489d1a539e64c2969ae85bfd">More...</a><br /></td></tr> |
| <tr class="separator:a10a385f3489d1a539e64c2969ae85bfd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a83fdc55911b9f369196d18b6f4a9515a"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a83fdc55911b9f369196d18b6f4a9515a">setLruEntriesLimit</a> (uint32_t entriesLimit)</td></tr> |
| <tr class="memdesc:a83fdc55911b9f369196d18b6f4a9515a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the Maximum entry count in the region before LRU eviction. <a href="#a83fdc55911b9f369196d18b6f4a9515a">More...</a><br /></td></tr> |
| <tr class="separator:a83fdc55911b9f369196d18b6f4a9515a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d14eaba31d5f8f1dcce48bed5a99a64"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a1d14eaba31d5f8f1dcce48bed5a99a64">setRegionIdleTimeout</a> (std::chrono::seconds idleTimeout)</td></tr> |
| <tr class="memdesc:a1d14eaba31d5f8f1dcce48bed5a99a64"><td class="mdescLeft"> </td><td class="mdescRight">Sets the idleTimeout duration for the region itself. <a href="#a1d14eaba31d5f8f1dcce48bed5a99a64">More...</a><br /></td></tr> |
| <tr class="separator:a1d14eaba31d5f8f1dcce48bed5a99a64"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6c6c9185146c913f81007c575943fbf9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00895.html">ExpirationAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a6c6c9185146c913f81007c575943fbf9">setRegionIdleTimeoutAction</a> (<a class="el" href="a00895.html">ExpirationAction</a> action)</td></tr> |
| <tr class="memdesc:a6c6c9185146c913f81007c575943fbf9"><td class="mdescLeft"> </td><td class="mdescRight">Set the idleTimeout Action for the region itself. <a href="#a6c6c9185146c913f81007c575943fbf9">More...</a><br /></td></tr> |
| <tr class="separator:a6c6c9185146c913f81007c575943fbf9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9334005f05819fc4e7c41b5c3474e70e"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a9334005f05819fc4e7c41b5c3474e70e">setRegionTimeToLive</a> (std::chrono::seconds timeToLive)</td></tr> |
| <tr class="memdesc:a9334005f05819fc4e7c41b5c3474e70e"><td class="mdescLeft"> </td><td class="mdescRight">Sets the timeToLive duration for the region itself. <a href="#a9334005f05819fc4e7c41b5c3474e70e">More...</a><br /></td></tr> |
| <tr class="separator:a9334005f05819fc4e7c41b5c3474e70e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6582b9d301f10ca95036a76d6ed53428"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00895.html">ExpirationAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00275.html#a6582b9d301f10ca95036a76d6ed53428">setRegionTimeToLiveAction</a> (<a class="el" href="a00895.html">ExpirationAction</a> action)</td></tr> |
| <tr class="memdesc:a6582b9d301f10ca95036a76d6ed53428"><td class="mdescLeft"> </td><td class="mdescRight">Set the timeToLive Action for the region itself. <a href="#a6582b9d301f10ca95036a76d6ed53428">More...</a><br /></td></tr> |
| <tr class="separator:a6582b9d301f10ca95036a76d6ed53428"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><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="a00823.html">RegionAttributesFactory</a> before creating the region. <a class="el" href="a00275.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><a class="el" href="a00815.html#a2adce4f4840cd90bcddeee212f818b65" title="Return the a mutator object for changing a subset of the region attributes.">Region::getAttributesMutator</a> </dd> |
| <dd> |
| <a class="el" href="a00819.html" title="Defines attributes for configuring a region.">RegionAttributes</a> </dd> |
| <dd> |
| <a class="el" href="a00823.html" title="Creates instances of RegionAttributes.">RegionAttributesFactory</a> </dd></dl> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a757368afb9b227286dcffab5722db145"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a757368afb9b227286dcffab5722db145">◆ </a></span>AttributesMutator()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">apache::geode::client::AttributesMutator::AttributesMutator </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00815.html">Region</a> > & </td> |
| <td class="paramname"><em>region</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Internal constructor. </p> |
| <p>Use <a class="el" href="a00815.html#a2adce4f4840cd90bcddeee212f818b65" title="Return the a mutator object for changing a subset of the region attributes.">Region::getAttributesMutator()</a> to acquire the mutator for a region. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a6e3b9ff1d43662a39ad1dd2d6a42c717"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6e3b9ff1d43662a39ad1dd2d6a42c717">◆ </a></span>setCacheListener() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void apache::geode::client::AttributesMutator::setCacheListener </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00375.html">CacheListener</a> > & </td> |
| <td class="paramname"><em>aListener</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets cache listener for region. </p> |
| <p>The previous cache listener will be replaced with <code>aListener</code>. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">aListener</td><td>cache listener </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a643fa1b12368d3e1f0195ad91805cb68"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a643fa1b12368d3e1f0195ad91805cb68">◆ </a></span>setCacheListener() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void apache::geode::client::AttributesMutator::setCacheListener </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>libpath</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>factoryFuncName</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets cache listener for 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>path of the library containing cache listener factory function. </td></tr> |
| <tr><td class="paramname">factoryFuncName</td><td>factory function for creating cache listener. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a12dd1f9832306addcff86742d5e98402"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a12dd1f9832306addcff86742d5e98402">◆ </a></span>setCacheLoader() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void apache::geode::client::AttributesMutator::setCacheLoader </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00379.html">CacheLoader</a> > & </td> |
| <td class="paramname"><em>aLoader</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets cache loader for region. </p> |
| <p>The previous cache loader will be replaced with <code>aLoader</code>. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">aLoader</td><td>cache loader </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="adc32f8c1acc074b655bb7be724886ec5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adc32f8c1acc074b655bb7be724886ec5">◆ </a></span>setCacheLoader() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void apache::geode::client::AttributesMutator::setCacheLoader </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>libpath</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>factoryFuncName</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets cache loader for 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>path of the library containing cache loader factory function. </td></tr> |
| <tr><td class="paramname">factoryFuncName</td><td>factory function for creating cache loader. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a62c037d2190aaf97727a1e965ce8d441"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a62c037d2190aaf97727a1e965ce8d441">◆ </a></span>setCacheWriter() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void apache::geode::client::AttributesMutator::setCacheWriter </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00391.html">CacheWriter</a> > & </td> |
| <td class="paramname"><em>aWriter</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets cache writer for region. </p> |
| <p>The previous cache writer will be replaced with <code>aWriter</code>. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">aWriter</td><td>cache writer </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6b136882df993cbe9b6a4b188f55d6dd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6b136882df993cbe9b6a4b188f55d6dd">◆ </a></span>setCacheWriter() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void apache::geode::client::AttributesMutator::setCacheWriter </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>libpath</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>factoryFuncName</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets cache writer for 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>path of the library containing cache writer factory function. </td></tr> |
| <tr><td class="paramname">factoryFuncName</td><td>factory function for creating cache writer. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a9211a39c69327dbc15ba1b75b57a1e1b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9211a39c69327dbc15ba1b75b57a1e1b">◆ </a></span>setEntryIdleTimeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds apache::geode::client::AttributesMutator::setEntryIdleTimeout </td> |
| <td>(</td> |
| <td class="paramtype">std::chrono::seconds </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 for entries in this region. </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="a00475.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="ab7ec0506ae2dec959664ce1939b98907"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab7ec0506ae2dec959664ce1939b98907">◆ </a></span>setEntryIdleTimeoutAction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00895.html">ExpirationAction</a> apache::geode::client::AttributesMutator::setEntryIdleTimeoutAction </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00895.html">ExpirationAction</a> </td> |
| <td class="paramname"><em>action</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set 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 <a class="el" href="a00895.html" title="Enumerated type for expiration actions.">ExpirationAction</a> for entries in this region. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous value. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a63c92ad7301574ed03918958d995ba09"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a63c92ad7301574ed03918958d995ba09">◆ </a></span>setEntryTimeToLive()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds apache::geode::client::AttributesMutator::setEntryTimeToLive </td> |
| <td>(</td> |
| <td class="paramtype">std::chrono::seconds </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 for entries in this region. </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="a00475.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="a10a385f3489d1a539e64c2969ae85bfd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a10a385f3489d1a539e64c2969ae85bfd">◆ </a></span>setEntryTimeToLiveAction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00895.html">ExpirationAction</a> apache::geode::client::AttributesMutator::setEntryTimeToLiveAction </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00895.html">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 <a class="el" href="a00895.html" title="Enumerated type for expiration actions.">ExpirationAction</a> for entries in this region. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous value. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a83fdc55911b9f369196d18b6f4a9515a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a83fdc55911b9f369196d18b6f4a9515a">◆ </a></span>setLruEntriesLimit()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint32_t apache::geode::client::AttributesMutator::setLruEntriesLimit </td> |
| <td>(</td> |
| <td class="paramtype">uint32_t </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. </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="a00475.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="a1d14eaba31d5f8f1dcce48bed5a99a64"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1d14eaba31d5f8f1dcce48bed5a99a64">◆ </a></span>setRegionIdleTimeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds apache::geode::client::AttributesMutator::setRegionIdleTimeout </td> |
| <td>(</td> |
| <td class="paramtype">std::chrono::seconds </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 <a class="el" href="a00731.html" title="Immutable parameter object for accessing and setting the attributes associated with timeToLive and id...">ExpirationAttributes</a> for this region idleTimeout </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="a00475.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="a6c6c9185146c913f81007c575943fbf9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6c6c9185146c913f81007c575943fbf9">◆ </a></span>setRegionIdleTimeoutAction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00895.html">ExpirationAction</a> apache::geode::client::AttributesMutator::setRegionIdleTimeoutAction </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00895.html">ExpirationAction</a> </td> |
| <td class="paramname"><em>action</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set 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 <a class="el" href="a00895.html" title="Enumerated type for expiration actions.">ExpirationAction</a> for this region. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous value. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a9334005f05819fc4e7c41b5c3474e70e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9334005f05819fc4e7c41b5c3474e70e">◆ </a></span>setRegionTimeToLive()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds apache::geode::client::AttributesMutator::setRegionTimeToLive </td> |
| <td>(</td> |
| <td class="paramtype">std::chrono::seconds </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 <a class="el" href="a00731.html" title="Immutable parameter object for accessing and setting the attributes associated with timeToLive and id...">ExpirationAttributes</a> for this region timeToLive </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="a00475.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="a6582b9d301f10ca95036a76d6ed53428"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6582b9d301f10ca95036a76d6ed53428">◆ </a></span>setRegionTimeToLiveAction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00895.html">ExpirationAction</a> apache::geode::client::AttributesMutator::setRegionTimeToLiveAction </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00895.html">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 the region itself. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">action</td><td>the timeToLive <a class="el" href="a00895.html" title="Enumerated type for expiration actions.">ExpirationAction</a> for this region. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the previous value. </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 API Documentation</small></address> |
