| <!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:42 CST 2016 --> |
| <title>TaskScheduler</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="TaskScheduler"; |
| } |
| //--> |
| </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/appmaster/TaskRegistry$.html" title="class in io.gearpump.streaming.appmaster"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../io/gearpump/streaming/appmaster/TaskScheduler.Location.html" title="class in io.gearpump.streaming.appmaster"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/appmaster/TaskScheduler.html" target="_top">Frames</a></li> |
| <li><a href="TaskScheduler.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.appmaster</div> |
| <h2 title="Interface TaskScheduler" class="title">Interface TaskScheduler</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../io/gearpump/streaming/appmaster/TaskSchedulerImpl.html" title="class in io.gearpump.streaming.appmaster">TaskSchedulerImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">TaskScheduler</span></pre> |
| <div class="block">This schedules tasks to run for new allocated resources.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/appmaster/TaskScheduler.Location.html" title="class in io.gearpump.streaming.appmaster">TaskScheduler.Location</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/appmaster/TaskScheduler.Location$.html" title="class in io.gearpump.streaming.appmaster">TaskScheduler.Location$</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/appmaster/TaskScheduler.TaskStatus.html" title="class in io.gearpump.streaming.appmaster">TaskScheduler.TaskStatus</a></strong></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>io.gearpump.cluster.scheduler.ResourceRequest[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/appmaster/TaskScheduler.html#executorFailed(int)">executorFailed</a></strong>(int executorId)</code> |
| <div class="block">This notify the scheduler that {executorId} is failed, and expect a set of |
| ResourceRequest for all failed tasks on that executor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>io.gearpump.cluster.scheduler.ResourceRequest[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/appmaster/TaskScheduler.html#getResourceRequests()">getResourceRequests</a></strong>()</code> |
| <div class="block">Get the resource requirements for all unscheduled tasks.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>scala.collection.immutable.List<<a href="../../../../io/gearpump/streaming/task/TaskId.html" title="class in io.gearpump.streaming.task">TaskId</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/appmaster/TaskScheduler.html#schedule(int,%20int,%20io.gearpump.cluster.scheduler.Resource)">schedule</a></strong>(int workerId, |
| int executorId, |
| io.gearpump.cluster.scheduler.Resource resource)</code> |
| <div class="block">This notify the scheduler that a resource slot on {workerId} and {executorId} is allocated, and |
| expect a task to be scheduled in return.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>scala.collection.immutable.List<<a href="../../../../io/gearpump/streaming/task/TaskId.html" title="class in io.gearpump.streaming.task">TaskId</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/appmaster/TaskScheduler.html#scheduledTasks(int)">scheduledTasks</a></strong>(int executorId)</code> |
| <div class="block">Query the task list that already scheduled on the executor</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/appmaster/TaskScheduler.html#setDAG(io.gearpump.streaming.DAG)">setDAG</a></strong>(<a href="../../../../io/gearpump/streaming/DAG.html" title="class in io.gearpump.streaming">DAG</a> dag)</code> |
| <div class="block">This notify the scheduler that the task DAG is created.</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="setDAG(io.gearpump.streaming.DAG)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDAG</h4> |
| <pre>void setDAG(<a href="../../../../io/gearpump/streaming/DAG.html" title="class in io.gearpump.streaming">DAG</a> dag)</pre> |
| <div class="block">This notify the scheduler that the task DAG is created.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>dag</code> - task dag</dd></dl> |
| </li> |
| </ul> |
| <a name="getResourceRequests()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResourceRequests</h4> |
| <pre>io.gearpump.cluster.scheduler.ResourceRequest[] getResourceRequests()</pre> |
| <div class="block">Get the resource requirements for all unscheduled tasks.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> |
| </li> |
| </ul> |
| <a name="schedule(int, int, io.gearpump.cluster.scheduler.Resource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schedule</h4> |
| <pre>scala.collection.immutable.List<<a href="../../../../io/gearpump/streaming/task/TaskId.html" title="class in io.gearpump.streaming.task">TaskId</a>> schedule(int workerId, |
| int executorId, |
| io.gearpump.cluster.scheduler.Resource resource)</pre> |
| <div class="block">This notify the scheduler that a resource slot on {workerId} and {executorId} is allocated, and |
| expect a task to be scheduled in return. |
| Task locality should be considered when deciding whether to offer a task on target {worker} |
| and {executor} |
| <p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>workerId</code> - which worker this resource is located.</dd><dd><code>executorId</code> - which executorId this resource belongs to.</dd><dd><code>resource</code> - (undocumented)</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a list of tasks</dd></dl> |
| </li> |
| </ul> |
| <a name="executorFailed(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executorFailed</h4> |
| <pre>io.gearpump.cluster.scheduler.ResourceRequest[] executorFailed(int executorId)</pre> |
| <div class="block">This notify the scheduler that {executorId} is failed, and expect a set of |
| ResourceRequest for all failed tasks on that executor. |
| <p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>executorId</code> - executor that failed</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>resource requests of the failed executor</dd></dl> |
| </li> |
| </ul> |
| <a name="scheduledTasks(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>scheduledTasks</h4> |
| <pre>scala.collection.immutable.List<<a href="../../../../io/gearpump/streaming/task/TaskId.html" title="class in io.gearpump.streaming.task">TaskId</a>> scheduledTasks(int executorId)</pre> |
| <div class="block">Query the task list that already scheduled on the executor |
| <p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>executorId</code> - executor to query</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a list of tasks</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/appmaster/TaskRegistry$.html" title="class in io.gearpump.streaming.appmaster"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../io/gearpump/streaming/appmaster/TaskScheduler.Location.html" title="class in io.gearpump.streaming.appmaster"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?io/gearpump/streaming/appmaster/TaskScheduler.html" target="_top">Frames</a></li> |
| <li><a href="TaskScheduler.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |