blob: 24b1488ff7f2a853a9457733cb9fd1b967003f13 [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::Expiration 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.1</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('a00886.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-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Apache::Geode::Client::Expiration Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Static class containing convenience methods for <code>ExpirationAction</code>.
<a href="a00886.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a2be2f5124a578bc908072b37de9ae078"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00886.html#a2be2f5124a578bc908072b37de9ae078">IsDestroy</a> (<a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> type)</td></tr>
<tr class="memdesc:a2be2f5124a578bc908072b37de9ae078"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this action is distributed destroy. <a href="#a2be2f5124a578bc908072b37de9ae078">More...</a><br /></td></tr>
<tr class="separator:a2be2f5124a578bc908072b37de9ae078"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a222ae3ab6a86fa1a7a1196eacc11fc25"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00886.html#a222ae3ab6a86fa1a7a1196eacc11fc25">IsDistributed</a> (<a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> type)</td></tr>
<tr class="memdesc:a222ae3ab6a86fa1a7a1196eacc11fc25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this action is distributed. <a href="#a222ae3ab6a86fa1a7a1196eacc11fc25">More...</a><br /></td></tr>
<tr class="separator:a222ae3ab6a86fa1a7a1196eacc11fc25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fb6d5712f13bb7b701c81f0b8ac8931"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00886.html#a5fb6d5712f13bb7b701c81f0b8ac8931">IsInvalidate</a> (<a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> type)</td></tr>
<tr class="memdesc:a5fb6d5712f13bb7b701c81f0b8ac8931"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this action is distributed invalidate. <a href="#a5fb6d5712f13bb7b701c81f0b8ac8931">More...</a><br /></td></tr>
<tr class="separator:a5fb6d5712f13bb7b701c81f0b8ac8931"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad550f2d4d604fb780cbf7a2a28edaae2"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00886.html#ad550f2d4d604fb780cbf7a2a28edaae2">IsLocal</a> (<a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> type)</td></tr>
<tr class="memdesc:ad550f2d4d604fb780cbf7a2a28edaae2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this action is local. <a href="#ad550f2d4d604fb780cbf7a2a28edaae2">More...</a><br /></td></tr>
<tr class="separator:ad550f2d4d604fb780cbf7a2a28edaae2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33edb25717d9b92d21573a3829e04abe"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00886.html#a33edb25717d9b92d21573a3829e04abe">IsLocalDestroy</a> (<a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> type)</td></tr>
<tr class="memdesc:a33edb25717d9b92d21573a3829e04abe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this action is local destroy. <a href="#a33edb25717d9b92d21573a3829e04abe">More...</a><br /></td></tr>
<tr class="separator:a33edb25717d9b92d21573a3829e04abe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38d93ea870bd7dca1d12cc589eb6bfc1"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00886.html#a38d93ea870bd7dca1d12cc589eb6bfc1">IsLocalInvalidate</a> (<a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a> type)</td></tr>
<tr class="memdesc:a38d93ea870bd7dca1d12cc589eb6bfc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this action is local invalidate. <a href="#a38d93ea870bd7dca1d12cc589eb6bfc1">More...</a><br /></td></tr>
<tr class="separator:a38d93ea870bd7dca1d12cc589eb6bfc1"><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>Static class containing convenience methods for <code>ExpirationAction</code>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a2be2f5124a578bc908072b37de9ae078"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2be2f5124a578bc908072b37de9ae078">&#9670;&nbsp;</a></span>IsDestroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool Apache::Geode::Client::Expiration::IsDestroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a>&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this action is distributed destroy. </p>
<dl class="section return"><dt>Returns</dt><dd>true if this is <code>Destroy</code></dd></dl>
</div>
</div>
<a id="a222ae3ab6a86fa1a7a1196eacc11fc25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a222ae3ab6a86fa1a7a1196eacc11fc25">&#9670;&nbsp;</a></span>IsDistributed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool Apache::Geode::Client::Expiration::IsDistributed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a>&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this action is distributed. </p>
<dl class="section return"><dt>Returns</dt><dd>true if this is an <code>Invalidate</code> or a <code>Destroy</code></dd></dl>
</div>
</div>
<a id="a5fb6d5712f13bb7b701c81f0b8ac8931"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fb6d5712f13bb7b701c81f0b8ac8931">&#9670;&nbsp;</a></span>IsInvalidate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool Apache::Geode::Client::Expiration::IsInvalidate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a>&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this action is distributed invalidate. </p>
<dl class="section return"><dt>Returns</dt><dd>true if this an <code>Invalidate</code></dd></dl>
</div>
</div>
<a id="ad550f2d4d604fb780cbf7a2a28edaae2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad550f2d4d604fb780cbf7a2a28edaae2">&#9670;&nbsp;</a></span>IsLocal()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool Apache::Geode::Client::Expiration::IsLocal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a>&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this action is local. </p>
<dl class="section return"><dt>Returns</dt><dd>true if this is <code>LocalInvalidate</code> or <code>LocalDestroy</code></dd></dl>
</div>
</div>
<a id="a33edb25717d9b92d21573a3829e04abe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33edb25717d9b92d21573a3829e04abe">&#9670;&nbsp;</a></span>IsLocalDestroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool Apache::Geode::Client::Expiration::IsLocalDestroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a>&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this action is local destroy. </p>
<dl class="section return"><dt>Returns</dt><dd>true if this is <code>LocalDestroy</code></dd></dl>
</div>
</div>
<a id="a38d93ea870bd7dca1d12cc589eb6bfc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38d93ea870bd7dca1d12cc589eb6bfc1">&#9670;&nbsp;</a></span>IsLocalInvalidate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool Apache::Geode::Client::Expiration::IsLocalInvalidate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00382.html#a30c72f6219e29e7305222feb4857caec">ExpirationAction</a>&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this action is local invalidate. </p>
<dl class="section return"><dt>Returns</dt><dd>true if this is a <code>LocalInvalidate</code></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>