releases/latest/javadoc/org/apache/geode/CancelCriterion.html - geode-site - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>CancelCriterion (Apache Geode 1.15.1)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="CancelCriterion (Apache Geode 1.15.1)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":6,"i5":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../index-all.html">Index</a></li>
 <li><a href="../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li>Prev&nbsp;Class</li>
 <li><a href="../../../org/apache/geode/CancelException.html" title="class in org.apache.geode"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?org/apache/geode/CancelCriterion.html" target="_top">Frames</a></li>
 <li><a href="CancelCriterion.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">org.apache.geode</div>
 <h2 title="Class CancelCriterion" class="title">Class CancelCriterion</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
 <li>
 <ul class="inheritance">
 <li>org.apache.geode.CancelCriterion</li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>public abstract class <span class="typeNameLabel">CancelCriterion</span>
 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
 <div class="block">Abstract cancellation proxy for cancelling an operation, esp. a thread.

  Creators of services or threads should implement a subclass of CancelCriterion, and implement the
  two methods - cancelInProgress, and generateCancelledException(e).

  Code inside the service can check to see if the service is cancelled by calling
  <a href="../../../org/apache/geode/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-"><code>checkCancelInProgress(Throwable)</code></a>. Generally the pattern is to check before performing an
  operation, check if the service is canceled before propagating an exception further up the stack,
  and check for cancellation inside a long loop. Eg.

  <pre>
  while (true) {
    c.checkCancelInProgress(null);
    try {
      dispatchEvents();
    } catch (IOException e) {
      c.checkCancelInProgress(e);
      throw e;
    }
  }
  </pre></div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>GemFire 5.1</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../org/apache/geode/CancelException.html" title="class in org.apache.geode"><code>CancelException</code></a></dd>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colOne" scope="col">Constructor and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#CancelCriterion--">CancelCriterion</a></span>()</code>&nbsp;</td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#cancelInProgress--">cancelInProgress</a></span>()</code>
 <div class="block">Indicate if the service is in the progress of being cancelled.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#checkCancelInProgress--">checkCancelInProgress</a></span>()</code>&nbsp;</td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-">checkCancelInProgress</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;e)</code>
 <div class="block">See if the current operation is being cancelled.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#checkFailure--">checkFailure</a></span>()</code>
 <div class="block">Use this utility function in your implementation of cancelInProgress() and cancelled() to
  indicate a system failure</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#generateCancelledException-java.lang.Throwable-">generateCancelledException</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;throwable)</code>
 <div class="block">Template factory method for generating the exception to be thrown by
  <a href="../../../org/apache/geode/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-"><code>checkCancelInProgress(Throwable)</code></a>.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#isCancelInProgress--">isCancelInProgress</a></span>()</code>
 <div class="block">Checks to see if a cancellation is in progress.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a name="CancelCriterion--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>CancelCriterion</h4>
 <pre>public&nbsp;CancelCriterion()</pre>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="cancelInProgress--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>cancelInProgress</h4>
 <pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cancelInProgress()</pre>
 <div class="block">Indicate if the service is in the progress of being cancelled. The typical use of this is to
  indicate, in the case of an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang"><code>InterruptedException</code></a>, that the current operation should be
  cancelled.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>null if the service is not shutting down, or a message that can be used to construct an
          exception indicating the service is shut down.</dd>
 </dl>
 </li>
 </ul>
 <a name="checkFailure--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>checkFailure</h4>
 <pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;checkFailure()</pre>
 <div class="block">Use this utility function in your implementation of cancelInProgress() and cancelled() to
  indicate a system failure</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>failure string if system failure has occurred</dd>
 </dl>
 </li>
 </ul>
 <a name="checkCancelInProgress-java.lang.Throwable-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>checkCancelInProgress</h4>
 <pre>public&nbsp;void&nbsp;checkCancelInProgress(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;e)</pre>
 <div class="block">See if the current operation is being cancelled. If so, it either throws a
  <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang"><code>RuntimeException</code></a> (usually a <a href="../../../org/apache/geode/CancelException.html" title="class in org.apache.geode"><code>CancelException</code></a>).</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>e</code> - an underlying exception or null if there is no exception that triggered this check</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../org/apache/geode/CancelCriterion.html#cancelInProgress--"><code>cancelInProgress()</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="checkCancelInProgress--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>checkCancelInProgress</h4>
 <pre>public&nbsp;void&nbsp;checkCancelInProgress()</pre>
 </li>
 </ul>
 <a name="generateCancelledException-java.lang.Throwable-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>generateCancelledException</h4>
 <pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a>&nbsp;generateCancelledException(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;throwable)</pre>
 <div class="block">Template factory method for generating the exception to be thrown by
  <a href="../../../org/apache/geode/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-"><code>checkCancelInProgress(Throwable)</code></a>. Override this to specify different exception for
  checkCancelInProgress() to throw.

  This method should wrap the exception in a service specific CancelationException (eg
  CacheClosedException). or return null if the service is not being canceled.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>throwable</code> - an underlying exception, if any</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>RuntimeException to be thrown by checkCancelInProgress(), null if the receiver has not
          been cancelled.</dd>
 </dl>
 </li>
 </ul>
 <a name="isCancelInProgress--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>isCancelInProgress</h4>
 <pre>public&nbsp;boolean&nbsp;isCancelInProgress()</pre>
 <div class="block">Checks to see if a cancellation is in progress. This is equivalent to the expression
  (cancelInProgress() != null).</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if a cancellation is in progress, false if not</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../index-all.html">Index</a></li>
 <li><a href="../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li>Prev&nbsp;Class</li>
 <li><a href="../../../org/apache/geode/CancelException.html" title="class in org.apache.geode"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?org/apache/geode/CancelCriterion.html" target="_top">Frames</a></li>
 <li><a href="CancelCriterion.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc -->
	<title>CancelCriterion (Apache Geode 1.15.1)</title>
	<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
	<script type="text/javascript" src="../../../script.js"></script>
	</head>
	<body>
	<script type="text/javascript"><!--
	try {
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="CancelCriterion (Apache Geode 1.15.1)";
	}
	}
	catch(err) {
	}
	//-->
	var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":6,"i5":10};
	var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
	var altColor = "altColor";
	var rowColor = "rowColor";
	var tableTab = "tableTab";
	var activeTableTab = "activeTableTab";
	</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a name="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<a name="navbar.top.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../overview-summary.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../index-all.html">Index</a></li>
	<li><a href="../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList">
	<li>Prev Class</li>
	<li><a href="../../../org/apache/geode/CancelException.html" title="class in org.apache.geode"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../index.html?org/apache/geode/CancelCriterion.html" target="_top">Frames</a></li>
	<li><a href="CancelCriterion.html" target="_top">No Frames</a></li>
	</ul>
	<ul class="navList" id="allclasses_navbar_top">
	<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_top");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	<a name="skip.navbar.top">
	<!-- -->
	</a></div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	<!-- ======== START OF CLASS DATA ======== -->
	<div class="header">
	<div class="subTitle">org.apache.geode</div>
	<h2 title="Class CancelCriterion" class="title">Class CancelCriterion</h2>
	</div>
	<div class="contentContainer">
	<ul class="inheritance">
	<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
	<li>
	<ul class="inheritance">
	<li>org.apache.geode.CancelCriterion</li>
	</ul>
	</li>
	</ul>
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre>public abstract class <span class="typeNameLabel">CancelCriterion</span>
	extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
	<div class="block">Abstract cancellation proxy for cancelling an operation, esp. a thread.

	Creators of services or threads should implement a subclass of CancelCriterion, and implement the
	two methods - cancelInProgress, and generateCancelledException(e).

	Code inside the service can check to see if the service is cancelled by calling
	<a href="../../../org/apache/geode/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-"><code>checkCancelInProgress(Throwable)</code></a>. Generally the pattern is to check before performing an
	operation, check if the service is canceled before propagating an exception further up the stack,
	and check for cancellation inside a long loop. Eg.

	<pre>
	while (true) {
	c.checkCancelInProgress(null);
	try {
	dispatchEvents();
	} catch (IOException e) {
	c.checkCancelInProgress(e);
	throw e;
	}
	}
	</pre></div>
	<dl>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>GemFire 5.1</dd>
	<dt><span class="seeLabel">See Also:</span></dt>
	<dd><a href="../../../org/apache/geode/CancelException.html" title="class in org.apache.geode"><code>CancelException</code></a></dd>
	</dl>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
	<ul class="blockList">
	<li class="blockList"><a name="constructor.summary">
	<!-- -->
	</a>
	<h3>Constructor Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
	<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colOne" scope="col">Constructor and Description</th>
	</tr>
	<tr class="altColor">
	<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#CancelCriterion--">CancelCriterion</a></span>()</code> </td>
	</tr>
	</table>
	</li>
	</ul>
	<!-- ========== METHOD SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="method.summary">
	<!-- -->
	</a>
	<h3>Method Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
	<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Method and Description</th>
	</tr>
	<tr id="i0" class="altColor">
	<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#cancelInProgress--">cancelInProgress</a></span>()</code>
	<div class="block">Indicate if the service is in the progress of being cancelled.</div>
	</td>
	</tr>
	<tr id="i1" class="rowColor">
	<td class="colFirst"><code>void</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#checkCancelInProgress--">checkCancelInProgress</a></span>()</code> </td>
	</tr>
	<tr id="i2" class="altColor">
	<td class="colFirst"><code>void</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-">checkCancelInProgress</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> e)</code>
	<div class="block">See if the current operation is being cancelled.</div>
	</td>
	</tr>
	<tr id="i3" class="rowColor">
	<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#checkFailure--">checkFailure</a></span>()</code>
	<div class="block">Use this utility function in your implementation of cancelInProgress() and cancelled() to
	indicate a system failure</div>
	</td>
	</tr>
	<tr id="i4" class="altColor">
	<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#generateCancelledException-java.lang.Throwable-">generateCancelledException</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> throwable)</code>
	<div class="block">Template factory method for generating the exception to be thrown by
	<a href="../../../org/apache/geode/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-"><code>checkCancelInProgress(Throwable)</code></a>.</div>
	</td>
	</tr>
	<tr id="i5" class="rowColor">
	<td class="colFirst"><code>boolean</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/geode/CancelCriterion.html#isCancelInProgress--">isCancelInProgress</a></span>()</code>
	<div class="block">Checks to see if a cancellation is in progress.</div>
	</td>
	</tr>
	</table>
	<ul class="blockList">
	<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
	<!-- -->
	</a>
	<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
	<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ========= CONSTRUCTOR DETAIL ======== -->
	<ul class="blockList">
	<li class="blockList"><a name="constructor.detail">
	<!-- -->
	</a>
	<h3>Constructor Detail</h3>
	<a name="CancelCriterion--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>CancelCriterion</h4>
	<pre>public CancelCriterion()</pre>
	</li>
	</ul>
	</li>
	</ul>
	<!-- ============ METHOD DETAIL ========== -->
	<ul class="blockList">
	<li class="blockList"><a name="method.detail">
	<!-- -->
	</a>
	<h3>Method Detail</h3>
	<a name="cancelInProgress--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>cancelInProgress</h4>
	<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> cancelInProgress()</pre>
	<div class="block">Indicate if the service is in the progress of being cancelled. The typical use of this is to
	indicate, in the case of an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang"><code>InterruptedException</code></a>, that the current operation should be
	cancelled.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>null if the service is not shutting down, or a message that can be used to construct an
	exception indicating the service is shut down.</dd>
	</dl>
	</li>
	</ul>
	<a name="checkFailure--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>checkFailure</h4>
	<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> checkFailure()</pre>
	<div class="block">Use this utility function in your implementation of cancelInProgress() and cancelled() to
	indicate a system failure</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>failure string if system failure has occurred</dd>
	</dl>
	</li>
	</ul>
	<a name="checkCancelInProgress-java.lang.Throwable-">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>checkCancelInProgress</h4>
	<pre>public void checkCancelInProgress(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> e)</pre>
	<div class="block">See if the current operation is being cancelled. If so, it either throws a
	<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang"><code>RuntimeException</code></a> (usually a <a href="../../../org/apache/geode/CancelException.html" title="class in org.apache.geode"><code>CancelException</code></a>).</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>e</code> - an underlying exception or null if there is no exception that triggered this check</dd>
	<dt><span class="seeLabel">See Also:</span></dt>
	<dd><a href="../../../org/apache/geode/CancelCriterion.html#cancelInProgress--"><code>cancelInProgress()</code></a></dd>
	</dl>
	</li>
	</ul>
	<a name="checkCancelInProgress--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>checkCancelInProgress</h4>
	<pre>public void checkCancelInProgress()</pre>
	</li>
	</ul>
	<a name="generateCancelledException-java.lang.Throwable-">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>generateCancelledException</h4>
	<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a> generateCancelledException(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> throwable)</pre>
	<div class="block">Template factory method for generating the exception to be thrown by
	<a href="../../../org/apache/geode/CancelCriterion.html#checkCancelInProgress-java.lang.Throwable-"><code>checkCancelInProgress(Throwable)</code></a>. Override this to specify different exception for
	checkCancelInProgress() to throw.

	This method should wrap the exception in a service specific CancelationException (eg
	CacheClosedException). or return null if the service is not being canceled.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>throwable</code> - an underlying exception, if any</dd>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>RuntimeException to be thrown by checkCancelInProgress(), null if the receiver has not
	been cancelled.</dd>
	</dl>
	</li>
	</ul>
	<a name="isCancelInProgress--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>isCancelInProgress</h4>
	<pre>public boolean isCancelInProgress()</pre>
	<div class="block">Checks to see if a cancellation is in progress. This is equivalent to the expression
	(cancelInProgress() != null).</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>true if a cancellation is in progress, false if not</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	</div>
	</div>
	<!-- ========= END OF CLASS DATA ========= -->
	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<div class="bottomNav"><a name="navbar.bottom">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<a name="navbar.bottom.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../overview-summary.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../index-all.html">Index</a></li>
	<li><a href="../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList">
	<li>Prev Class</li>
	<li><a href="../../../org/apache/geode/CancelException.html" title="class in org.apache.geode"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../index.html?org/apache/geode/CancelCriterion.html" target="_top">Frames</a></li>
	<li><a href="CancelCriterion.html" target="_top">No Frames</a></li>
	</ul>
	<ul class="navList" id="allclasses_navbar_bottom">
	<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_bottom");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	<a name="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</body>
	</html>