Google Git
Sign in
apache / incubator-retired-gearpump-site / f2a69d38efa9a4415d78fca68868f176ad60dd49 / . / releases / 0.8.3 / api / java / org / apache / gearpump / streaming / task / TaskInterface.html
blob: 36030107db1698af0dece5c9718345d44a3e8010 [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 (1.8.0_121) on Tue Apr 25 03:06:38 SST 2017 -->
<title>TaskInterface</title>
<meta name="date" content="2017-04-25">
<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="TaskInterface";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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><a href="../../../../../org/apache/gearpump/streaming/task/TaskId.html" title="class in org.apache.gearpump.streaming.task"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/gearpump/streaming/task/TaskMessageSerializer.html" title="interface in org.apache.gearpump.streaming.task"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/gearpump/streaming/task/TaskInterface.html" target="_top">Frames</a></li>
<li><a href="TaskInterface.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>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.gearpump.streaming.task</div>
<h2 title="Interface TaskInterface" class="title">Interface TaskInterface</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/gearpump/streaming/dsl/task/CountTriggerTask.html" title="class in org.apache.gearpump.streaming.dsl.task">CountTriggerTask</a>, <a href="../../../../../org/apache/gearpump/streaming/sink/DataSinkTask.html" title="class in org.apache.gearpump.streaming.sink">DataSinkTask</a>, <a href="../../../../../org/apache/gearpump/streaming/source/DataSourceTask.html" title="class in org.apache.gearpump.streaming.source">DataSourceTask</a>, <a href="../../../../../org/apache/gearpump/streaming/dsl/task/EventTimeTriggerTask.html" title="class in org.apache.gearpump.streaming.dsl.task">EventTimeTriggerTask</a>, <a href="../../../../../org/apache/gearpump/streaming/dsl/plan/OpSpec.AnyTask.html" title="class in org.apache.gearpump.streaming.dsl.plan">OpSpec.AnyTask</a>, <a href="../../../../../org/apache/gearpump/streaming/state/api/PersistentTask.html" title="class in org.apache.gearpump.streaming.state.api">PersistentTask</a>, <a href="../../../../../org/apache/gearpump/streaming/dsl/plan/PlannerSpec.AnyTask.html" title="class in org.apache.gearpump.streaming.dsl.plan">PlannerSpec.AnyTask</a>, <a href="../../../../../org/apache/gearpump/streaming/dsl/task/ProcessingTimeTriggerTask.html" title="class in org.apache.gearpump.streaming.dsl.task">ProcessingTimeTriggerTask</a>, <a href="../../../../../org/apache/gearpump/streaming/dsl/scalaapi/StreamSpec.Join.html" title="class in org.apache.gearpump.streaming.dsl.scalaapi">StreamSpec.Join</a>, <a href="../../../../../org/apache/gearpump/streaming/task/SubscriptionSpec.NextTask.html" title="class in org.apache.gearpump.streaming.task">SubscriptionSpec.NextTask</a>, <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a>, <a href="../../../../../org/apache/gearpump/streaming/javaapi/Task.html" title="class in org.apache.gearpump.streaming.javaapi">Task</a>, <a href="../../../../../org/apache/gearpump/streaming/appmaster/TaskA.html" title="class in org.apache.gearpump.streaming.appmaster">TaskA</a>, <a href="../../../../../org/apache/gearpump/streaming/appmaster/TaskB.html" title="class in org.apache.gearpump.streaming.appmaster">TaskB</a>, <a href="../../../../../org/apache/gearpump/streaming/executor/TaskLauncherSpec.MockTask.html" title="class in org.apache.gearpump.streaming.executor">TaskLauncherSpec.MockTask</a>, <a href="../../../../../org/apache/gearpump/streaming/appmaster/TaskManagerSpec.Task1.html" title="class in org.apache.gearpump.streaming.appmaster">TaskManagerSpec.Task1</a>, <a href="../../../../../org/apache/gearpump/streaming/appmaster/TaskManagerSpec.Task2.html" title="class in org.apache.gearpump.streaming.appmaster">TaskManagerSpec.Task2</a>, <a href="../../../../../org/apache/gearpump/streaming/appmaster/TaskSchedulerSpec.TestTask1.html" title="class in org.apache.gearpump.streaming.appmaster">TaskSchedulerSpec.TestTask1</a>, <a href="../../../../../org/apache/gearpump/streaming/appmaster/TaskSchedulerSpec.TestTask2.html" title="class in org.apache.gearpump.streaming.appmaster">TaskSchedulerSpec.TestTask2</a>, <a href="../../../../../org/apache/gearpump/streaming/task/TaskWrapper.html" title="class in org.apache.gearpump.streaming.task">TaskWrapper</a>, <a href="../../../../../org/apache/gearpump/streaming/dsl/task/TransformTask.html" title="class in org.apache.gearpump.streaming.dsl.task">TransformTask</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">TaskInterface</span></pre>
<div class="block">Streaming Task interface</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="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></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/gearpump/streaming/task/TaskInterface.html#onNext-org.apache.gearpump.Message-">onNext</a></span>(<a href="../../../../../org/apache/gearpump/Message.html" title="class in org.apache.gearpump">Message</a>&nbsp;msg)</code>
<div class="block">Method called for each message received.</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/gearpump/streaming/task/TaskInterface.html#onStart-java.time.Instant-">onStart</a></span>(java.time.Instant&nbsp;startTime)</code>
<div class="block">Method called with the task is initialized.</div>
</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/gearpump/streaming/task/TaskInterface.html#onStop--">onStop</a></span>()</code>
<div class="block">Method called when task is under clean up.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html#onWatermarkProgress-java.time.Instant-">onWatermarkProgress</a></span>(java.time.Instant&nbsp;watermark)</code>
<div class="block">Method called on watermark update.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>scala.PartialFunction&lt;java.lang.Object,scala.runtime.BoxedUnit&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html#receiveUnManagedMessage--">receiveUnManagedMessage</a></span>()</code>
<div class="block">Handlers unmanaged messages</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="onStart-java.time.Instant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onStart</h4>
<pre>void&nbsp;onStart(java.time.Instant&nbsp;startTime)</pre>
<div class="block">Method called with the task is initialized.</div>
<dl>
<dt><span class="paramLabel">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-org.apache.gearpump.Message-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onNext</h4>
<pre>void&nbsp;onNext(<a href="../../../../../org/apache/gearpump/Message.html" title="class in org.apache.gearpump">Message</a>&nbsp;msg)</pre>
<div class="block">Method called for each message received.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msg</code> - Message send by upstream tasks</dd>
</dl>
</li>
</ul>
<a name="onStop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onStop</h4>
<pre>void&nbsp;onStop()</pre>
<div class="block">Method called when task is under clean up.
<p>
This can be used to cleanup resource when the application finished.</div>
</li>
</ul>
<a name="receiveUnManagedMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receiveUnManagedMessage</h4>
<pre>scala.PartialFunction&lt;java.lang.Object,scala.runtime.BoxedUnit&gt;&nbsp;receiveUnManagedMessage()</pre>
<div class="block">Handlers unmanaged messages
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the handler</dd>
</dl>
</li>
</ul>
<a name="onWatermarkProgress-java.time.Instant-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onWatermarkProgress</h4>
<pre>void&nbsp;onWatermarkProgress(java.time.Instant&nbsp;watermark)</pre>
<div class="block">Method called on watermark update.
Usually safe to output or checkpoint states earlier than watermark.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>watermark</code> - represents event time progress.</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><a href="../../../../../org/apache/gearpump/streaming/task/TaskId.html" title="class in org.apache.gearpump.streaming.task"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/gearpump/streaming/task/TaskMessageSerializer.html" title="interface in org.apache.gearpump.streaming.task"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/gearpump/streaming/task/TaskInterface.html" target="_top">Frames</a></li>
<li><a href="TaskInterface.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>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 ======= -->
</body>
</html>