Google Git
Sign in
apache / geode-site / caddaef03c4320a2dfa150b53db94c7a971ecf4e / . / releases / latest / dotnetdocs / a00410.html
blob: 2942d87ce9396af0b5ba659de60d1b973b9060a9 [file] [log] [blame]
<!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::Cache 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&amp;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
&#160;<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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a00410.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> &#124;
<a href="#properties">Properties</a> </div>
<div class="headertitle">
<div class="title">Apache::Geode::Client::Cache Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides a distributed cache.
<a href="a00410.html#details">More...</a></p>
<p>Inherits <a class="el" href="a00958.html">Apache::Geode::Client::IGeodeCache</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:ae4914b5a4b36ff81a81a91db5225019b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#ae4914b5a4b36ff81a81a91db5225019b">Close</a> ()</td></tr>
<tr class="memdesc:ae4914b5a4b36ff81a81a91db5225019b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates this object cache and releases all the local resources. <a href="#ae4914b5a4b36ff81a81a91db5225019b">More...</a><br /></td></tr>
<tr class="separator:ae4914b5a4b36ff81a81a91db5225019b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a605b0fd17400728a2e7f36ef48168acb"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#a605b0fd17400728a2e7f36ef48168acb">Close</a> (bool keepalive)</td></tr>
<tr class="memdesc:a605b0fd17400728a2e7f36ef48168acb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates this object cache and releases all the local resources. <a href="#a605b0fd17400728a2e7f36ef48168acb">More...</a><br /></td></tr>
<tr class="separator:a605b0fd17400728a2e7f36ef48168acb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29f58083688482e0629467fb5e8f9195"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01018.html">IRegionService</a> ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#a29f58083688482e0629467fb5e8f9195">CreateAuthenticatedView</a> (<a class="el" href="a00406.html">Properties</a>&lt; String^, Object^&gt;^ credentials)</td></tr>
<tr class="memdesc:a29f58083688482e0629467fb5e8f9195"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the instance of <a class="el" href="a01018.html" title="A RegionService provides access to existing regions that exist in a Cache.">IRegionService</a> to do the operation on <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a> with different Credential. <a href="#a29f58083688482e0629467fb5e8f9195">More...</a><br /></td></tr>
<tr class="separator:a29f58083688482e0629467fb5e8f9195"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac677ea23a4f7c15be3495df501271855"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01018.html">IRegionService</a> ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#ac677ea23a4f7c15be3495df501271855">CreateAuthenticatedView</a> (<a class="el" href="a00406.html">Properties</a>&lt; String^, Object^&gt;^ credentials, String^ poolName)</td></tr>
<tr class="memdesc:ac677ea23a4f7c15be3495df501271855"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the instance of <a class="el" href="a01018.html" title="A RegionService provides access to existing regions that exist in a Cache.">IRegionService</a> to do the operation on <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a> with different Credential. <a href="#ac677ea23a4f7c15be3495df501271855">More...</a><br /></td></tr>
<tr class="separator:ac677ea23a4f7c15be3495df501271855"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11421ac27bf948764a89b4fa8816c4bd"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00970.html">IPdxInstanceFactory</a> ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#a11421ac27bf948764a89b4fa8816c4bd">CreatePdxInstanceFactory</a> (String^ className)</td></tr>
<tr class="memdesc:a11421ac27bf948764a89b4fa8816c4bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a factory that can create a <a class="el" href="">PdxInstance</a>. <a href="#a11421ac27bf948764a89b4fa8816c4bd">More...</a><br /></td></tr>
<tr class="separator:a11421ac27bf948764a89b4fa8816c4bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9bd64c225ff5addafdf164bbd060c10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01106.html">RegionFactory</a> ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#ab9bd64c225ff5addafdf164bbd060c10">CreateRegionFactory</a> (<a class="el" href="a00382.html#ab01341be2e091f1bbf219274838ee34c">RegionShortcut</a> regionShortcut)</td></tr>
<tr class="memdesc:ab9bd64c225ff5addafdf164bbd060c10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the instance of <a class="el" href="a01106.html">RegionFactory</a> to create the region <a href="#ab9bd64c225ff5addafdf164bbd060c10">More...</a><br /></td></tr>
<tr class="separator:ab9bd64c225ff5addafdf164bbd060c10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92b3bb28fb0d9710c6cad3bf5af1dca2"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#a92b3bb28fb0d9710c6cad3bf5af1dca2">GetPdxIgnoreUnreadFields</a> ()</td></tr>
<tr class="memdesc:a92b3bb28fb0d9710c6cad3bf5af1dca2"><td class="mdescLeft">&#160;</td><td class="mdescRight">summary&gt; Returns whether <a class="el" href="">PdxInstance</a> is preferred for PDX types instead of .NET object. <a href="#a92b3bb28fb0d9710c6cad3bf5af1dca2">More...</a><br /></td></tr>
<tr class="separator:a92b3bb28fb0d9710c6cad3bf5af1dca2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3be9585e2a61479917aabb8005e320c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a01086.html">Client::QueryService</a> ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#ab3be9585e2a61479917aabb8005e320c">GetQueryService</a> ()</td></tr>
<tr class="memdesc:ab3be9585e2a61479917aabb8005e320c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a query service object to be able to query the cache. <a href="#ab3be9585e2a61479917aabb8005e320c">More...</a><br /></td></tr>
<tr class="separator:ab3be9585e2a61479917aabb8005e320c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c0875168a3c3180dea49ec82e196ee7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a01086.html">Client::QueryService</a> ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#a7c0875168a3c3180dea49ec82e196ee7">GetQueryService</a> (String^ poolName)</td></tr>
<tr class="memdesc:a7c0875168a3c3180dea49ec82e196ee7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a query service object to be able to query the cache. <a href="#a7c0875168a3c3180dea49ec82e196ee7">More...</a><br /></td></tr>
<tr class="separator:a7c0875168a3c3180dea49ec82e196ee7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed71aeab49e1fba5f4f20fc8b65e85d3"><td class="memTemplParams" colspan="2">template&lt;class TKey , class TValue &gt; </td></tr>
<tr class="memitem:aed71aeab49e1fba5f4f20fc8b65e85d3"><td class="memTemplItemLeft" align="right" valign="top">virtual <a class="el" href="a01014.html">IRegion</a>&lt; TKey, TValue &gt; ^&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00410.html#aed71aeab49e1fba5f4f20fc8b65e85d3">GetRegion</a> (String^ path)</td></tr>
<tr class="memdesc:aed71aeab49e1fba5f4f20fc8b65e85d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an existing region given the full path from root, or null if no such region exists. <a href="#aed71aeab49e1fba5f4f20fc8b65e85d3">More...</a><br /></td></tr>
<tr class="separator:aed71aeab49e1fba5f4f20fc8b65e85d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fc2198912ba5d564ec09af0ddbef8f1"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#a6fc2198912ba5d564ec09af0ddbef8f1">InitializeDeclarativeCache</a> (String^ cacheXml)</td></tr>
<tr class="memdesc:a6fc2198912ba5d564ec09af0ddbef8f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the cache from an XML file. <a href="#a6fc2198912ba5d564ec09af0ddbef8f1">More...</a><br /></td></tr>
<tr class="separator:a6fc2198912ba5d564ec09af0ddbef8f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99f4b2f798431a0de0e7032657fc602e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#a99f4b2f798431a0de0e7032657fc602e">ReadyForEvents</a> ()</td></tr>
<tr class="memdesc:a99f4b2f798431a0de0e7032657fc602e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send the client-ready message to the server for a durable client. <a href="#a99f4b2f798431a0de0e7032657fc602e">More...</a><br /></td></tr>
<tr class="separator:a99f4b2f798431a0de0e7032657fc602e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd25ec85a4b9b9dcb9c89738d21969af"><td class="memTemplParams" colspan="2">template&lt;class TKey , class TValue &gt; </td></tr>
<tr class="memitem:acd25ec85a4b9b9dcb9c89738d21969af"><td class="memTemplItemLeft" align="right" valign="top">virtual array&lt; <a class="el" href="a01014.html">IRegion</a>&lt; TKey, TValue &gt;^&gt; ^&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00410.html#acd25ec85a4b9b9dcb9c89738d21969af">RootRegions</a> ()</td></tr>
<tr class="memdesc:acd25ec85a4b9b9dcb9c89738d21969af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an array of root regions in the cache. <a href="#acd25ec85a4b9b9dcb9c89738d21969af">More...</a><br /></td></tr>
<tr class="separator:acd25ec85a4b9b9dcb9c89738d21969af"><td class="memSeparator" colspan="2">&#160;</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:a525b4b61efdac97b5a3a2220933c4e08"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00550.html">Apache::Geode::Client::CacheTransactionManager</a>^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#a525b4b61efdac97b5a3a2220933c4e08">CacheTransactionManager</a><code> [get]</code></td></tr>
<tr class="memdesc:a525b4b61efdac97b5a3a2220933c4e08"><td class="mdescLeft">&#160;</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="#a525b4b61efdac97b5a3a2220933c4e08">More...</a><br /></td></tr>
<tr class="separator:a525b4b61efdac97b5a3a2220933c4e08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a6ca521e6e349205cf67021c3250800"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#a5a6ca521e6e349205cf67021c3250800">IsClosed</a><code> [get]</code></td></tr>
<tr class="memdesc:a5a6ca521e6e349205cf67021c3250800"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if this cache has been closed. <a href="#a5a6ca521e6e349205cf67021c3250800">More...</a><br /></td></tr>
<tr class="separator:a5a6ca521e6e349205cf67021c3250800"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2af4aa4f89f5590d36689f88f156cec9"><td class="memItemLeft" align="right" valign="top">virtual String^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00410.html#a2af4aa4f89f5590d36689f88f156cec9">Name</a><code> [get]</code></td></tr>
<tr class="memdesc:a2af4aa4f89f5590d36689f88f156cec9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the name of this cache. <a href="#a2af4aa4f89f5590d36689f88f156cec9">More...</a><br /></td></tr>
<tr class="separator:a2af4aa4f89f5590d36689f88f156cec9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides a distributed cache. </p>
<p>Caches are obtained from Create 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 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="ae4914b5a4b36ff81a81a91db5225019b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4914b5a4b36ff81a81a91db5225019b">&#9670;&nbsp;</a></span>Close() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Apache::Geode::Client::Cache::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Terminates this object cache and releases all the local resources. </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>Implements <a class="el" href="a01018.html#ad9a44706f32c6913dab10953f1b01abd">Apache::Geode::Client::IRegionService</a>.</p>
</div>
</div>
<a id="a605b0fd17400728a2e7f36ef48168acb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a605b0fd17400728a2e7f36ef48168acb">&#9670;&nbsp;</a></span>Close() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Apache::Geode::Client::Cache::Close </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>keepalive</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Terminates this object cache and releases all the local resources. </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="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keepalive</td><td>whether to keep a durable client's queue alive</td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a id="a29f58083688482e0629467fb5e8f9195"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29f58083688482e0629467fb5e8f9195">&#9670;&nbsp;</a></span>CreateAuthenticatedView() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01018.html">IRegionService</a> ^ Apache::Geode::Client::Cache::CreateAuthenticatedView </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00406.html">Properties</a>&lt; String^, Object^&gt;^&#160;</td>
<td class="paramname"><em>credentials</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the instance of <a class="el" href="a01018.html" title="A RegionService provides access to existing regions that exist in a Cache.">IRegionService</a> to do the operation on <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a> with different Credential. </p>
<p>Default pool should be in multiuser mode CacheFactory.SetMultiuserAuthentication </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">credentials</td><td>the user Credentials.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Instance of <a class="el" href="a01018.html" title="A RegionService provides access to existing regions that exist in a Cache.">IRegionService</a></dd></dl>
</div>
</div>
<a id="ac677ea23a4f7c15be3495df501271855"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac677ea23a4f7c15be3495df501271855">&#9670;&nbsp;</a></span>CreateAuthenticatedView() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01018.html">IRegionService</a> ^ Apache::Geode::Client::Cache::CreateAuthenticatedView </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00406.html">Properties</a>&lt; String^, Object^&gt;^&#160;</td>
<td class="paramname"><em>credentials</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String^&#160;</td>
<td class="paramname"><em>poolName</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the instance of <a class="el" href="a01018.html" title="A RegionService provides access to existing regions that exist in a Cache.">IRegionService</a> to do the operation on <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a> with different Credential. </p>
<p>Default pool should be in multiuser mode CacheFactory.SetMultiuserAuthentication </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">credentials</td><td>the user Credentials.</td></tr>
<tr><td class="paramname">poolName</td><td><a class="el" href="a01070.html" title="A pool of connections.">Pool</a>, which is in multiuser mode.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Instance of <a class="el" href="a01018.html" title="A RegionService provides access to existing regions that exist in a Cache.">IRegionService</a></dd></dl>
<p>summary&gt; Returns whether <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a> saves unread fields for Pdx types. /summary&gt; </p>
</div>
</div>
<a id="a11421ac27bf948764a89b4fa8816c4bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11421ac27bf948764a89b4fa8816c4bd">&#9670;&nbsp;</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">virtual <a class="el" href="a00970.html">IPdxInstanceFactory</a> ^ Apache::Geode::Client::Cache::CreatePdxInstanceFactory </td>
<td>(</td>
<td class="paramtype">String^&#160;</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">virtual</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>Implements <a class="el" href="a01018.html#a616a39746be91f58e9ce1a0cdd7ee29f">Apache::Geode::Client::IRegionService</a>.</p>
</div>
</div>
<a id="ab9bd64c225ff5addafdf164bbd060c10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9bd64c225ff5addafdf164bbd060c10">&#9670;&nbsp;</a></span>CreateRegionFactory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01106.html">RegionFactory</a> ^ Apache::Geode::Client::Cache::CreateRegionFactory </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00382.html#ab01341be2e091f1bbf219274838ee34c">RegionShortcut</a>&#160;</td>
<td class="paramname"><em>regionShortcut</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the instance of <a class="el" href="a01106.html">RegionFactory</a> to create the region </p>
<p>Pass the <a class="el" href="a00382.html#ab01341be2e091f1bbf219274838ee34c" title="Each enum represents a predefined RegionAttributes in a Cache.">RegionShortcut</a> to set the default region attributes </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">regionShortcut</td><td>the regionShortcut to set the default region attributes</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Instance of <a class="el" href="a01106.html">RegionFactory</a></dd></dl>
</div>
</div>
<a id="a92b3bb28fb0d9710c6cad3bf5af1dca2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92b3bb28fb0d9710c6cad3bf5af1dca2">&#9670;&nbsp;</a></span>GetPdxIgnoreUnreadFields()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Apache::Geode::Client::Cache::GetPdxIgnoreUnreadFields </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>summary&gt; Returns whether <a class="el" href="">PdxInstance</a> is preferred for PDX types instead of .NET object. </p>
<p>/summary&gt; </p>
<p>Implements <a class="el" href="a00958.html#a221b166ccc8865c3bfc64737fe272287">Apache::Geode::Client::IGeodeCache</a>.</p>
</div>
</div>
<a id="ab3be9585e2a61479917aabb8005e320c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3be9585e2a61479917aabb8005e320c">&#9670;&nbsp;</a></span>GetQueryService() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a01086.html">Client::QueryService</a> ^ Apache::Geode::Client::Cache::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a query service object to be able to query the cache. </p>
<p>Supported only when cache is created from Pool(pool is in multiuserSecure mode) </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>Implements <a class="el" href="a01018.html#a979ff457a1f07638e1e95ff552f277c2">Apache::Geode::Client::IRegionService</a>.</p>
</div>
</div>
<a id="a7c0875168a3c3180dea49ec82e196ee7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c0875168a3c3180dea49ec82e196ee7">&#9670;&nbsp;</a></span>GetQueryService() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a01086.html">Client::QueryService</a> ^ Apache::Geode::Client::Cache::GetQueryService </td>
<td>(</td>
<td class="paramtype">String^&#160;</td>
<td class="paramname"><em>poolName</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a query service object to be able to query the cache. </p>
<p>Use only when <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a> has more than one <a class="el" href="a01070.html" title="A pool of connections.">Pool</a>. </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>
</div>
</div>
<a id="aed71aeab49e1fba5f4f20fc8b65e85d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed71aeab49e1fba5f4f20fc8b65e85d3">&#9670;&nbsp;</a></span>GetRegion()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TValue &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a01014.html">IRegion</a>&lt;TKey, TValue&gt; ^ Apache::Geode::Client::Cache::GetRegion </td>
<td>(</td>
<td class="paramtype">String^&#160;</td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</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>
<p>If <a class="el" href="a01070.html" title="A pool of connections.">Pool</a> attached with Region is in multiusersecure mode then don't use return instance of region as no credential are attached with this instance. Get region from RegionService instance of <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a>.Cache.CreateAuthenticatedView(std::shared_ptr&lt;PropertiesPtr&gt;). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>the pathname of the region</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the region</dd></dl>
<p>Implements <a class="el" href="a01018.html#aeda793a2985ed99c8cb5531a6ff27261">Apache::Geode::Client::IRegionService</a>.</p>
</div>
</div>
<a id="a6fc2198912ba5d564ec09af0ddbef8f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fc2198912ba5d564ec09af0ddbef8f1">&#9670;&nbsp;</a></span>InitializeDeclarativeCache()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Apache::Geode::Client::Cache::InitializeDeclarativeCache </td>
<td>(</td>
<td class="paramtype">String^&#160;</td>
<td class="paramname"><em>cacheXml</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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>Implements <a class="el" href="a00958.html#a87042dc41ebefcff8fc5109e52889899">Apache::Geode::Client::IGeodeCache</a>.</p>
</div>
</div>
<a id="a99f4b2f798431a0de0e7032657fc602e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99f4b2f798431a0de0e7032657fc602e">&#9670;&nbsp;</a></span>ReadyForEvents()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Apache::Geode::Client::Cache::ReadyForEvents </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Send the client-ready message to the server for a durable client. </p>
<p>This method should only be called for durable clients and with a cache server version 5.5 onwards. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00638.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>if there was a problem sending the message to the server. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acd25ec85a4b9b9dcb9c89738d21969af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd25ec85a4b9b9dcb9c89738d21969af">&#9670;&nbsp;</a></span>RootRegions()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TValue &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual array&lt;<a class="el" href="a01014.html">IRegion</a>&lt;TKey, TValue&gt;^&gt; ^ Apache::Geode::Client::Cache::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">virtual</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>Implements <a class="el" href="a01018.html#a7eb08ad66499807abb879f3b2b0ff810">Apache::Geode::Client::IRegionService</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a525b4b61efdac97b5a3a2220933c4e08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a525b4b61efdac97b5a3a2220933c4e08">&#9670;&nbsp;</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">virtual Apache:: Geode:: Client:: <a class="el" href="a00550.html">CacheTransactionManager</a>^ Apache::Geode::Client::Cache::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>
</div>
</div>
<a id="a5a6ca521e6e349205cf67021c3250800"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a6ca521e6e349205cf67021c3250800">&#9670;&nbsp;</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">virtual bool Apache::Geode::Client::Cache::IsClosed</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>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="a00410.html#ae4914b5a4b36ff81a81a91db5225019b" 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="a2af4aa4f89f5590d36689f88f156cec9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2af4aa4f89f5590d36689f88f156cec9">&#9670;&nbsp;</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">virtual String^ Apache::Geode::Client::Cache::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>