blob: c6b07fe3c23f6506659a05266368438a25391ba3 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<META NAME="ROBOTS" CONTENT="NOINDEX">
<link rel="canonical" href="https://ignite.apache.org/releases/1.7.0/javadoc/org/apache/ignite/compute/ComputeJobContinuation.html" />
<!-- Generated by javadoc (version 1.7.0_80) on Mon Aug 01 20:32:31 MSK 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ComputeJobContinuation (Ignite 1.7.0)</title>
<meta name="date" content="2016-08-01">
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ComputeJobContinuation (Ignite 1.7.0)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/ComputeJobContinuation.html">Use</a></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 class="aboutLanguage"><em>Ignite - In-Memory Data Fabric</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/compute/ComputeJobContext.html" title="interface in org.apache.ignite.compute"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/ignite/compute/ComputeJobContinuationAdapter.html" title="class in org.apache.ignite.compute"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/compute/ComputeJobContinuation.html" target="_top">Frames</a></li>
<li><a href="ComputeJobContinuation.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.ignite.compute</div>
<h2 title="Interface ComputeJobContinuation" class="title">Interface ComputeJobContinuation</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/ignite/compute/ComputeJobContext.html" title="interface in org.apache.ignite.compute">ComputeJobContext</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/ignite/compute/ComputeJobContinuationAdapter.html" title="class in org.apache.ignite.compute">ComputeJobContinuationAdapter</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ComputeJobContinuation</span></pre>
<div class="block">Defines continuation support for grid job context.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#callcc()">callcc</a></strong>()</code>
<div class="block">Resumes job if it was held by <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#holdcc()"><code>holdcc()</code></a> method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#heldcc()">heldcc</a></strong>()</code>
<div class="block">Checks if job execution has been temporarily held (suspended).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#holdcc()">holdcc</a></strong>()</code>
<div class="block">Holds (suspends) a given job indefinitely until <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#callcc()"><code>callcc()</code></a> is called.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#holdcc(long)">holdcc</a></strong>(long&nbsp;timeout)</code>
<div class="block">Holds (suspends) a given job for specified timeout or until <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#callcc()"><code>callcc()</code></a> is called.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="heldcc()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heldcc</h4>
<pre>boolean&nbsp;heldcc()</pre>
<div class="block">Checks if job execution has been temporarily held (suspended).
<p>
If job has completed its execution, then <code>false</code> is always returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>True</code> if job has been held.</dd></dl>
</li>
</ul>
<a name="holdcc()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>holdcc</h4>
<pre>@Nullable
&lt;T&gt;&nbsp;T&nbsp;holdcc()</pre>
<div class="block">Holds (suspends) a given job indefinitely until <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#callcc()"><code>callcc()</code></a> is called.
Job will remain in active queue, but its <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#heldcc()"><code>heldcc()</code></a> method will
return <code>true</code>. Implementations of <a href="../../../../org/apache/ignite/spi/collision/CollisionSpi.html" title="interface in org.apache.ignite.spi.collision"><code>CollisionSpi</code></a> should check
if jobs are held or not as needed.
<p>
All jobs should stop their execution and return right after calling
<code>'holdcc(..)'</code> method. For convenience, this method always returns <code>null</code>,
so you can hold and return in one line by calling <code>'return holdcc()'</code> method.
<p>
If job is not running or has completed its execution, then no-op.
<p>
The <code>'cc'</code> suffix stands for <code>'current-continuation'</code> which is a
pretty standard notation for this concept that originated from Scheme programming
language. Basically, the job is held to be continued later, hence the name of the method.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Always returns <code>null</code> for convenience to be used in code with return statement.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If job has been already held before.</dd></dl>
</li>
</ul>
<a name="holdcc(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>holdcc</h4>
<pre>@Nullable
&lt;T&gt;&nbsp;T&nbsp;holdcc(long&nbsp;timeout)</pre>
<div class="block">Holds (suspends) a given job for specified timeout or until <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#callcc()"><code>callcc()</code></a> is called.
Holds (suspends) a given job for specified timeout or until <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#callcc()"><code>callcc()</code></a> is called.
Job will remain in active queue, but its <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#heldcc()"><code>heldcc()</code></a> method will
return <code>true</code>. Implementations of <a href="../../../../org/apache/ignite/spi/collision/CollisionSpi.html" title="interface in org.apache.ignite.spi.collision"><code>CollisionSpi</code></a> should check
if jobs are held or not as needed.
<p>
All jobs should stop their execution and return right after calling
<code>'holdcc(..)'</code> method. For convenience, this method always returns <code>null</code>,
so you can hold and return in one line by calling <code>'return holdcc()'</code>.
<p>
If job is not running or has completed its execution, then no-op.
<p>
The <code>'cc'</code> suffix stands for <code>'current-continuation'</code> which is a
fairly standard notation for this concept. Basically, the job is <i>held</i> to
be continued later, hence the name of the method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - Timeout in milliseconds after which job will be automatically resumed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Always returns <code>null</code> for convenience to be used in code with return statement.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If job has been already held before</dd></dl>
</li>
</ul>
<a name="callcc()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>callcc</h4>
<pre>void&nbsp;callcc()</pre>
<div class="block">Resumes job if it was held by <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#holdcc()"><code>holdcc()</code></a> method. Resuming job means that
<a href="../../../../org/apache/ignite/compute/ComputeJob.html#execute()"><code>ComputeJob.execute()</code></a> method will be called again. It is user's responsibility to check,
as needed, whether job is executing from scratch and has been resumed.
<p>
Note that the job is resumed with exactly the same state as of when it was <i>'held'</i> via
the <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#holdcc()"><code>holdcc()</code></a> method.
<p>
If job is not running, has not been suspended, or has completed its execution, then no-op.
<p>
The method is named after <code>'call-with-current-continuation'</code> design pattern, commonly
abbreviated as <code>'call/cc'</code>, which originated in Scheme programming language.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/ComputeJobContinuation.html">Use</a></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 class="aboutLanguage"><em>Ignite - In-Memory Data Fabric</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/compute/ComputeJobContext.html" title="interface in org.apache.ignite.compute"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/ignite/compute/ComputeJobContinuationAdapter.html" title="class in org.apache.ignite.compute"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/compute/ComputeJobContinuation.html" target="_top">Frames</a></li>
<li><a href="ComputeJobContinuation.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2015 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Fabric</b> </td> <td>:&nbsp;&nbsp; ver. <strong>1.7.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; August 1 2016 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>