| <!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.7.0_67) on Thu Feb 04 13:28:41 CST 2016 --> |
| <title>Task</title> |
| <meta name="date" content="2016-02-04"> |
| <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="Task"; |
| } |
| //--> |
| </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/task/Subscription$.html" title="class in io.gearpump.streaming.task"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../io/gearpump/streaming/task/TaskActor.html" title="class in io.gearpump.streaming.task"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/task/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>Field | </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>Field | </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">io.gearpump.streaming.task</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>io.gearpump.streaming.task.Task</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> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../io/gearpump/streaming/sink/DataSinkTask.html" title="class in io.gearpump.streaming.sink">DataSinkTask</a>, <a href="../../../../io/gearpump/streaming/source/DataSourceTask.html" title="class in io.gearpump.streaming.source">DataSourceTask</a>, <a href="../../../../io/gearpump/streaming/dsl/plan/OpTranslator.GroupByTask.html" title="class in io.gearpump.streaming.dsl.plan">OpTranslator.GroupByTask</a>, <a href="../../../../io/gearpump/streaming/dsl/plan/OpTranslator.SinkTask.html" title="class in io.gearpump.streaming.dsl.plan">OpTranslator.SinkTask</a>, <a href="../../../../io/gearpump/streaming/dsl/plan/OpTranslator.SourceTask.html" title="class in io.gearpump.streaming.dsl.plan">OpTranslator.SourceTask</a>, <a href="../../../../io/gearpump/streaming/dsl/plan/OpTranslator.TransformTask.html" title="class in io.gearpump.streaming.dsl.plan">OpTranslator.TransformTask</a>, <a href="../../../../io/gearpump/streaming/state/api/PersistentTask.html" title="class in io.gearpump.streaming.state.api">PersistentTask</a>, <a href="../../../../io/gearpump/streaming/javaapi/Task.html" title="class in io.gearpump.streaming.javaapi">Task</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">Task</span> |
| extends java.lang.Object |
| implements <a href="../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></pre> |
| </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"> </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/task/Task.html#Task(io.gearpump.streaming.task.TaskContext,%20io.gearpump.cluster.UserConfig)">Task</a></strong>(<a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a> taskContext, |
| io.gearpump.cluster.UserConfig 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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </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>org.slf4j.Logger</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/Task.html#LOG()">LOG</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/Task.html#onNext(io.gearpump.Message)">onNext</a></strong>(io.gearpump.Message msg)</code> |
| <div class="block">Method called for each message received.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/Task.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> startTime)</code> |
| <div class="block">Method called with the task is initialized.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/Task.html#onStop()">onStop</a></strong>()</code> |
| <div class="block">Method called when task is under clean up.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit></code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/Task.html#receiveUnManagedMessage()">receiveUnManagedMessage</a></strong>()</code> |
| <div class="block">handler for unmanaged message</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/Task.html#self()">self</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected akka.actor.ActorRef</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/Task.html#sender()">sender</a></strong>()</code> |
| <div class="block">For managed message(type of Message), the sender mean nothing, |
| you should not use this directory</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected akka.actor.ActorSystem</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/task/Task.html#system()">system</a></strong>()</code> </td> |
| </tr> |
| </table> |
| <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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Task(io.gearpump.streaming.task.TaskContext, io.gearpump.cluster.UserConfig)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Task</h4> |
| <pre>public Task(<a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a> taskContext, |
| io.gearpump.cluster.UserConfig 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="LOG()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOG</h4> |
| <pre>public org.slf4j.Logger LOG()</pre> |
| </li> |
| </ul> |
| <a name="system()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>system</h4> |
| <pre>protected akka.actor.ActorSystem system()</pre> |
| </li> |
| </ul> |
| <a name="self()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>self</h4> |
| <pre>public akka.actor.ActorRef self()</pre> |
| </li> |
| </ul> |
| <a name="sender()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sender</h4> |
| <pre>protected akka.actor.ActorRef sender()</pre> |
| <div class="block">For managed message(type of Message), the sender mean nothing, |
| you should not use this directory |
| <p> |
| For unmanaged message, the sender represent the sender actor</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the sender</dd></dl> |
| </li> |
| </ul> |
| <a name="onStart(io.gearpump.streaming.task.StartTime)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onStart</h4> |
| <pre>public void onStart(<a href="../../../../io/gearpump/streaming/task/StartTime.html" title="class in io.gearpump.streaming.task">StartTime</a> startTime)</pre> |
| <div class="block"><strong>Description copied from interface: <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> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</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 void onNext(io.gearpump.Message msg)</pre> |
| <div class="block"><strong>Description copied from interface: <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> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></code></dd> |
| <dt><span class="strong">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>public void onStop()</pre> |
| <div class="block"><strong>Description copied from interface: <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> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="receiveUnManagedMessage()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>receiveUnManagedMessage</h4> |
| <pre>public scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receiveUnManagedMessage()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html#receiveUnManagedMessage()">TaskInterface</a></code></strong></div> |
| <div class="block">handler for unmanaged message</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html#receiveUnManagedMessage()">receiveUnManagedMessage</a></code> in interface <code><a href="../../../../io/gearpump/streaming/task/TaskInterface.html" title="interface in io.gearpump.streaming.task">TaskInterface</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the handler</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/task/Subscription$.html" title="class in io.gearpump.streaming.task"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../io/gearpump/streaming/task/TaskActor.html" title="class in io.gearpump.streaming.task"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/task/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>Field | </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>Field | </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> |
