| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Geode Native .NET Reference: Apache::Geode::Client::IGeodeCache Interface Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Geode Native .NET Reference |
|  <span id="projectnumber">1.13.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00958.html','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::IGeodeCache Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>GeodeCache represents the singleton cache that must be created in order to connect to <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> server. |
| <a href="a00958.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="a01018.html">Apache::Geode::Client::IRegionService</a>.</p> |
| |
| <p>Inherited by <a class="el" href="a00410.html">Apache::Geode::Client::Cache</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:ad9a44706f32c6913dab10953f1b01abd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01018.html#ad9a44706f32c6913dab10953f1b01abd">Close</a> ()</td></tr> |
| <tr class="memdesc:ad9a44706f32c6913dab10953f1b01abd"><td class="mdescLeft"> </td><td class="mdescRight">Terminates this object cache and releases all the local resources. <a href="#ad9a44706f32c6913dab10953f1b01abd">More...</a><br /></td></tr> |
| <tr class="separator:ad9a44706f32c6913dab10953f1b01abd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a616a39746be91f58e9ce1a0cdd7ee29f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00970.html">IPdxInstanceFactory</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a01018.html#a616a39746be91f58e9ce1a0cdd7ee29f">CreatePdxInstanceFactory</a> (String^ className)</td></tr> |
| <tr class="memdesc:a616a39746be91f58e9ce1a0cdd7ee29f"><td class="mdescLeft"> </td><td class="mdescRight">Returns a factory that can create a <a class="el" href="">PdxInstance</a>. <a href="#a616a39746be91f58e9ce1a0cdd7ee29f">More...</a><br /></td></tr> |
| <tr class="separator:a616a39746be91f58e9ce1a0cdd7ee29f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a221b166ccc8865c3bfc64737fe272287"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00958.html#a221b166ccc8865c3bfc64737fe272287">GetPdxIgnoreUnreadFields</a> ()</td></tr> |
| <tr class="memdesc:a221b166ccc8865c3bfc64737fe272287"><td class="mdescLeft"> </td><td class="mdescRight">summary> Returns whether <a class="el" href="">PdxInstance</a> is preferred for PDX types instead of .NET object. <a href="#a221b166ccc8865c3bfc64737fe272287">More...</a><br /></td></tr> |
| <tr class="separator:a221b166ccc8865c3bfc64737fe272287"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a979ff457a1f07638e1e95ff552f277c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01086.html">Client::QueryService</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a01018.html#a979ff457a1f07638e1e95ff552f277c2">GetQueryService</a> ()</td></tr> |
| <tr class="memdesc:a979ff457a1f07638e1e95ff552f277c2"><td class="mdescLeft"> </td><td class="mdescRight">Get a query service object to be able to query the cache. <a href="#a979ff457a1f07638e1e95ff552f277c2">More...</a><br /></td></tr> |
| <tr class="separator:a979ff457a1f07638e1e95ff552f277c2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeda793a2985ed99c8cb5531a6ff27261"><td class="memTemplParams" colspan="2">template<class TKey , class TValue > </td></tr> |
| <tr class="memitem:aeda793a2985ed99c8cb5531a6ff27261"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="a01014.html">IRegion</a>< TKey, TValue > ^ </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a01018.html#aeda793a2985ed99c8cb5531a6ff27261">GetRegion</a> (String^ name)</td></tr> |
| <tr class="memdesc:aeda793a2985ed99c8cb5531a6ff27261"><td class="mdescLeft"> </td><td class="mdescRight">Returns an existing region given the full path from root, or null if no such region exists. <a href="#aeda793a2985ed99c8cb5531a6ff27261">More...</a><br /></td></tr> |
| <tr class="separator:aeda793a2985ed99c8cb5531a6ff27261"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a87042dc41ebefcff8fc5109e52889899"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00958.html#a87042dc41ebefcff8fc5109e52889899">InitializeDeclarativeCache</a> (String^ cacheXml)</td></tr> |
| <tr class="memdesc:a87042dc41ebefcff8fc5109e52889899"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the cache from an XML file. <a href="#a87042dc41ebefcff8fc5109e52889899">More...</a><br /></td></tr> |
| <tr class="separator:a87042dc41ebefcff8fc5109e52889899"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7eb08ad66499807abb879f3b2b0ff810"><td class="memTemplParams" colspan="2">template<class TKey , class TValue > </td></tr> |
| <tr class="memitem:a7eb08ad66499807abb879f3b2b0ff810"><td class="memTemplItemLeft" align="right" valign="top">array< <a class="el" href="a01014.html">IRegion</a>< TKey, TValue >^> ^ </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a01018.html#a7eb08ad66499807abb879f3b2b0ff810">RootRegions</a> ()</td></tr> |
| <tr class="memdesc:a7eb08ad66499807abb879f3b2b0ff810"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array of root regions in the cache. <a href="#a7eb08ad66499807abb879f3b2b0ff810">More...</a><br /></td></tr> |
| <tr class="separator:a7eb08ad66499807abb879f3b2b0ff810"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a0ad1be3a787569731556f9e4685c7230"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00550.html">Apache::Geode::Client::CacheTransactionManager</a>^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00958.html#a0ad1be3a787569731556f9e4685c7230">CacheTransactionManager</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a0ad1be3a787569731556f9e4685c7230"><td class="mdescLeft"> </td><td class="mdescRight">Returns the cache transaction manager of <a class="el" href="a00538.html#a74aa12fb6f866cbd28c09aaac49924b1" title="To create the instance of Cache.">CacheFactory.Create</a> this cache. <a href="#a0ad1be3a787569731556f9e4685c7230">More...</a><br /></td></tr> |
| <tr class="separator:a0ad1be3a787569731556f9e4685c7230"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab77e7b5f380697ca2ba48eb43934ad53"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01018.html#ab77e7b5f380697ca2ba48eb43934ad53">IsClosed</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ab77e7b5f380697ca2ba48eb43934ad53"><td class="mdescLeft"> </td><td class="mdescRight">True if this cache has been closed. <a href="#ab77e7b5f380697ca2ba48eb43934ad53">More...</a><br /></td></tr> |
| <tr class="separator:ab77e7b5f380697ca2ba48eb43934ad53"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3b71218dc19bb34ae70b192c4055d226"><td class="memItemLeft" align="right" valign="top">String^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00958.html#a3b71218dc19bb34ae70b192c4055d226">Name</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a3b71218dc19bb34ae70b192c4055d226"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of this cache. <a href="#a3b71218dc19bb34ae70b192c4055d226">More...</a><br /></td></tr> |
| <tr class="separator:a3b71218dc19bb34ae70b192c4055d226"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>GeodeCache represents the singleton cache that must be created in order to connect to <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> server. </p> |
| <p>Caches are obtained from Crest methods on the <a class="el" href="a00538.html#a74aa12fb6f866cbd28c09aaac49924b1" title="To create the instance of Cache.">CacheFactory.Create</a> class. </p> |
| <p>When a cache is created a <a class="el" href="a00614.html" title="DistributedSystem encapsulates this applications "connection" into the Geode Java servers.">DistributedSystem</a> must be specified. </p> |
| <p>When a cache will no longer be used, call <a class="el" href="a00410.html#ae4914b5a4b36ff81a81a91db5225019b" title="Terminates this object cache and releases all the local resources.">Cache.Close</a>. Once it <a class="el" href="a00410.html#a5a6ca521e6e349205cf67021c3250800" title="True if this cache has been closed.">Cache.IsClosed</a> any attempt to use it will cause a <code><a class="el" href="a00666.html" title="Thrown when an operation is attempted on a closed cache.">CacheClosedException</a></code> to be thrown. </p> |
| <p>A cache can have multiple root regions, each with a different name. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ad9a44706f32c6913dab10953f1b01abd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad9a44706f32c6913dab10953f1b01abd">◆ </a></span>Close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache::Geode::Client::IRegionService::Close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inherited</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Terminates this object cache and releases all the local resources. </p> |
| <p>If RegionService is created from <a class="el" href="a00410.html#a29f58083688482e0629467fb5e8f9195" title="Returns the instance of IRegionService to do the operation on Cache with different Credential.">Cache.CreateAuthenticatedView</a>, then it clears user related security data. </p> |
| <p>After this cache is closed, any further method call on this cache or any region object will throw <code><a class="el" href="a00666.html" title="Thrown when an operation is attempted on a closed cache.">CacheClosedException</a></code>, unless otherwise noted. </p> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00666.html" title="Thrown when an operation is attempted on a closed cache.">CacheClosedException</a></td><td>if the cache is already closed. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="a00410.html#ae4914b5a4b36ff81a81a91db5225019b">Apache::Geode::Client::Cache</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a616a39746be91f58e9ce1a0cdd7ee29f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a616a39746be91f58e9ce1a0cdd7ee29f">◆ </a></span>CreatePdxInstanceFactory()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00970.html">IPdxInstanceFactory</a> ^ Apache::Geode::Client::IRegionService::CreatePdxInstanceFactory </td> |
| <td>(</td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>className</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inherited</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a factory that can create a <a class="el" href="">PdxInstance</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">className</td><td>the fully qualified class name that the PdxInstance will become when it is fully deserialized. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the factory </dd></dl> |
| |
| <p>Implemented in <a class="el" href="a00410.html#a11421ac27bf948764a89b4fa8816c4bd">Apache::Geode::Client::Cache</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a221b166ccc8865c3bfc64737fe272287"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a221b166ccc8865c3bfc64737fe272287">◆ </a></span>GetPdxIgnoreUnreadFields()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache::Geode::Client::IGeodeCache::GetPdxIgnoreUnreadFields </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>summary> Returns whether <a class="el" href="">PdxInstance</a> is preferred for PDX types instead of .NET object. </p> |
| <p>/summary> </p> |
| |
| <p>Implemented in <a class="el" href="a00410.html#a92b3bb28fb0d9710c6cad3bf5af1dca2">Apache::Geode::Client::Cache</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a979ff457a1f07638e1e95ff552f277c2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a979ff457a1f07638e1e95ff552f277c2">◆ </a></span>GetQueryService()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a01086.html">Client::QueryService</a> ^ Apache::Geode::Client::IRegionService::GetQueryService </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inherited</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get a query service object to be able to query the cache. </p> |
| <p>Currently only works against the java server in native mode, and at least some endpoints must have been defined in some regions before actually firing a query. </p> |
| |
| <p>Implemented in <a class="el" href="a00410.html#ab3be9585e2a61479917aabb8005e320c">Apache::Geode::Client::Cache</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aeda793a2985ed99c8cb5531a6ff27261"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aeda793a2985ed99c8cb5531a6ff27261">◆ </a></span>GetRegion()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a01014.html">IRegion</a><TKey, TValue> ^ Apache::Geode::Client::IRegionService::GetRegion </td> |
| <td>(</td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inherited</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns an existing region given the full path from root, or null if no such region exists. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the name of the region</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the region</dd></dl> |
| |
| <p>Implemented in <a class="el" href="a00410.html#aed71aeab49e1fba5f4f20fc8b65e85d3">Apache::Geode::Client::Cache</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a87042dc41ebefcff8fc5109e52889899"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a87042dc41ebefcff8fc5109e52889899">◆ </a></span>InitializeDeclarativeCache()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache::Geode::Client::IGeodeCache::InitializeDeclarativeCache </td> |
| <td>(</td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>cacheXml</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes the cache from an XML file. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">cacheXml</td><td>pathname of a <code>cache.xml</code> file</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="a00410.html#a6fc2198912ba5d564ec09af0ddbef8f1">Apache::Geode::Client::Cache</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a7eb08ad66499807abb879f3b2b0ff810"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7eb08ad66499807abb879f3b2b0ff810">◆ </a></span>RootRegions()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">array<<a class="el" href="a01014.html">IRegion</a><TKey, TValue>^> ^ Apache::Geode::Client::IRegionService::RootRegions </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inherited</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns an array of root regions in the cache. </p> |
| <p>This set is a snapshot and is not backed by the cache. </p> |
| <p>It is not supported when <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a> is created from <a class="el" href="a01070.html" title="A pool of connections.">Pool</a>. </p> |
| <dl class="section return"><dt>Returns</dt><dd>array of regions</dd></dl> |
| |
| <p>Implemented in <a class="el" href="a00410.html#acd25ec85a4b9b9dcb9c89738d21969af">Apache::Geode::Client::Cache</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a0ad1be3a787569731556f9e4685c7230"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0ad1be3a787569731556f9e4685c7230">◆ </a></span>CacheTransactionManager</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:: <a class="el" href="a00550.html">CacheTransactionManager</a>^ Apache::Geode::Client::IGeodeCache::CacheTransactionManager</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the cache transaction manager of <a class="el" href="a00538.html#a74aa12fb6f866cbd28c09aaac49924b1" title="To create the instance of Cache.">CacheFactory.Create</a> this cache. </p> |
| <p>summary> Returns whether <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a> saves unread fields for Pdx types. /summary> </p> |
| |
| </div> |
| </div> |
| <a id="ab77e7b5f380697ca2ba48eb43934ad53"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab77e7b5f380697ca2ba48eb43934ad53">◆ </a></span>IsClosed</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::IRegionService::IsClosed</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">inherited</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>True if this cache has been closed. </p> |
| <p>After a new cache object is created, this method returns false. After <a class="el" href="a01018.html#ad9a44706f32c6913dab10953f1b01abd" title="Terminates this object cache and releases all the local resources.">Close</a> is called on this cache object, this method returns true. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if this cache is closed, otherwise false</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a3b71218dc19bb34ae70b192c4055d226"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3b71218dc19bb34ae70b192c4055d226">◆ </a></span>Name</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String^ Apache::Geode::Client::IGeodeCache::Name</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the name of this cache. </p> |
| <p>This method does not throw <code><a class="el" href="a00666.html" title="Thrown when an operation is attempted on a closed cache.">CacheClosedException</a></code> if the cache is closed. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the string name of this cache</dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <HR><address style="align: right;"><small>Apache Geode C++ Cache .NET API Documentation</small></address> |