| <!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 Dec 29 00:09:29 CST 2015 --> |
| <title>DataSourceTask</title> |
| <meta name="date" content="2015-12-29"> |
| <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="DataSourceTask"; |
| } |
| //--> |
| </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/source/DataSourceProcessor$.html" title="class in io.gearpump.streaming.source"><span class="strong">PREV CLASS</span></a></li> |
| <li><a href="../../../../io/gearpump/streaming/source/DataSourceTask$.html" title="class in io.gearpump.streaming.source"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/source/DataSourceTask.html" target="_top">FRAMES</a></li> |
| <li><a href="DataSourceTask.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"> |
| <p class="subTitle">io.gearpump.streaming.source</p> |
| <h2 title="Class DataSourceTask" class="title">Class DataSourceTask</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.source.DataSourceTask</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 class <strong>DataSourceTask</strong> |
| extends <a href="../../../../io/gearpump/streaming/task/Task.html" title="class in io.gearpump.streaming.task">Task</a></pre> |
| <div class="block">general task that runs any <a href="../../../../io/gearpump/streaming/source/DataSource.html" title="interface in io.gearpump.streaming.source"><code>DataSource</code></a> |
| see <a href="../../../../io/gearpump/streaming/source/DataSourceProcessor.html" title="class in io.gearpump.streaming.source"><code>DataSourceProcessor</code></a> for its usage |
| <p> |
| DataSourceTask calls |
| - <code>DataSource.open</code> in <code>onStart</code> and pass in <a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task"><code>TaskContext</code></a> and application start time |
| - <code>DataSource.read</code> in each <code>onNext</code>, which reads a batch of messages whose size are defined by |
| <code>gearpump.source.read.batch.size</code>. |
| - <code>DataSource.close</code> in <code>onStop</code></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"> </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/source/DataSourceTask.html#DataSourceTask(io.gearpump.streaming.task.TaskContext, io.gearpump.cluster.UserConfig)">DataSourceTask</a></strong>(<a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a> context, |
| io.gearpump.cluster.UserConfig conf)</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>static java.lang.String</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/source/DataSourceTask.html#DATA_SOURCE()">DATA_SOURCE</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/source/DataSourceTask.html#onNext(io.gearpump.Message)">onNext</a></strong>(io.gearpump.Message message)</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/source/DataSourceTask.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> newStartTime)</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/source/DataSourceTask.html#onStop()">onStop</a></strong>()</code> |
| <div class="block">Method called when task is under clean up.</div> |
| </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 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 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="DataSourceTask(io.gearpump.streaming.task.TaskContext, io.gearpump.cluster.UserConfig)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DataSourceTask</h4> |
| <pre>public DataSourceTask(<a href="../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a> context, |
| io.gearpump.cluster.UserConfig 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="DATA_SOURCE()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DATA_SOURCE</h4> |
| <pre>public static java.lang.String DATA_SOURCE()</pre> |
| </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> newStartTime)</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><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/Task.html#onStart(io.gearpump.streaming.task.StartTime)">onStart</a></code> in class <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>newStartTime</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 message)</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><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/Task.html#onNext(io.gearpump.Message)">onNext</a></code> in class <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 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> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../io/gearpump/streaming/task/Task.html#onStop()">onStop</a></code> in class <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/source/DataSourceProcessor$.html" title="class in io.gearpump.streaming.source"><span class="strong">PREV CLASS</span></a></li> |
| <li><a href="../../../../io/gearpump/streaming/source/DataSourceTask$.html" title="class in io.gearpump.streaming.source"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/source/DataSourceTask.html" target="_top">FRAMES</a></li> |
| <li><a href="DataSourceTask.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> |