| <!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_25) on Thu Aug 11 09:54:09 PDT 2016 --> |
| <title>Task</title> |
| <meta name="date" content="2016-08-11"> |
| <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="Task"; |
| } |
| } |
| 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="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/javaapi/StreamApplication.html" title="class in org.apache.gearpump.streaming.javaapi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/gearpump/streaming/javaapi/Task.html" target="_top">Frames</a></li> |
| <li><a href="Task.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.gearpump.streaming.javaapi</div> |
| <h2 title="Class Task" class="title">Class Task</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">org.apache.gearpump.streaming.task.Task</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.gearpump.streaming.javaapi.Task</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html" title="interface in org.apache.gearpump.streaming.task">TaskInterface</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Task</span> |
| extends <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a></pre> |
| <div class="block">Java version of Task. |
| |
| See <a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task"><code>Task</code></a></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/gearpump/streaming/task/TaskContext.html" title="interface in org.apache.gearpump.streaming.task">TaskContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Task.html#context">context</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Task.html#userConf">userConf</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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/gearpump/streaming/javaapi/Task.html#Task-org.apache.gearpump.streaming.task.TaskContext-org.apache.gearpump.cluster.UserConfig-">Task</a></span>(<a href="../../../../../org/apache/gearpump/streaming/task/TaskContext.html" title="interface in org.apache.gearpump.streaming.task">TaskContext</a> taskContext, |
| <a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a> userConf)</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="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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Task.html#onNext-org.apache.gearpump.Message-">onNext</a></span>(<a href="../../../../../org/apache/gearpump/Message.html" title="class in org.apache.gearpump">Message</a> 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/javaapi/Task.html#onStart-org.apache.gearpump.streaming.task.StartTime-">onStart</a></span>(<a href="../../../../../org/apache/gearpump/streaming/task/StartTime.html" title="class in org.apache.gearpump.streaming.task">StartTime</a> 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/javaapi/Task.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>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/javaapi/Task.html#self--">self</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.gearpump.streaming.task.Task"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.gearpump.streaming.task.<a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a></h3> |
| <code><a href="../../../../../org/apache/gearpump/streaming/task/Task.html#LOG--">LOG</a>, <a href="../../../../../org/apache/gearpump/streaming/task/Task.html#receiveUnManagedMessage--">receiveUnManagedMessage</a>, <a href="../../../../../org/apache/gearpump/streaming/task/Task.html#sender--">sender</a>, <a href="../../../../../org/apache/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 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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="context"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>context</h4> |
| <pre>protected <a href="../../../../../org/apache/gearpump/streaming/task/TaskContext.html" title="interface in org.apache.gearpump.streaming.task">TaskContext</a> context</pre> |
| </li> |
| </ul> |
| <a name="userConf"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>userConf</h4> |
| <pre>protected <a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a> userConf</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Task-org.apache.gearpump.streaming.task.TaskContext-org.apache.gearpump.cluster.UserConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Task</h4> |
| <pre>public Task(<a href="../../../../../org/apache/gearpump/streaming/task/TaskContext.html" title="interface in org.apache.gearpump.streaming.task">TaskContext</a> taskContext, |
| <a href="../../../../../org/apache/gearpump/cluster/UserConfig.html" title="class in org.apache.gearpump.cluster">UserConfig</a> userConf)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="self--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>self</h4> |
| <pre>public final akka.actor.ActorRef self()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/gearpump/streaming/task/Task.html#self--">self</a></code> in class <code><a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onStart-org.apache.gearpump.streaming.task.StartTime-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onStart</h4> |
| <pre>public void onStart(<a href="../../../../../org/apache/gearpump/streaming/task/StartTime.html" title="class in org.apache.gearpump.streaming.task">StartTime</a> startTime)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html#onStart-org.apache.gearpump.streaming.task.StartTime-">TaskInterface</a></code></span></div> |
| <div class="block">Method called with the task is initialized.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html#onStart-org.apache.gearpump.streaming.task.StartTime-">onStart</a></code> in interface <code><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html" title="interface in org.apache.gearpump.streaming.task">TaskInterface</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/gearpump/streaming/task/Task.html#onStart-org.apache.gearpump.streaming.task.StartTime-">onStart</a></code> in class <code><a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a></code></dd> |
| <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>public void onNext(<a href="../../../../../org/apache/gearpump/Message.html" title="class in org.apache.gearpump">Message</a> msg)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html#onNext-org.apache.gearpump.Message-">TaskInterface</a></code></span></div> |
| <div class="block">Method called for each message received. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html#onNext-org.apache.gearpump.Message-">onNext</a></code> in interface <code><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html" title="interface in org.apache.gearpump.streaming.task">TaskInterface</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/gearpump/streaming/task/Task.html#onNext-org.apache.gearpump.Message-">onNext</a></code> in class <code><a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.gearpump.streaming.task">Task</a></code></dd> |
| <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="blockListLast"> |
| <li class="blockList"> |
| <h4>onStop</h4> |
| <pre>public void onStop()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html#onStop--">TaskInterface</a></code></span></div> |
| <div class="block">Method called when task is under clean up. |
| <p> |
| This can be used to cleanup resource when the application finished.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html#onStop--">onStop</a></code> in interface <code><a href="../../../../../org/apache/gearpump/streaming/task/TaskInterface.html" title="interface in org.apache.gearpump.streaming.task">TaskInterface</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/gearpump/streaming/task/Task.html#onStop--">onStop</a></code> in class <code><a href="../../../../../org/apache/gearpump/streaming/task/Task.html" title="class in org.apache.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> |
| <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/javaapi/StreamApplication.html" title="class in org.apache.gearpump.streaming.javaapi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/gearpump/streaming/javaapi/Task.html" target="_top">Frames</a></li> |
| <li><a href="Task.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |