Google Git
Sign in
apache / geode-site / caddaef03c4320a2dfa150b53db94c7a971ecf4e / . / releases / latest / dotnetdocs / a01026.html
blob: 9e871a6d2c02fcae444f4859f55a7dd872b80074 [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::ISubscriptionService&lt; TKey &gt; Interface Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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('a01026.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Apache::Geode::Client::ISubscriptionService&lt; TKey &gt; Interface Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This generic interface class provides all Register Interest API's for geode's generic non local region (Region&lt;TKey, TValue&gt;).
<a href="a01026.html#details">More...</a></p>
<p>Inherited by Apache::Geode::Client::Region&lt; TKey, TValue &gt;.</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:ae46d6a87d2d570d08e21352e7b5e9557"><td class="memItemLeft" align="right" valign="top">System::Collections::Generic::ICollection&lt; TKey &gt; ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#ae46d6a87d2d570d08e21352e7b5e9557">GetInterestList</a> ()</td></tr>
<tr class="memdesc:ae46d6a87d2d570d08e21352e7b5e9557"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the interest list on this client <a href="#ae46d6a87d2d570d08e21352e7b5e9557">More...</a><br /></td></tr>
<tr class="separator:ae46d6a87d2d570d08e21352e7b5e9557"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa4e0d1e1c92405360cdb8bbcd933ece"><td class="memItemLeft" align="right" valign="top">System::Collections::Generic::ICollection&lt; String^&gt; ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#aaa4e0d1e1c92405360cdb8bbcd933ece">GetInterestListRegex</a> ()</td></tr>
<tr class="memdesc:aaa4e0d1e1c92405360cdb8bbcd933ece"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the list of interest regular expressions on this client <a href="#aaa4e0d1e1c92405360cdb8bbcd933ece">More...</a><br /></td></tr>
<tr class="separator:aaa4e0d1e1c92405360cdb8bbcd933ece"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8af8db37a2d00e73fe8742b8de45d7c6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#a8af8db37a2d00e73fe8742b8de45d7c6">RegisterAllKeys</a> ()</td></tr>
<tr class="memdesc:a8af8db37a2d00e73fe8742b8de45d7c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register interest for all the keys of the region to get updates from the server. <a href="#a8af8db37a2d00e73fe8742b8de45d7c6">More...</a><br /></td></tr>
<tr class="separator:a8af8db37a2d00e73fe8742b8de45d7c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64200ede83a05521ee8c373db841ac0f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#a64200ede83a05521ee8c373db841ac0f">RegisterAllKeys</a> (bool isDurable)</td></tr>
<tr class="memdesc:a64200ede83a05521ee8c373db841ac0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register interest for all the keys of the region to get updates from the server. <a href="#a64200ede83a05521ee8c373db841ac0f">More...</a><br /></td></tr>
<tr class="separator:a64200ede83a05521ee8c373db841ac0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a302353dc56f653e97bac42cfeb1fbfab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#a302353dc56f653e97bac42cfeb1fbfab">RegisterAllKeys</a> (bool isDurable, bool getInitialValues)</td></tr>
<tr class="memdesc:a302353dc56f653e97bac42cfeb1fbfab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register interest for all the keys of the region to get updates from the server. <a href="#a302353dc56f653e97bac42cfeb1fbfab">More...</a><br /></td></tr>
<tr class="separator:a302353dc56f653e97bac42cfeb1fbfab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a719b2e37f7945a1eaca464ecfd51d391"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#a719b2e37f7945a1eaca464ecfd51d391">RegisterAllKeys</a> (bool isDurable, bool getInitialValues, bool receiveValues)</td></tr>
<tr class="memdesc:a719b2e37f7945a1eaca464ecfd51d391"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register interest for all the keys of the region to get updates from the server. <a href="#a719b2e37f7945a1eaca464ecfd51d391">More...</a><br /></td></tr>
<tr class="separator:a719b2e37f7945a1eaca464ecfd51d391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a61496ad913504d556350e1b82489c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#a7a61496ad913504d556350e1b82489c5">RegisterKeys</a> (System::Collections::Generic::ICollection&lt; TKey &gt;^ keys)</td></tr>
<tr class="memdesc:a7a61496ad913504d556350e1b82489c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a collection of keys for getting updates from the server. <a href="#a7a61496ad913504d556350e1b82489c5">More...</a><br /></td></tr>
<tr class="separator:a7a61496ad913504d556350e1b82489c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a521c87566ba94dae85fb0228242d2e38"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#a521c87566ba94dae85fb0228242d2e38">RegisterKeys</a> (System::Collections::Generic::ICollection&lt; TKey &gt;^ keys, bool isDurable, bool getInitialValues)</td></tr>
<tr class="memdesc:a521c87566ba94dae85fb0228242d2e38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a collection of keys for getting updates from the server. <a href="#a521c87566ba94dae85fb0228242d2e38">More...</a><br /></td></tr>
<tr class="separator:a521c87566ba94dae85fb0228242d2e38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe66b4fde98983b31eac8920dfe92b96"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#afe66b4fde98983b31eac8920dfe92b96">RegisterKeys</a> (System::Collections::Generic::ICollection&lt; TKey &gt;^ keys, bool isDurable, bool getInitialValues, bool receiveValues)</td></tr>
<tr class="memdesc:afe66b4fde98983b31eac8920dfe92b96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a collection of keys for getting updates from the server. <a href="#afe66b4fde98983b31eac8920dfe92b96">More...</a><br /></td></tr>
<tr class="separator:afe66b4fde98983b31eac8920dfe92b96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa68aea6e8792797a8ef1d82e81ed56c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#aa68aea6e8792797a8ef1d82e81ed56c4">RegisterRegex</a> (String^ regex)</td></tr>
<tr class="memdesc:aa68aea6e8792797a8ef1d82e81ed56c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register interest for the keys of the region that match the given regular expression to get updates from the server. <a href="#aa68aea6e8792797a8ef1d82e81ed56c4">More...</a><br /></td></tr>
<tr class="separator:aa68aea6e8792797a8ef1d82e81ed56c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80ab41e70f8be26665a9eea124eb114d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#a80ab41e70f8be26665a9eea124eb114d">RegisterRegex</a> (String^ regex, bool isDurable)</td></tr>
<tr class="memdesc:a80ab41e70f8be26665a9eea124eb114d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register interest for the keys of the region that match the given regular expression to get updates from the server. <a href="#a80ab41e70f8be26665a9eea124eb114d">More...</a><br /></td></tr>
<tr class="separator:a80ab41e70f8be26665a9eea124eb114d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3de985a456c14c4060e856e804f02c96"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#a3de985a456c14c4060e856e804f02c96">RegisterRegex</a> (String^ regex, bool isDurable, bool getInitialValues)</td></tr>
<tr class="memdesc:a3de985a456c14c4060e856e804f02c96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register interest for the keys of the region that match the given regular expression to get updates from the server. <a href="#a3de985a456c14c4060e856e804f02c96">More...</a><br /></td></tr>
<tr class="separator:a3de985a456c14c4060e856e804f02c96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb2340c19b7c5336bdff0168ad9c69fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#aeb2340c19b7c5336bdff0168ad9c69fc">RegisterRegex</a> (String^ regex, bool isDurable, bool getInitialValues, bool receiveValues)</td></tr>
<tr class="memdesc:aeb2340c19b7c5336bdff0168ad9c69fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register interest for the keys of the region that match the given regular expression to get updates from the server. <a href="#aeb2340c19b7c5336bdff0168ad9c69fc">More...</a><br /></td></tr>
<tr class="separator:aeb2340c19b7c5336bdff0168ad9c69fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a832d71417a9e2d934c247b26c39d53ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#a832d71417a9e2d934c247b26c39d53ed">UnregisterAllKeys</a> ()</td></tr>
<tr class="memdesc:a832d71417a9e2d934c247b26c39d53ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister interest for all the keys of the region to stop getting updates for them. <a href="#a832d71417a9e2d934c247b26c39d53ed">More...</a><br /></td></tr>
<tr class="separator:a832d71417a9e2d934c247b26c39d53ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a678613894d0e956f19af10d013e058f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#a678613894d0e956f19af10d013e058f4">UnregisterKeys</a> (System::Collections::Generic::ICollection&lt; TKey &gt;^ keys)</td></tr>
<tr class="memdesc:a678613894d0e956f19af10d013e058f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters a collection of keys to stop getting updates for them. <a href="#a678613894d0e956f19af10d013e058f4">More...</a><br /></td></tr>
<tr class="separator:a678613894d0e956f19af10d013e058f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad76e9688f748b8f35b10edf2e0bd1557"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01026.html#ad76e9688f748b8f35b10edf2e0bd1557">UnregisterRegex</a> (String^ regex)</td></tr>
<tr class="memdesc:ad76e9688f748b8f35b10edf2e0bd1557"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister interest for the keys of the region that match the given regular expression to stop getting updates for them. <a href="#ad76e9688f748b8f35b10edf2e0bd1557">More...</a><br /></td></tr>
<tr class="separator:ad76e9688f748b8f35b10edf2e0bd1557"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class TKey&gt;<br />
interface Apache::Geode::Client::ISubscriptionService&lt; TKey &gt;</h3>
<p>This generic interface class provides all Register Interest API's for geode's generic non local region (Region&lt;TKey, TValue&gt;). </p>
<p>Region&lt;TKey, TValue&gt; class implements all methods of this interface class. LocalRegion&lt;TKey, TValue&gt; class does not implement this interface class. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae46d6a87d2d570d08e21352e7b5e9557"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae46d6a87d2d570d08e21352e7b5e9557">&#9670;&nbsp;</a></span>GetInterestList()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">System::Collections::Generic::ICollection&lt;TKey&gt; ^ <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::GetInterestList </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get the interest list on this client </p>
</div>
</div>
<a id="aaa4e0d1e1c92405360cdb8bbcd933ece"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa4e0d1e1c92405360cdb8bbcd933ece">&#9670;&nbsp;</a></span>GetInterestListRegex()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">System::Collections::Generic::ICollection&lt;String^&gt; ^ <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::GetInterestListRegex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get the list of interest regular expressions on this client </p>
</div>
</div>
<a id="a8af8db37a2d00e73fe8742b8de45d7c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8af8db37a2d00e73fe8742b8de45d7c6">&#9670;&nbsp;</a></span>RegisterAllKeys() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::RegisterAllKeys </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register interest for all the keys of the region to get updates from the server. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of <a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a> is set to <a class="el" href="a00822.html" title="Thrown when a client is unable to contact any locators.">NoAvailableLocatorsException</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a64200ede83a05521ee8c373db841ac0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64200ede83a05521ee8c373db841ac0f">&#9670;&nbsp;</a></span>RegisterAllKeys() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::RegisterAllKeys </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isDurable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register interest for all the keys of the region to get updates from the server. </p>
<p>Should only be called for durable clients and with cache server version 5.5 onwards. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">isDurable</td><td>whether the registration should be durable</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of <a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a> is set to <a class="el" href="a00822.html" title="Thrown when a client is unable to contact any locators.">NoAvailableLocatorsException</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a302353dc56f653e97bac42cfeb1fbfab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a302353dc56f653e97bac42cfeb1fbfab">&#9670;&nbsp;</a></span>RegisterAllKeys() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::RegisterAllKeys </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isDurable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>getInitialValues</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register interest for all the keys of the region to get updates from the server. </p>
<p>Should only be called for durable clients and with cache server version 5.5 onwards. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">isDurable</td><td>whether the registration should be durable</td></tr>
<tr><td class="paramname">getInitialValues</td><td>true to populate the cache with values of all the keys from the server </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of <a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a> is set to <a class="el" href="a00822.html" title="Thrown when a client is unable to contact any locators.">NoAvailableLocatorsException</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a719b2e37f7945a1eaca464ecfd51d391"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a719b2e37f7945a1eaca464ecfd51d391">&#9670;&nbsp;</a></span>RegisterAllKeys() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::RegisterAllKeys </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isDurable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>getInitialValues</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>receiveValues</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register interest for all the keys of the region to get updates from the server. </p>
<p>Should only be called for durable clients and with cache server version 5.5 onwards. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">isDurable</td><td>whether the registration should be durable</td></tr>
<tr><td class="paramname">getInitialValues</td><td>true to populate the cache with values of all the keys from the server </td></tr>
<tr><td class="paramname">receiveValues</td><td>whether to act like notify-by-subscription is true </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7a61496ad913504d556350e1b82489c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a61496ad913504d556350e1b82489c5">&#9670;&nbsp;</a></span>RegisterKeys() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::RegisterKeys </td>
<td>(</td>
<td class="paramtype">System::Collections::Generic::ICollection&lt; TKey &gt;^&#160;</td>
<td class="paramname"><em>keys</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a collection of keys for getting updates from the server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keys</td><td>a collection of keys</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>If the collection of keys is empty. </td></tr>
<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 already registered interest for all keys. </td></tr>
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of <a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a> is set to <a class="el" href="a00822.html" title="Thrown when a client is unable to contact any locators.">NoAvailableLocatorsException</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a521c87566ba94dae85fb0228242d2e38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a521c87566ba94dae85fb0228242d2e38">&#9670;&nbsp;</a></span>RegisterKeys() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::RegisterKeys </td>
<td>(</td>
<td class="paramtype">System::Collections::Generic::ICollection&lt; TKey &gt;^&#160;</td>
<td class="paramname"><em>keys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isDurable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>getInitialValues</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a collection of keys for getting updates from the server. </p>
<p>Should only be called for durable clients and with cache server version 5.5 onwards. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keys</td><td>a collection of keys</td></tr>
<tr><td class="paramname">isDurable</td><td>whether the registration should be durable</td></tr>
<tr><td class="paramname">getInitialValues</td><td>true to populate the cache with values of the keys that were registered on the server </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>If the collection of keys is empty. </td></tr>
<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 already registered interest for all keys. </td></tr>
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of <a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a> is set to <a class="el" href="a00822.html" title="Thrown when a client is unable to contact any locators.">NoAvailableLocatorsException</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afe66b4fde98983b31eac8920dfe92b96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe66b4fde98983b31eac8920dfe92b96">&#9670;&nbsp;</a></span>RegisterKeys() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::RegisterKeys </td>
<td>(</td>
<td class="paramtype">System::Collections::Generic::ICollection&lt; TKey &gt;^&#160;</td>
<td class="paramname"><em>keys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isDurable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>getInitialValues</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>receiveValues</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a collection of keys for getting updates from the server. </p>
<p>Should only be called for durable clients and with cache server version 5.5 onwards. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keys</td><td>a collection of keys</td></tr>
<tr><td class="paramname">isDurable</td><td>whether the registration should be durable</td></tr>
<tr><td class="paramname">getInitialValues</td><td>true to populate the cache with values of the keys that were registered on the server </td></tr>
<tr><td class="paramname">receiveValues</td><td>whether to act like notify-by-subscription is true </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>If the collection of keys is empty. </td></tr>
<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 already registered interest for all keys. </td></tr>
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa68aea6e8792797a8ef1d82e81ed56c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa68aea6e8792797a8ef1d82e81ed56c4">&#9670;&nbsp;</a></span>RegisterRegex() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::RegisterRegex </td>
<td>(</td>
<td class="paramtype">String^&#160;</td>
<td class="paramname"><em>regex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register interest for the keys of the region that match the given regular expression to get updates from the server. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>If the regular expression string is empty. </td></tr>
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of <a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a> is set to <a class="el" href="a00822.html" title="Thrown when a client is unable to contact any locators.">NoAvailableLocatorsException</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00802.html" title="Thrown when an unknown message is received from the server.">MessageException</a></td><td>If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a80ab41e70f8be26665a9eea124eb114d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80ab41e70f8be26665a9eea124eb114d">&#9670;&nbsp;</a></span>RegisterRegex() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::RegisterRegex </td>
<td>(</td>
<td class="paramtype">String^&#160;</td>
<td class="paramname"><em>regex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isDurable</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register interest for the keys of the region that match the given regular expression to get updates from the server. </p>
<p>Should only be called for durable clients and with cache server version 5.5 onwards. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">regex</td><td>the regular expression to register</td></tr>
<tr><td class="paramname">isDurable</td><td>whether the registration should be durable</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>If the regular expression string is empty. </td></tr>
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of <a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a> is set to <a class="el" href="a00822.html" title="Thrown when a client is unable to contact any locators.">NoAvailableLocatorsException</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00802.html" title="Thrown when an unknown message is received from the server.">MessageException</a></td><td>If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3de985a456c14c4060e856e804f02c96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3de985a456c14c4060e856e804f02c96">&#9670;&nbsp;</a></span>RegisterRegex() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::RegisterRegex </td>
<td>(</td>
<td class="paramtype">String^&#160;</td>
<td class="paramname"><em>regex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isDurable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>getInitialValues</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register interest for the keys of the region that match the given regular expression to get updates from the server. </p>
<p>Should only be called for durable clients and with cache server version 5.5 onwards. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">regex</td><td>the regular expression to register</td></tr>
<tr><td class="paramname">isDurable</td><td>whether the registration should be durable</td></tr>
<tr><td class="paramname">getInitialValues</td><td>true to populate the cache with values of the keys that were registered on the server </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>If the regular expression string is empty. </td></tr>
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of <a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a> is set to <a class="el" href="a00822.html" title="Thrown when a client is unable to contact any locators.">NoAvailableLocatorsException</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00802.html" title="Thrown when an unknown message is received from the server.">MessageException</a></td><td>If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aeb2340c19b7c5336bdff0168ad9c69fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb2340c19b7c5336bdff0168ad9c69fc">&#9670;&nbsp;</a></span>RegisterRegex() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::RegisterRegex </td>
<td>(</td>
<td class="paramtype">String^&#160;</td>
<td class="paramname"><em>regex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isDurable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>getInitialValues</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>receiveValues</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register interest for the keys of the region that match the given regular expression to get updates from the server. </p>
<p>Should only be called for durable clients and with cache server version 5.5 onwards. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">regex</td><td>the regular expression to register</td></tr>
<tr><td class="paramname">isDurable</td><td>whether the registration should be durable</td></tr>
<tr><td class="paramname">getInitialValues</td><td>true to populate the cache with values of the keys that were registered on the server </td></tr>
<tr><td class="paramname">receiveValues</td><td>whether to act like notify-by-subscription is true </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>If the regular expression string is empty. </td></tr>
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. </td></tr>
<tr><td class="paramname"><a class="el" href="a00802.html" title="Thrown when an unknown message is received from the server.">MessageException</a></td><td>If the message received from server could not be handled. This will be the case when an unregistered typeId is received in the reply or reply is not well formed. More information can be found in the log. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a832d71417a9e2d934c247b26c39d53ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a832d71417a9e2d934c247b26c39d53ed">&#9670;&nbsp;</a></span>UnregisterAllKeys()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::UnregisterAllKeys </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregister interest for all the keys of the region to stop getting updates for them. </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 not previously registered all keys. </td></tr>
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of <a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a> is set to <a class="el" href="a00822.html" title="Thrown when a client is unable to contact any locators.">NoAvailableLocatorsException</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a678613894d0e956f19af10d013e058f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a678613894d0e956f19af10d013e058f4">&#9670;&nbsp;</a></span>UnregisterKeys()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::UnregisterKeys </td>
<td>(</td>
<td class="paramtype">System::Collections::Generic::ICollection&lt; TKey &gt;^&#160;</td>
<td class="paramname"><em>keys</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregisters a collection of keys to stop getting updates for them. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keys</td><td>the collection of keys</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>If the collection of keys is empty. </td></tr>
<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 no keys were previously registered. </td></tr>
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of <a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a> is set to <a class="el" href="a00822.html" title="Thrown when a client is unable to contact any locators.">NoAvailableLocatorsException</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad76e9688f748b8f35b10edf2e0bd1557"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad76e9688f748b8f35b10edf2e0bd1557">&#9670;&nbsp;</a></span>UnregisterRegex()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a01026.html">Apache::Geode::Client::ISubscriptionService</a>&lt; TKey &gt;::UnregisterRegex </td>
<td>(</td>
<td class="paramtype">String^&#160;</td>
<td class="paramname"><em>regex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregister interest for the keys of the region that match the given regular expression to stop getting updates for them. </p>
<p>The regular expression must have been registered previously using a <code>RegisterRegex</code> call. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>If the regular expression string is empty. </td></tr>
<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 this regular expression has not been registered by a previous call to <code>RegisterRegex</code>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00790.html" title="Thrown when an exception occurs on the cache server.">CacheServerException</a></td><td>If an exception is received from the Java cache server. </td></tr>
<tr><td class="paramname"><a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a></td><td>if not connected to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of <a class="el" href="a00742.html" title="Thrown when an operation is attempted before connecting to the distributed system.">NotConnectedException</a> is set to <a class="el" href="a00822.html" title="Thrown when a client is unable to contact any locators.">NoAvailableLocatorsException</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="a00678.html" title="Thrown when an operation is attempted on a destroyed region.">RegionDestroyedException</a></td><td>If region destroy is pending. </td></tr>
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>If the region is not a Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> region </td></tr>
<tr><td class="paramname"><a class="el" href="a00650.html" title="Thrown when a timout occurs.">TimeoutException</a></td><td>if the operation timed out </td></tr>
<tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>For other exceptions.</td></tr>
</table>
</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>