| <!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::RegionAttributes 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('a00819.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="#pub-static-methods">Static Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">apache::geode::client::RegionAttributes Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Defines attributes for configuring a region. |
| <a href="a00819.html#details">More...</a></p> |
| |
| <p>Inherits DataSerializableInternal.</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:a0559c5d8f55046ac81548c7d4592859e"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="a00375.html">CacheListener</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a0559c5d8f55046ac81548c7d4592859e">getCacheListener</a> () const</td></tr> |
| <tr class="memdesc:a0559c5d8f55046ac81548c7d4592859e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the cache listener for the region. <a href="#a0559c5d8f55046ac81548c7d4592859e">More...</a><br /></td></tr> |
| <tr class="separator:a0559c5d8f55046ac81548c7d4592859e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abbb7966289ac6dc9d04671238812a3b4"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#abbb7966289ac6dc9d04671238812a3b4">getCacheListenerFactory</a> () const</td></tr> |
| <tr class="memdesc:abbb7966289ac6dc9d04671238812a3b4"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the symbol name of the factory function from which the loader will be created on a cache server. <a href="#abbb7966289ac6dc9d04671238812a3b4">More...</a><br /></td></tr> |
| <tr class="separator:abbb7966289ac6dc9d04671238812a3b4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac0461a1dd613db7cd842961e1d648cb4"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#ac0461a1dd613db7cd842961e1d648cb4">getCacheListenerLibrary</a> () const</td></tr> |
| <tr class="memdesc:ac0461a1dd613db7cd842961e1d648cb4"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the path of the library from which the factory function will be invoked on a cache server. <a href="#ac0461a1dd613db7cd842961e1d648cb4">More...</a><br /></td></tr> |
| <tr class="separator:ac0461a1dd613db7cd842961e1d648cb4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a05acc3f27725cedb124d6971f51e47cd"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="a00379.html">CacheLoader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a05acc3f27725cedb124d6971f51e47cd">getCacheLoader</a> () const</td></tr> |
| <tr class="memdesc:a05acc3f27725cedb124d6971f51e47cd"><td class="mdescLeft"> </td><td class="mdescRight">public static methods <a href="#a05acc3f27725cedb124d6971f51e47cd">More...</a><br /></td></tr> |
| <tr class="separator:a05acc3f27725cedb124d6971f51e47cd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af3d0e878d104eca15080bd798dae2b73"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#af3d0e878d104eca15080bd798dae2b73">getCacheLoaderFactory</a> () const</td></tr> |
| <tr class="memdesc:af3d0e878d104eca15080bd798dae2b73"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the symbol name of the factory function from which the loader will be created on a cache server. <a href="#af3d0e878d104eca15080bd798dae2b73">More...</a><br /></td></tr> |
| <tr class="separator:af3d0e878d104eca15080bd798dae2b73"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa414080570e98b401a3034c8c397c402"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#aa414080570e98b401a3034c8c397c402">getCacheLoaderLibrary</a> () const</td></tr> |
| <tr class="memdesc:aa414080570e98b401a3034c8c397c402"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the path of the library from which the factory function will be invoked on a cache server. <a href="#aa414080570e98b401a3034c8c397c402">More...</a><br /></td></tr> |
| <tr class="separator:aa414080570e98b401a3034c8c397c402"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a35035c6637097a219d52153da5792439"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="a00391.html">CacheWriter</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a35035c6637097a219d52153da5792439">getCacheWriter</a> () const</td></tr> |
| <tr class="memdesc:a35035c6637097a219d52153da5792439"><td class="mdescLeft"> </td><td class="mdescRight">Gets the cache writer for the region. <a href="#a35035c6637097a219d52153da5792439">More...</a><br /></td></tr> |
| <tr class="separator:a35035c6637097a219d52153da5792439"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adf688606a9cf43cdef895703677c9845"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#adf688606a9cf43cdef895703677c9845">getCacheWriterFactory</a> () const</td></tr> |
| <tr class="memdesc:adf688606a9cf43cdef895703677c9845"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the symbol name of the factory function from which the loader will be created on a cache server. <a href="#adf688606a9cf43cdef895703677c9845">More...</a><br /></td></tr> |
| <tr class="separator:adf688606a9cf43cdef895703677c9845"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a38aff3a3df943f0e607ae85967bc115f"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a38aff3a3df943f0e607ae85967bc115f">getCacheWriterLibrary</a> () const</td></tr> |
| <tr class="memdesc:a38aff3a3df943f0e607ae85967bc115f"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the path of the library from which the factory function will be invoked on a cache server. <a href="#a38aff3a3df943f0e607ae85967bc115f">More...</a><br /></td></tr> |
| <tr class="separator:a38aff3a3df943f0e607ae85967bc115f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8ff9ff60a624ac82a42b0328b393540d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a8ff9ff60a624ac82a42b0328b393540d">getCachingEnabled</a> () const</td></tr> |
| <tr class="memdesc:a8ff9ff60a624ac82a42b0328b393540d"><td class="mdescLeft"> </td><td class="mdescRight">If true, this region will store data in the current process. <a href="#a8ff9ff60a624ac82a42b0328b393540d">More...</a><br /></td></tr> |
| <tr class="separator:a8ff9ff60a624ac82a42b0328b393540d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0b3cd67a20bad86e7da3c0ef946a715f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a0b3cd67a20bad86e7da3c0ef946a715f">getClientNotificationEnabled</a> () const</td></tr> |
| <tr class="memdesc:a0b3cd67a20bad86e7da3c0ef946a715f"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the setting of client notification. <a href="#a0b3cd67a20bad86e7da3c0ef946a715f">More...</a><br /></td></tr> |
| <tr class="separator:a0b3cd67a20bad86e7da3c0ef946a715f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac6d5bc8f80023f210525eec6da5464f8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#ac6d5bc8f80023f210525eec6da5464f8">getConcurrencyChecksEnabled</a> () const</td></tr> |
| <tr class="memdesc:ac6d5bc8f80023f210525eec6da5464f8"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if concurrent update checks are turned on for this region. <a href="#ac6d5bc8f80023f210525eec6da5464f8">More...</a><br /></td></tr> |
| <tr class="separator:ac6d5bc8f80023f210525eec6da5464f8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5d7d85bd00332cb58886d7d1419931da"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a5d7d85bd00332cb58886d7d1419931da">getConcurrencyLevel</a> () const</td></tr> |
| <tr class="memdesc:a5d7d85bd00332cb58886d7d1419931da"><td class="mdescLeft"> </td><td class="mdescRight">Returns the concurrencyLevel of the entry's local cache. <a href="#a5d7d85bd00332cb58886d7d1419931da">More...</a><br /></td></tr> |
| <tr class="separator:a5d7d85bd00332cb58886d7d1419931da"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aadb3a445d051a33908dbdba3f549ba34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00891.html">DiskPolicyType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#aadb3a445d051a33908dbdba3f549ba34">getDiskPolicy</a> () const</td></tr> |
| <tr class="memdesc:aadb3a445d051a33908dbdba3f549ba34"><td class="mdescLeft"> </td><td class="mdescRight">Returns the disk policy type of the region. <a href="#aadb3a445d051a33908dbdba3f549ba34">More...</a><br /></td></tr> |
| <tr class="separator:aadb3a445d051a33908dbdba3f549ba34"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a26c8404680c29e9be8681591e540b942"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a26c8404680c29e9be8681591e540b942">getEndpoints</a> () const</td></tr> |
| <tr class="memdesc:a26c8404680c29e9be8681591e540b942"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the list of servername:portno separated by comma. <a href="#a26c8404680c29e9be8681591e540b942">More...</a><br /></td></tr> |
| <tr class="separator:a26c8404680c29e9be8681591e540b942"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adafb77e8a8911700fd7a03a40819399e"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#adafb77e8a8911700fd7a03a40819399e">getEntryIdleTimeout</a> () const</td></tr> |
| <tr class="memdesc:adafb77e8a8911700fd7a03a40819399e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the <code>idleTimeout</code> expiration attributes for entries in this region. <a href="#adafb77e8a8911700fd7a03a40819399e">More...</a><br /></td></tr> |
| <tr class="separator:adafb77e8a8911700fd7a03a40819399e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa8d0224cf85e7560a0f8093a5f28ba4c"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#aa8d0224cf85e7560a0f8093a5f28ba4c">getEntryTimeToLive</a> () const</td></tr> |
| <tr class="memdesc:aa8d0224cf85e7560a0f8093a5f28ba4c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the <code>timeToLive</code> expiration attributes for entries in this region. <a href="#aa8d0224cf85e7560a0f8093a5f28ba4c">More...</a><br /></td></tr> |
| <tr class="separator:aa8d0224cf85e7560a0f8093a5f28ba4c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0a0c95fbf527b19d679db2dad581c4d9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a0a0c95fbf527b19d679db2dad581c4d9">getInitialCapacity</a> () const</td></tr> |
| <tr class="memdesc:a0a0c95fbf527b19d679db2dad581c4d9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the initial capacity of the entry's local cache. <a href="#a0a0c95fbf527b19d679db2dad581c4d9">More...</a><br /></td></tr> |
| <tr class="separator:a0a0c95fbf527b19d679db2dad581c4d9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:add327378171a7b5939ff8e1d9b24bdbf"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#add327378171a7b5939ff8e1d9b24bdbf">getLoadFactor</a> () const</td></tr> |
| <tr class="memdesc:add327378171a7b5939ff8e1d9b24bdbf"><td class="mdescLeft"> </td><td class="mdescRight">Returns the load factor of the entry's local cache. <a href="#add327378171a7b5939ff8e1d9b24bdbf">More...</a><br /></td></tr> |
| <tr class="separator:add327378171a7b5939ff8e1d9b24bdbf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa5c30d89610395f0e46842cce2e138b3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#aa5c30d89610395f0e46842cce2e138b3">getLruEntriesLimit</a> () const</td></tr> |
| <tr class="memdesc:aa5c30d89610395f0e46842cce2e138b3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum number of entries this cache will hold before using LRU eviction. <a href="#aa5c30d89610395f0e46842cce2e138b3">More...</a><br /></td></tr> |
| <tr class="separator:aa5c30d89610395f0e46842cce2e138b3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae3d2c2b248eabced8ca96cecf5ff1474"><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="a00819.html#ae3d2c2b248eabced8ca96cecf5ff1474">getLruEvictionAction</a> () const</td></tr> |
| <tr class="memdesc:ae3d2c2b248eabced8ca96cecf5ff1474"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="a00895.html" title="Enumerated type for expiration actions.">ExpirationAction</a> used for LRU Eviction, default is LOCAL_DESTROY. <a href="#ae3d2c2b248eabced8ca96cecf5ff1474">More...</a><br /></td></tr> |
| <tr class="separator:ae3d2c2b248eabced8ca96cecf5ff1474"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab9d921c582a2e64fed61d8efb07474f2"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="a00747.html">PartitionResolver</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#ab9d921c582a2e64fed61d8efb07474f2">getPartitionResolver</a> () const</td></tr> |
| <tr class="memdesc:ab9d921c582a2e64fed61d8efb07474f2"><td class="mdescLeft"> </td><td class="mdescRight">Gets the partition resolver for the partition region. <a href="#ab9d921c582a2e64fed61d8efb07474f2">More...</a><br /></td></tr> |
| <tr class="separator:ab9d921c582a2e64fed61d8efb07474f2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad15cc5f96e195e50abf3183e46322352"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#ad15cc5f96e195e50abf3183e46322352">getPartitionResolverFactory</a> () const</td></tr> |
| <tr class="memdesc:ad15cc5f96e195e50abf3183e46322352"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the symbol name of the factory function from which the loader will be created on a cache server. <a href="#ad15cc5f96e195e50abf3183e46322352">More...</a><br /></td></tr> |
| <tr class="separator:ad15cc5f96e195e50abf3183e46322352"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aea7488fd1ff9a3f499b0d562193075ad"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#aea7488fd1ff9a3f499b0d562193075ad">getPartitionResolverLibrary</a> () const</td></tr> |
| <tr class="memdesc:aea7488fd1ff9a3f499b0d562193075ad"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the path of the library from which the factory function will be invoked on a cache server. <a href="#aea7488fd1ff9a3f499b0d562193075ad">More...</a><br /></td></tr> |
| <tr class="separator:aea7488fd1ff9a3f499b0d562193075ad"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a33335502d396e74f2e26a92c7a9bb0ba"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a33335502d396e74f2e26a92c7a9bb0ba">getPersistenceFactory</a> () const</td></tr> |
| <tr class="memdesc:a33335502d396e74f2e26a92c7a9bb0ba"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the symbol name of the factory function from which the persistence will be created on a cache server. <a href="#a33335502d396e74f2e26a92c7a9bb0ba">More...</a><br /></td></tr> |
| <tr class="separator:a33335502d396e74f2e26a92c7a9bb0ba"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3ed439d3bbd9acef0eabd75534cf37c0"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a3ed439d3bbd9acef0eabd75534cf37c0">getPersistenceLibrary</a> () const</td></tr> |
| <tr class="memdesc:a3ed439d3bbd9acef0eabd75534cf37c0"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the path of the library from which the factory function will be invoked on a cache server. <a href="#a3ed439d3bbd9acef0eabd75534cf37c0">More...</a><br /></td></tr> |
| <tr class="separator:a3ed439d3bbd9acef0eabd75534cf37c0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa905ba715bc77f58bcca87ff68799d71"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="a00783.html">PersistenceManager</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#aa905ba715bc77f58bcca87ff68799d71">getPersistenceManager</a> () const</td></tr> |
| <tr class="memdesc:aa905ba715bc77f58bcca87ff68799d71"><td class="mdescLeft"> </td><td class="mdescRight">Gets the persistence for the region. <a href="#aa905ba715bc77f58bcca87ff68799d71">More...</a><br /></td></tr> |
| <tr class="separator:aa905ba715bc77f58bcca87ff68799d71"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abe7e19a74772efb506591af3efcea690"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="a00799.html">Properties</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#abe7e19a74772efb506591af3efcea690">getPersistenceProperties</a> () const</td></tr> |
| <tr class="memdesc:abe7e19a74772efb506591af3efcea690"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the properties pointer which is set for persistence. <a href="#abe7e19a74772efb506591af3efcea690">More...</a><br /></td></tr> |
| <tr class="separator:abe7e19a74772efb506591af3efcea690"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ef565df384a6baacc0b99d2208a23db"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a4ef565df384a6baacc0b99d2208a23db">getPoolName</a> () const</td></tr> |
| <tr class="memdesc:a4ef565df384a6baacc0b99d2208a23db"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the pool attached to the region. <a href="#a4ef565df384a6baacc0b99d2208a23db">More...</a><br /></td></tr> |
| <tr class="separator:a4ef565df384a6baacc0b99d2208a23db"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2d89a9710549507d545cb9b1559dd740"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a2d89a9710549507d545cb9b1559dd740">getRegionIdleTimeout</a> () const</td></tr> |
| <tr class="memdesc:a2d89a9710549507d545cb9b1559dd740"><td class="mdescLeft"> </td><td class="mdescRight">Gets the idleTimeout expiration attributes for the region as a whole. <a href="#a2d89a9710549507d545cb9b1559dd740">More...</a><br /></td></tr> |
| <tr class="separator:a2d89a9710549507d545cb9b1559dd740"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a297b9a11086ae8d1d85bebc20106cb82"><td class="memItemLeft" align="right" valign="top">std::chrono::seconds </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a297b9a11086ae8d1d85bebc20106cb82">getRegionTimeToLive</a> () const</td></tr> |
| <tr class="memdesc:a297b9a11086ae8d1d85bebc20106cb82"><td class="mdescLeft"> </td><td class="mdescRight">Gets the <code>timeToLive</code> expiration attributes for the region as a whole. <a href="#a297b9a11086ae8d1d85bebc20106cb82">More...</a><br /></td></tr> |
| <tr class="separator:a297b9a11086ae8d1d85bebc20106cb82"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a970a3f610db9e5be479f2e0a1fb802d0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a970a3f610db9e5be479f2e0a1fb802d0">operator!=</a> (const <a class="el" href="a00819.html">RegionAttributes</a> &other) const</td></tr> |
| <tr class="memdesc:a970a3f610db9e5be479f2e0a1fb802d0"><td class="mdescLeft"> </td><td class="mdescRight">Return true if any of the attributes are not equal to those of other. <a href="#a970a3f610db9e5be479f2e0a1fb802d0">More...</a><br /></td></tr> |
| <tr class="separator:a970a3f610db9e5be479f2e0a1fb802d0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae765606ca65aff466f84290431d137de"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#ae765606ca65aff466f84290431d137de">operator==</a> (const <a class="el" href="a00819.html">RegionAttributes</a> &other) const</td></tr> |
| <tr class="memdesc:ae765606ca65aff466f84290431d137de"><td class="mdescLeft"> </td><td class="mdescRight">Return true if all the attributes are equal to those of other. <a href="#ae765606ca65aff466f84290431d137de">More...</a><br /></td></tr> |
| <tr class="separator:ae765606ca65aff466f84290431d137de"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8b93a9e7900c38eecbccb484d1dd2740"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#a8b93a9e7900c38eecbccb484d1dd2740">validateSerializableAttributes</a> ()</td></tr> |
| <tr class="memdesc:a8b93a9e7900c38eecbccb484d1dd2740"><td class="mdescLeft"> </td><td class="mdescRight">throws <a class="el" href="a00475.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a> if the attributes are not suited for serialization such as those that have a cache callback (listener, loader, or writer) set directly instead of through the string value setters. <a href="#a8b93a9e7900c38eecbccb484d1dd2740">More...</a><br /></td></tr> |
| <tr class="separator:a8b93a9e7900c38eecbccb484d1dd2740"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:ac0d5d862474e766a98cb046c64926311"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="a00855.html">Serializable</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00819.html#ac0d5d862474e766a98cb046c64926311">createDeserializable</a> ()</td></tr> |
| <tr class="memdesc:ac0d5d862474e766a98cb046c64926311"><td class="mdescLeft"> </td><td class="mdescRight">Return an empty instance for deserialization. <a href="#ac0d5d862474e766a98cb046c64926311">More...</a><br /></td></tr> |
| <tr class="separator:ac0d5d862474e766a98cb046c64926311"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Defines attributes for configuring a region. </p> |
| <p>These are <code><a class="el" href="a00375.html" title="An application plug-in that can be installed on a region.">CacheListener</a></code>, <code><a class="el" href="a00379.html" title="An application plug-in that can be installed on a region.">CacheLoader</a></code>, <code><a class="el" href="a00391.html" title="An application plug-in that can be installed on the region.">CacheWriter</a></code>, scope expiration attributes for the region itself; expiration attributes for the region entries; and whether statistics are enabled for the region and its entries.</p> |
| <p>To create an instance of this interface, use {<a class="el" href="a00823.html#a01faefe121ebef9a498bc65e7b67f464">}. For compatibility rules and default values, see { RegionAttributesFactory}. </a>Note that the <code><a class="el" href="a00819.html" title="Defines attributes for configuring a region.">RegionAttributes</a></code> are not distributed with the region.</p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00823.html" title="Creates instances of RegionAttributes.">RegionAttributesFactory</a> </dd> |
| <dd> |
| <a class="el" href="a00275.html" title="Supports modification of certain region attributes after the region has been created.">AttributesMutator</a> </dd> |
| <dd> |
| <a class="el" href="a00815.html#ac2cc9292b643aa332f13c79c24c5dbb6" title="Return the RegionAttributes for this region.">Region::getAttributes</a> </dd></dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ac0d5d862474e766a98cb046c64926311"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac0d5d862474e766a98cb046c64926311">◆ </a></span>createDeserializable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static std::shared_ptr<<a class="el" href="a00855.html">Serializable</a>> apache::geode::client::RegionAttributes::createDeserializable </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return an empty instance for deserialization. </p> |
| |
| </div> |
| </div> |
| <a id="a0559c5d8f55046ac81548c7d4592859e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0559c5d8f55046ac81548c7d4592859e">◆ </a></span>getCacheListener()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="a00375.html">CacheListener</a>> apache::geode::client::RegionAttributes::getCacheListener </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the cache listener for the region. </p> |
| <dl class="section return"><dt>Returns</dt><dd>a pointer that points to the region's , <code><a class="el" href="a00375.html" title="An application plug-in that can be installed on a region.">CacheListener</a></code> , nullptr if there is no <a class="el" href="a00375.html" title="An application plug-in that can be installed on a region.">CacheListener</a> defined for this region. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="abbb7966289ac6dc9d04671238812a3b4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abbb7966289ac6dc9d04671238812a3b4">◆ </a></span>getCacheListenerFactory()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getCacheListenerFactory </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the symbol name of the factory function from which the loader will be created on a cache server. </p> |
| |
| </div> |
| </div> |
| <a id="ac0461a1dd613db7cd842961e1d648cb4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac0461a1dd613db7cd842961e1d648cb4">◆ </a></span>getCacheListenerLibrary()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getCacheListenerLibrary </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the path of the library from which the factory function will be invoked on a cache server. </p> |
| |
| </div> |
| </div> |
| <a id="a05acc3f27725cedb124d6971f51e47cd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a05acc3f27725cedb124d6971f51e47cd">◆ </a></span>getCacheLoader()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="a00379.html">CacheLoader</a>> apache::geode::client::RegionAttributes::getCacheLoader </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>public static methods </p> |
| <p>Gets the cache loader for the region. </p><dl class="section return"><dt>Returns</dt><dd>a pointer that points to the region's , <code><a class="el" href="a00379.html" title="An application plug-in that can be installed on a region.">CacheLoader</a></code> , nullptr if there is no <a class="el" href="a00379.html" title="An application plug-in that can be installed on a region.">CacheLoader</a> for this region. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="af3d0e878d104eca15080bd798dae2b73"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af3d0e878d104eca15080bd798dae2b73">◆ </a></span>getCacheLoaderFactory()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getCacheLoaderFactory </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the symbol name of the factory function from which the loader will be created on a cache server. </p> |
| |
| </div> |
| </div> |
| <a id="aa414080570e98b401a3034c8c397c402"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa414080570e98b401a3034c8c397c402">◆ </a></span>getCacheLoaderLibrary()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getCacheLoaderLibrary </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the path of the library from which the factory function will be invoked on a cache server. </p> |
| |
| </div> |
| </div> |
| <a id="a35035c6637097a219d52153da5792439"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a35035c6637097a219d52153da5792439">◆ </a></span>getCacheWriter()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="a00391.html">CacheWriter</a>> apache::geode::client::RegionAttributes::getCacheWriter </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the cache writer for the region. </p> |
| <dl class="section return"><dt>Returns</dt><dd>a pointer that points to the region's , <code><a class="el" href="a00391.html" title="An application plug-in that can be installed on the region.">CacheWriter</a></code> , nullptr if there is no <a class="el" href="a00391.html" title="An application plug-in that can be installed on the region.">CacheWriter</a> for this region </dd></dl> |
| |
| </div> |
| </div> |
| <a id="adf688606a9cf43cdef895703677c9845"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adf688606a9cf43cdef895703677c9845">◆ </a></span>getCacheWriterFactory()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getCacheWriterFactory </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the symbol name of the factory function from which the loader will be created on a cache server. </p> |
| |
| </div> |
| </div> |
| <a id="a38aff3a3df943f0e607ae85967bc115f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a38aff3a3df943f0e607ae85967bc115f">◆ </a></span>getCacheWriterLibrary()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getCacheWriterLibrary </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the path of the library from which the factory function will be invoked on a cache server. </p> |
| |
| </div> |
| </div> |
| <a id="a8ff9ff60a624ac82a42b0328b393540d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8ff9ff60a624ac82a42b0328b393540d">◆ </a></span>getCachingEnabled()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool apache::geode::client::RegionAttributes::getCachingEnabled </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>If true, this region will store data in the current process. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true or false, indicating cachingEnabled state. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a0b3cd67a20bad86e7da3c0ef946a715f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0b3cd67a20bad86e7da3c0ef946a715f">◆ </a></span>getClientNotificationEnabled()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool apache::geode::client::RegionAttributes::getClientNotificationEnabled </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the setting of client notification. </p> |
| |
| </div> |
| </div> |
| <a id="ac6d5bc8f80023f210525eec6da5464f8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac6d5bc8f80023f210525eec6da5464f8">◆ </a></span>getConcurrencyChecksEnabled()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool apache::geode::client::RegionAttributes::getConcurrencyChecksEnabled </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns true if concurrent update checks are turned on for this region. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if concurrent update checks are turned on </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a5d7d85bd00332cb58886d7d1419931da"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5d7d85bd00332cb58886d7d1419931da">◆ </a></span>getConcurrencyLevel()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint8_t apache::geode::client::RegionAttributes::getConcurrencyLevel </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the concurrencyLevel of the entry's local cache. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the concurrencyLevel </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00823.html" title="Creates instances of RegionAttributes.">RegionAttributesFactory</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aadb3a445d051a33908dbdba3f549ba34"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aadb3a445d051a33908dbdba3f549ba34">◆ </a></span>getDiskPolicy()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00891.html">DiskPolicyType</a> apache::geode::client::RegionAttributes::getDiskPolicy </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the disk policy type of the region. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the <code><a class="el" href="a00891.html" title="Enumerated type for disk policy.">DiskPolicyType</a></code>, default is DiskPolicyType::NONE. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a26c8404680c29e9be8681591e540b942"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a26c8404680c29e9be8681591e540b942">◆ </a></span>getEndpoints()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getEndpoints </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the list of servername:portno separated by comma. </p> |
| |
| </div> |
| </div> |
| <a id="adafb77e8a8911700fd7a03a40819399e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adafb77e8a8911700fd7a03a40819399e">◆ </a></span>getEntryIdleTimeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds apache::geode::client::RegionAttributes::getEntryIdleTimeout </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the <code>idleTimeout</code> expiration attributes for entries in this region. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the idleTimeout expiration attributes for entries in this region </dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">Duration</td><td>std::chrono::duration type to return </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aa8d0224cf85e7560a0f8093a5f28ba4c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa8d0224cf85e7560a0f8093a5f28ba4c">◆ </a></span>getEntryTimeToLive()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds apache::geode::client::RegionAttributes::getEntryTimeToLive </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the <code>timeToLive</code> expiration attributes for entries in this region. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the timeToLive expiration attributes for entries in this region </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a0a0c95fbf527b19d679db2dad581c4d9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0a0c95fbf527b19d679db2dad581c4d9">◆ </a></span>getInitialCapacity()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int apache::geode::client::RegionAttributes::getInitialCapacity </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the initial capacity of the entry's local cache. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the initial capacity of the entry's local cache </dd></dl> |
| |
| </div> |
| </div> |
| <a id="add327378171a7b5939ff8e1d9b24bdbf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#add327378171a7b5939ff8e1d9b24bdbf">◆ </a></span>getLoadFactor()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">float apache::geode::client::RegionAttributes::getLoadFactor </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the load factor of the entry's local cache. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the load factor of the entry's local cache </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa5c30d89610395f0e46842cce2e138b3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa5c30d89610395f0e46842cce2e138b3">◆ </a></span>getLruEntriesLimit()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint32_t apache::geode::client::RegionAttributes::getLruEntriesLimit </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the maximum number of entries this cache will hold before using LRU eviction. </p> |
| <p>A return value of zero, 0, indicates no limit. </p> |
| |
| </div> |
| </div> |
| <a id="ae3d2c2b248eabced8ca96cecf5ff1474"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae3d2c2b248eabced8ca96cecf5ff1474">◆ </a></span>getLruEvictionAction()</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::RegionAttributes::getLruEvictionAction </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the <a class="el" href="a00895.html" title="Enumerated type for expiration actions.">ExpirationAction</a> used for LRU Eviction, default is LOCAL_DESTROY. </p> |
| |
| </div> |
| </div> |
| <a id="ab9d921c582a2e64fed61d8efb07474f2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab9d921c582a2e64fed61d8efb07474f2">◆ </a></span>getPartitionResolver()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="a00747.html">PartitionResolver</a>> apache::geode::client::RegionAttributes::getPartitionResolver </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the partition resolver for the partition region. </p> |
| <dl class="section return"><dt>Returns</dt><dd>a pointer that points to the region's , <code><a class="el" href="a00747.html" title="Implement the PartitionResolver interface to enable custom partitioning on the PartitionedRegion.">PartitionResolver</a></code> , nullptr if there is no <a class="el" href="a00747.html" title="Implement the PartitionResolver interface to enable custom partitioning on the PartitionedRegion.">PartitionResolver</a> defined for this region. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad15cc5f96e195e50abf3183e46322352"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad15cc5f96e195e50abf3183e46322352">◆ </a></span>getPartitionResolverFactory()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getPartitionResolverFactory </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the symbol name of the factory function from which the loader will be created on a cache server. </p> |
| |
| </div> |
| </div> |
| <a id="aea7488fd1ff9a3f499b0d562193075ad"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aea7488fd1ff9a3f499b0d562193075ad">◆ </a></span>getPartitionResolverLibrary()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getPartitionResolverLibrary </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the path of the library from which the factory function will be invoked on a cache server. </p> |
| |
| </div> |
| </div> |
| <a id="a33335502d396e74f2e26a92c7a9bb0ba"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a33335502d396e74f2e26a92c7a9bb0ba">◆ </a></span>getPersistenceFactory()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getPersistenceFactory </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the symbol name of the factory function from which the persistence will be created on a cache server. </p> |
| |
| </div> |
| </div> |
| <a id="a3ed439d3bbd9acef0eabd75534cf37c0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3ed439d3bbd9acef0eabd75534cf37c0">◆ </a></span>getPersistenceLibrary()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getPersistenceLibrary </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the path of the library from which the factory function will be invoked on a cache server. </p> |
| |
| </div> |
| </div> |
| <a id="aa905ba715bc77f58bcca87ff68799d71"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa905ba715bc77f58bcca87ff68799d71">◆ </a></span>getPersistenceManager()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="a00783.html">PersistenceManager</a>> apache::geode::client::RegionAttributes::getPersistenceManager </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the persistence for the region. </p> |
| <dl class="section return"><dt>Returns</dt><dd>a pointer that points to the region's , <code><a class="el" href="a00783.html" title="PersistenceManager API for persistence and overflow.">PersistenceManager</a></code> , nullptr if there is no <a class="el" href="a00783.html" title="PersistenceManager API for persistence and overflow.">PersistenceManager</a> for this region. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="abe7e19a74772efb506591af3efcea690"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abe7e19a74772efb506591af3efcea690">◆ </a></span>getPersistenceProperties()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="a00799.html">Properties</a>> apache::geode::client::RegionAttributes::getPersistenceProperties </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This method returns the properties pointer which is set for persistence. </p> |
| |
| </div> |
| </div> |
| <a id="a4ef565df384a6baacc0b99d2208a23db"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4ef565df384a6baacc0b99d2208a23db">◆ </a></span>getPoolName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& apache::geode::client::RegionAttributes::getPoolName </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the name of the pool attached to the region. </p> |
| |
| </div> |
| </div> |
| <a id="a2d89a9710549507d545cb9b1559dd740"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2d89a9710549507d545cb9b1559dd740">◆ </a></span>getRegionIdleTimeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds apache::geode::client::RegionAttributes::getRegionIdleTimeout </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the idleTimeout expiration attributes for the region as a whole. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the IdleTimeout expiration attributes for this region </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a297b9a11086ae8d1d85bebc20106cb82"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a297b9a11086ae8d1d85bebc20106cb82">◆ </a></span>getRegionTimeToLive()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::chrono::seconds apache::geode::client::RegionAttributes::getRegionTimeToLive </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the <code>timeToLive</code> expiration attributes for the region as a whole. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the timeToLive expiration attributes for this region </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a970a3f610db9e5be479f2e0a1fb802d0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a970a3f610db9e5be479f2e0a1fb802d0">◆ </a></span>operator!=()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool apache::geode::client::RegionAttributes::operator!= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="a00819.html">RegionAttributes</a> & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return true if any of the attributes are not equal to those of other. </p> |
| |
| </div> |
| </div> |
| <a id="ae765606ca65aff466f84290431d137de"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae765606ca65aff466f84290431d137de">◆ </a></span>operator==()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool apache::geode::client::RegionAttributes::operator== </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="a00819.html">RegionAttributes</a> & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return true if all the attributes are equal to those of other. </p> |
| |
| </div> |
| </div> |
| <a id="a8b93a9e7900c38eecbccb484d1dd2740"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8b93a9e7900c38eecbccb484d1dd2740">◆ </a></span>validateSerializableAttributes()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void apache::geode::client::RegionAttributes::validateSerializableAttributes </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>throws <a class="el" href="a00475.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a> if the attributes are not suited for serialization such as those that have a cache callback (listener, loader, or writer) set directly instead of through the string value setters. </p> |
| |
| </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> |