blob: 32ce1b481d5fc09418e054cd29526dca331d268c [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>
<link rel="canonical" href="https://ignite.apache.org/releases/latest/javadoc/org/apache/ignite/compute/ComputeJobContinuationAdapter.html" />
<!-- Generated by javadoc (1.8.0_261) on Wed Dec 09 14:33:08 MSK 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ComputeJobContinuationAdapter (Ignite 2.9.1)</title>
<meta name="date" content="2020-12-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/>
<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"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ComputeJobContinuationAdapter (Ignite 2.9.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="class-use/ComputeJobContinuationAdapter.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/compute/ComputeJobFailoverException.html" title="class in org.apache.ignite.compute"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/compute/ComputeJobContinuationAdapter.html" target="_top">Frames</a></li>
<li><a href="ComputeJobContinuationAdapter.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.ignite.compute</div>
<h2 title="Class ComputeJobContinuationAdapter" class="title">Class ComputeJobContinuationAdapter</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><a href="../../../../org/apache/ignite/compute/ComputeJobAdapter.html" title="class in org.apache.ignite.compute">org.apache.ignite.compute.ComputeJobAdapter</a></li>
<li>
<ul class="inheritance">
<li>org.apache.ignite.compute.ComputeJobContinuationAdapter</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a><span class='angle_bracket'>&lt;</span><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><span class='angle_bracket'>&gt;</span>, <a href="../../../../org/apache/ignite/compute/ComputeJob.html" title="interface in org.apache.ignite.compute">ComputeJob</a>, <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute">ComputeJobContinuation</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ComputeJobContinuationAdapter</span>
extends <a href="../../../../org/apache/ignite/compute/ComputeJobAdapter.html" title="class in org.apache.ignite.compute">ComputeJobAdapter</a>
implements <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute">ComputeJobContinuation</a></pre>
<div class="block">Convenience adapter for <a href="../../../../org/apache/ignite/compute/ComputeJob.html" title="interface in org.apache.ignite.compute"><code>ComputeJob</code></a> implementations. It provides the
following functionality:
<ul>
<li>
Default implementation of <a href="../../../../org/apache/ignite/compute/ComputeJob.html#cancel--"><code>ComputeJob.cancel()</code></a> method and ability
to check whether cancellation occurred.
</li>
<li>
Ability to set and get a job arguments via <a href="../../../../org/apache/ignite/compute/ComputeJobAdapter.html#setArguments-java.lang.Object...-"><code>ComputeJobAdapter.setArguments(Object...)</code></a>
and <a href="../../../../org/apache/ignite/compute/ComputeJobAdapter.html#argument-int-"><code>ComputeJobAdapter.argument(int)</code></a> methods.
</li>
</ul>
Here is an example of how <code>ComputeJobAdapter</code> can be used from task logic
to create jobs. The example creates job adapter as anonymous class, but you
are free to create a separate class for it.
<pre name="code" class="java">
public class TestGridTask extends ComputeTaskSplitAdapter&lt;String, Integer&gt; {
// Used to imitate some logic for the
// sake of this example
private int multiplier = 3;
&#64;Override
protected Collection&lt;? extends ComputeJob&gt; split(int gridSize, final String arg) throws IgniteCheckedException {
List&lt;ComputeJobAdapter&lt;String&gt;&gt; jobs = new ArrayList&lt;ComputeJobAdapter&lt;String&gt;&gt;(gridSize);
for (int i = 0; i < gridSize; i++) {
jobs.add(new ComputeJobAdapter() {
// Job execution logic.
public Object execute() throws IgniteCheckedException {
return multiplier * arg.length();
}
});
}
return jobs;
}
// Aggregate multiple job results into
// one task result.
public Integer reduce(List&lt;ComputeJobResult&gt; results) throws IgniteCheckedException {
int sum = 0;
// For the sake of this example, let's sum all results.
for (ComputeJobResult res : results) {
sum += (Integer)res.getData();
}
return sum;
}
}
</pre></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.ignite.compute.ComputeJobContinuationAdapter">Serialized Form</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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContinuationAdapter.html#ComputeJobContinuationAdapter--">ComputeJobContinuationAdapter</a></span>()</code>
<div class="block">No-arg constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContinuationAdapter.html#ComputeJobContinuationAdapter-java.lang.Object...-">ComputeJobContinuationAdapter</a></span>(<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>...&nbsp;args)</code>
<div class="block">Creates job with specified arguments.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContinuationAdapter.html#ComputeJobContinuationAdapter-java.lang.Object-">ComputeJobContinuationAdapter</a></span>(@Nullable <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>&nbsp;arg)</code>
<div class="block">Creates job with one arguments.</div>
</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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContinuationAdapter.html#callcc--">callcc</a></span>()</code>
<div class="block">Resumes job if it was held by <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#holdcc--"><code>ComputeJobContinuation.holdcc()</code></a> method.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContinuationAdapter.html#heldcc--">heldcc</a></span>()</code>
<div class="block">Checks if job execution has been temporarily held (suspended).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContinuationAdapter.html#holdcc--">holdcc</a></span>()</code>
<div class="block">Holds (suspends) a given job indefinitely until <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#callcc--"><code>ComputeJobContinuation.callcc()</code></a> is called.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContinuationAdapter.html#holdcc-long-">holdcc</a></span>(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>ComputeJobContinuation.callcc()</code></a> is called.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.compute.ComputeJobAdapter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.ignite.compute.<a href="../../../../org/apache/ignite/compute/ComputeJobAdapter.html" title="class in org.apache.ignite.compute">ComputeJobAdapter</a></h3>
<code><a href="../../../../org/apache/ignite/compute/ComputeJobAdapter.html#argument-int-">argument</a>, <a href="../../../../org/apache/ignite/compute/ComputeJobAdapter.html#arguments--">arguments</a>, <a href="../../../../org/apache/ignite/compute/ComputeJobAdapter.html#call--">call</a>, <a href="../../../../org/apache/ignite/compute/ComputeJobAdapter.html#cancel--">cancel</a>, <a href="../../../../org/apache/ignite/compute/ComputeJobAdapter.html#isCancelled--">isCancelled</a>, <a href="../../../../org/apache/ignite/compute/ComputeJobAdapter.html#setArguments-java.lang.Object...-">setArguments</a></code></li>
</ul>
<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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.compute.ComputeJob">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.ignite.compute.<a href="../../../../org/apache/ignite/compute/ComputeJob.html" title="interface in org.apache.ignite.compute">ComputeJob</a></h3>
<code><a href="../../../../org/apache/ignite/compute/ComputeJob.html#execute--">execute</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="ComputeJobContinuationAdapter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ComputeJobContinuationAdapter</h4>
<pre>protected&nbsp;ComputeJobContinuationAdapter()</pre>
<div class="block">No-arg constructor.</div>
</li>
</ul>
<a name="ComputeJobContinuationAdapter-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ComputeJobContinuationAdapter</h4>
<pre>protected&nbsp;ComputeJobContinuationAdapter(@Nullable
@Nullable <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>&nbsp;arg)</pre>
<div class="block">Creates job with one arguments. This constructor exists for better
backward compatibility with internal Ignite 2.x code.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arg</code> - Job argument.</dd>
</dl>
</li>
</ul>
<a name="ComputeJobContinuationAdapter-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ComputeJobContinuationAdapter</h4>
<pre>protected&nbsp;ComputeJobContinuationAdapter(@Nullable
<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>...&nbsp;args)</pre>
<div class="block">Creates job with specified arguments.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - Optional job arguments.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ 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>public&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#heldcc--">heldcc</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute">ComputeJobContinuation</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> if job has been held.</dd>
</dl>
</li>
</ul>
<a name="callcc--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>callcc</h4>
<pre>public&nbsp;void&nbsp;callcc()</pre>
<div class="block">Resumes job if it was held by <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#holdcc--"><code>ComputeJobContinuation.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>ComputeJobContinuation.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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#callcc--">callcc</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute">ComputeJobContinuation</a></code></dd>
</dl>
</li>
</ul>
<a name="holdcc--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>holdcc</h4>
<pre>@Nullable
public&nbsp;<span class='angle_bracket'>&lt;</span>T<span class='angle_bracket'>&gt;</span>&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>ComputeJobContinuation.callcc()</code></a> is called.
Job will remain in active queue, but its <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#heldcc--"><code>ComputeJobContinuation.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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#holdcc--">holdcc</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute">ComputeJobContinuation</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Always returns <code>null</code> for convenience to be used in code with return statement.</dd>
</dl>
</li>
</ul>
<a name="holdcc-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>holdcc</h4>
<pre>@Nullable
public&nbsp;<span class='angle_bracket'>&lt;</span>T<span class='angle_bracket'>&gt;</span>&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>ComputeJobContinuation.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>ComputeJobContinuation.callcc()</code></a> is called.
Job will remain in active queue, but its <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#heldcc--"><code>ComputeJobContinuation.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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#holdcc-long-">holdcc</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute">ComputeJobContinuation</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - Timeout in milliseconds after which job will be automatically resumed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Always returns <code>null</code> for convenience to be used in code with return statement.</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="class-use/ComputeJobContinuationAdapter.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/compute/ComputeJobFailoverException.html" title="class in org.apache.ignite.compute"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/compute/ComputeJobContinuationAdapter.html" target="_top">Frames</a></li>
<li><a href="ComputeJobContinuationAdapter.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 ======= -->
<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>2020 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> </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 Database and Caching Platform</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.9.1</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; December 9 2020 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>