Google Git
Sign in
apache / incubator-retired-gearpump-site / 926356f9c28f27c7f0ec008bb6a77bc2927d7658 / . / releases / 0.6.2 / api / java / io / gearpump / streaming / state / api / PersistentTask.html
blob: 3665eafc65d0c36fc9176d626641175446f2e5ee [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>
<!-- Generated by javadoc (version 1.6.0_36) on Tue Nov 24 10:06:51 CST 2015 -->
<title>PersistentTask</title>
<meta name="date" content="2015-11-24">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PersistentTask";
}
//-->
</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="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="../../../../../io/gearpump/streaming/state/api/PersistentState.html" title="interface in io.gearpump.streaming.state.api"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../io/gearpump/streaming/state/api/Serializer.html" title="interface in io.gearpump.streaming.state.api"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?io/gearpump/streaming/state/api/PersistentTask.html" target="_top">FRAMES</a></li>
<li><a href="PersistentTask.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><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">
<p class="subTitle">io.gearpump.streaming.state.api</p>
<h2 title="Class PersistentTask" class="title">Class PersistentTask&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">io.gearpump.streaming.task.Task</a></li>
<li>
<ul class="inheritance">
<li>io.gearpump.streaming.state.api.PersistentTask&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <strong>PersistentTask&lt;T&gt;</strong>
extends <a href="../../../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a></pre>
<div class="block">PersistentTask is part of the transaction API
<p>
Users should extend this task if they want to get transaction support
from the framework</div>
</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="overviewSummary" 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><strong><a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html#PersistentTask(io.gearpump.streaming.task.TaskContext, io.gearpump.cluster.UserConfig)">PersistentTask</a></strong>(<a href="../../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a>&nbsp;taskContext,
io.gearpump.cluster.UserConfig&nbsp;conf)</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="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>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html#checkpointInterval()">checkpointInterval</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../io/gearpump/streaming/state/impl/CheckpointManager.html" title="class in io.gearpump.streaming.state.impl">CheckpointManager</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html#checkpointManager()">checkpointManager</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../io/gearpump/streaming/transaction/api/CheckpointStore.html" title="interface in io.gearpump.streaming.transaction.api">CheckpointStore</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html#checkpointStore()">checkpointStore</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../io/gearpump/streaming/transaction/api/CheckpointStoreFactory.html" title="interface in io.gearpump.streaming.transaction.api">CheckpointStoreFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html#checkpointStoreFactory()">checkpointStoreFactory</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html#onNext(io.gearpump.Message)">onNext</a></strong>(io.gearpump.Message&nbsp;message)</code>
<div class="block">Method called for each message received.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html#onStart(io.gearpump.streaming.task.StartTime)">onStart</a></strong>(<a href="../../../../../io/gearpump/streaming/task/StartTime.html" title="class in io.gearpump.streaming.task">StartTime</a>&nbsp;startTime)</code>
<div class="block">Method called with the task is initialized.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html#onStop()">onStop</a></strong>()</code>
<div class="block">Method called when task is under clean up.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../io/gearpump/streaming/state/api/PersistentState.html" title="interface in io.gearpump.streaming.state.api">PersistentState</a>&lt;<a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html" title="type parameter in PersistentTask">T</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html#persistentState()">persistentState</a></strong>()</code>
<div class="block">subclass should override this method to pass in
a PersistentState</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html#processMessage(io.gearpump.streaming.state.api.PersistentState, io.gearpump.Message)">processMessage</a></strong>(<a href="../../../../../io/gearpump/streaming/state/api/PersistentState.html" title="interface in io.gearpump.streaming.state.api">PersistentState</a>&lt;<a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html" title="type parameter in PersistentTask">T</a>&gt;&nbsp;state,
io.gearpump.Message&nbsp;message)</code>
<div class="block">subclass should override this method to specify how a
new message should update state</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../io/gearpump/streaming/state/api/PersistentState.html" title="interface in io.gearpump.streaming.state.api">PersistentState</a>&lt;<a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html" title="type parameter in PersistentTask">T</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html#state()">state</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_io.gearpump.streaming.task.Task">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;io.gearpump.streaming.task.<a href="../../../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a></h3>
<code><a href="../../../../../io/gearpump/streaming/task/Task.html#LOG()">LOG</a>, <a href="../../../../../io/gearpump/streaming/task/Task.html#receiveUnManagedMessage()">receiveUnManagedMessage</a>, <a href="../../../../../io/gearpump/streaming/task/Task.html#self()">self</a>, <a href="../../../../../io/gearpump/streaming/task/Task.html#sender()">sender</a>, <a href="../../../../../io/gearpump/streaming/task/Task.html#system()">system</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="PersistentTask(io.gearpump.streaming.task.TaskContext, io.gearpump.cluster.UserConfig)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PersistentTask</h4>
<pre>public&nbsp;PersistentTask(<a href="../../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a>&nbsp;taskContext,
io.gearpump.cluster.UserConfig&nbsp;conf)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="checkpointStoreFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkpointStoreFactory</h4>
<pre>public&nbsp;<a href="../../../../../io/gearpump/streaming/transaction/api/CheckpointStoreFactory.html" title="interface in io.gearpump.streaming.transaction.api">CheckpointStoreFactory</a>&nbsp;checkpointStoreFactory()</pre>
</li>
</ul>
<a name="checkpointStore()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkpointStore</h4>
<pre>public&nbsp;<a href="../../../../../io/gearpump/streaming/transaction/api/CheckpointStore.html" title="interface in io.gearpump.streaming.transaction.api">CheckpointStore</a>&nbsp;checkpointStore()</pre>
</li>
</ul>
<a name="checkpointInterval()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkpointInterval</h4>
<pre>public&nbsp;long&nbsp;checkpointInterval()</pre>
</li>
</ul>
<a name="checkpointManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkpointManager</h4>
<pre>public&nbsp;<a href="../../../../../io/gearpump/streaming/state/impl/CheckpointManager.html" title="class in io.gearpump.streaming.state.impl">CheckpointManager</a>&nbsp;checkpointManager()</pre>
</li>
</ul>
<a name="persistentState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>persistentState</h4>
<pre>public abstract&nbsp;<a href="../../../../../io/gearpump/streaming/state/api/PersistentState.html" title="interface in io.gearpump.streaming.state.api">PersistentState</a>&lt;<a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html" title="type parameter in PersistentTask">T</a>&gt;&nbsp;persistentState()</pre>
<div class="block">subclass should override this method to pass in
a PersistentState
<p>
the framework has already offered two states
<p>
- NonWindowState
state with no time or other boundary
- WindowState
each state is bounded by a time window</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="processMessage(io.gearpump.streaming.state.api.PersistentState, io.gearpump.Message)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processMessage</h4>
<pre>public abstract&nbsp;void&nbsp;processMessage(<a href="../../../../../io/gearpump/streaming/state/api/PersistentState.html" title="interface in io.gearpump.streaming.state.api">PersistentState</a>&lt;<a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html" title="type parameter in PersistentTask">T</a>&gt;&nbsp;state,
io.gearpump.Message&nbsp;message)</pre>
<div class="block">subclass should override this method to specify how a
new message should update state</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>state</code> - (undocumented)</dd><dd><code>message</code> - (undocumented)</dd></dl>
</li>
</ul>
<a name="state()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>state</h4>
<pre>public&nbsp;<a href="../../../../../io/gearpump/streaming/state/api/PersistentState.html" title="interface in io.gearpump.streaming.state.api">PersistentState</a>&lt;<a href="../../../../../io/gearpump/streaming/state/api/PersistentTask.html" title="type parameter in PersistentTask">T</a>&gt;&nbsp;state()</pre>
</li>
</ul>
<a name="onStart(io.gearpump.streaming.task.StartTime)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onStart</h4>
<pre>public final&nbsp;void&nbsp;onStart(<a href="../../../../../io/gearpump/streaming/task/StartTime.html" title="class in io.gearpump.streaming.task">StartTime</a>&nbsp;startTime)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../io/gearpump/streaming/task/TaskInterface.html#onStart(io.gearpump.streaming.task.StartTime)">TaskInterface</a></code></strong></div>
<div class="block">Method called with the task is initialized.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../io/gearpump/streaming/task/TaskInterface.html#onStart(io.gearpump.streaming.task.StartTime)">onStart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../io/gearpump/streaming/task/Task.html#onStart(io.gearpump.streaming.task.StartTime)">onStart</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>startTime</code> - startTime that can be used to decide from when a source producer task should replay the data source, or from when a processor task should recover its checkpoint data in to in-memory state.</dd></dl>
</li>
</ul>
<a name="onNext(io.gearpump.Message)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onNext</h4>
<pre>public final&nbsp;void&nbsp;onNext(io.gearpump.Message&nbsp;message)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../io/gearpump/streaming/task/TaskInterface.html#onNext(io.gearpump.Message)">TaskInterface</a></code></strong></div>
<div class="block">Method called for each message received.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../io/gearpump/streaming/task/TaskInterface.html#onNext(io.gearpump.Message)">onNext</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../io/gearpump/streaming/task/Task.html#onNext(io.gearpump.Message)">onNext</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - message send by upstream tasks</dd></dl>
</li>
</ul>
<a name="onStop()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onStop</h4>
<pre>public final&nbsp;void&nbsp;onStop()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../io/gearpump/streaming/task/TaskInterface.html#onStop()">TaskInterface</a></code></strong></div>
<div class="block">Method called when task is under clean up.
This can be used to cleanup resource when the application finished.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../io/gearpump/streaming/task/TaskInterface.html#onStop()">onStop</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../io/gearpump/streaming/task/Task.html#onStop()">onStop</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a></code></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><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="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="../../../../../io/gearpump/streaming/state/api/PersistentState.html" title="interface in io.gearpump.streaming.state.api"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../io/gearpump/streaming/state/api/Serializer.html" title="interface in io.gearpump.streaming.state.api"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?io/gearpump/streaming/state/api/PersistentTask.html" target="_top">FRAMES</a></li>
<li><a href="PersistentTask.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><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>