| <!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_162) on Thu Feb 01 21:39:10 KST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Scheduler (Coral Project 0.1-SNAPSHOT API)</title> |
| <meta name="date" content="2018-02-01"> |
| <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="Scheduler (Coral Project 0.1-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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="class-use/Scheduler.html">Use</a></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="../../../../../../edu/snu/coral/runtime/master/scheduler/RoundRobinSchedulingPolicy.html" title="class in edu.snu.coral.runtime.master.scheduler"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../edu/snu/coral/runtime/master/scheduler/SchedulerRunner.html" title="class in edu.snu.coral.runtime.master.scheduler"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?edu/snu/coral/runtime/master/scheduler/Scheduler.html" target="_top">Frames</a></li> |
| <li><a href="Scheduler.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>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">edu.snu.coral.runtime.master.scheduler</div> |
| <h2 title="Interface Scheduler" class="title">Interface Scheduler</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../edu/snu/coral/runtime/master/scheduler/BatchSingleJobScheduler.html" title="class in edu.snu.coral.runtime.master.scheduler">BatchSingleJobScheduler</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@DefaultImplementation(value=<a href="../../../../../../edu/snu/coral/runtime/master/scheduler/BatchSingleJobScheduler.html" title="class in edu.snu.coral.runtime.master.scheduler">BatchSingleJobScheduler.class</a>) |
| public interface <span class="typeNameLabel">Scheduler</span></pre> |
| <div class="block">Receives jobs to execute and schedules |
| <a href="../../../../../../edu/snu/coral/runtime/common/plan/physical/ScheduledTaskGroup.html" title="class in edu.snu.coral.runtime.common.plan.physical"><code>ScheduledTaskGroup</code></a> to executors.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../../../../../edu/snu/coral/runtime/master/scheduler/Scheduler.html#onExecutorAdded-java.lang.String-">onExecutorAdded</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> executorId)</code> |
| <div class="block">Called when an executor is added to Runtime, so that the extra resource can be used to execute the job.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/master/scheduler/Scheduler.html#onExecutorRemoved-java.lang.String-">onExecutorRemoved</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> executorId)</code> |
| <div class="block">Called when an executor is removed from Runtime, so that faults related to the removal can be handled.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/master/scheduler/Scheduler.html#onTaskGroupStateChanged-java.lang.String-java.lang.String-edu.snu.coral.runtime.common.state.TaskGroupState.State-int-java.lang.String-edu.snu.coral.runtime.common.state.TaskGroupState.RecoverableFailureCause-">onTaskGroupStateChanged</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> executorId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> taskGroupId, |
| <a href="../../../../../../edu/snu/coral/runtime/common/state/TaskGroupState.State.html" title="enum in edu.snu.coral.runtime.common.state">TaskGroupState.State</a> newState, |
| int attemptIdx, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> taskPutOnHold, |
| <a href="../../../../../../edu/snu/coral/runtime/common/state/TaskGroupState.RecoverableFailureCause.html" title="enum in edu.snu.coral.runtime.common.state">TaskGroupState.RecoverableFailureCause</a> failureCause)</code> |
| <div class="block">Called when a TaskGroup's execution state changes.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/master/scheduler/Scheduler.html#scheduleJob-edu.snu.coral.runtime.common.plan.physical.PhysicalPlan-edu.snu.coral.runtime.master.JobStateManager-">scheduleJob</a></span>(<a href="../../../../../../edu/snu/coral/runtime/common/plan/physical/PhysicalPlan.html" title="class in edu.snu.coral.runtime.common.plan.physical">PhysicalPlan</a> physicalPlan, |
| <a href="../../../../../../edu/snu/coral/runtime/master/JobStateManager.html" title="class in edu.snu.coral.runtime.master">JobStateManager</a> jobStateManager)</code> |
| <div class="block">Schedules the given job.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/master/scheduler/Scheduler.html#terminate--">terminate</a></span>()</code> |
| <div class="block">To be called when a job should be terminated.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/snu/coral/runtime/master/scheduler/Scheduler.html#updateJob-java.lang.String-edu.snu.coral.runtime.common.plan.physical.PhysicalPlan-edu.snu.coral.common.Pair-">updateJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jobId, |
| <a href="../../../../../../edu/snu/coral/runtime/common/plan/physical/PhysicalPlan.html" title="class in edu.snu.coral.runtime.common.plan.physical">PhysicalPlan</a> newPhysicalPlan, |
| <a href="../../../../../../edu/snu/coral/common/Pair.html" title="class in edu.snu.coral.common">Pair</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> taskInfo)</code> |
| <div class="block">Receives and updates the scheduler with a new physical plan for a job.</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="scheduleJob-edu.snu.coral.runtime.common.plan.physical.PhysicalPlan-edu.snu.coral.runtime.master.JobStateManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scheduleJob</h4> |
| <pre>void scheduleJob(<a href="../../../../../../edu/snu/coral/runtime/common/plan/physical/PhysicalPlan.html" title="class in edu.snu.coral.runtime.common.plan.physical">PhysicalPlan</a> physicalPlan, |
| <a href="../../../../../../edu/snu/coral/runtime/master/JobStateManager.html" title="class in edu.snu.coral.runtime.master">JobStateManager</a> jobStateManager)</pre> |
| <div class="block">Schedules the given job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>physicalPlan</code> - of the job being submitted.</dd> |
| <dd><code>jobStateManager</code> - to manage the states of the submitted job.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateJob-java.lang.String-edu.snu.coral.runtime.common.plan.physical.PhysicalPlan-edu.snu.coral.common.Pair-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateJob</h4> |
| <pre>void updateJob(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jobId, |
| <a href="../../../../../../edu/snu/coral/runtime/common/plan/physical/PhysicalPlan.html" title="class in edu.snu.coral.runtime.common.plan.physical">PhysicalPlan</a> newPhysicalPlan, |
| <a href="../../../../../../edu/snu/coral/common/Pair.html" title="class in edu.snu.coral.common">Pair</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> taskInfo)</pre> |
| <div class="block">Receives and updates the scheduler with a new physical plan for a job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jobId</code> - the ID of the job to change the physical plan.</dd> |
| <dd><code>newPhysicalPlan</code> - new physical plan for the job.</dd> |
| <dd><code>taskInfo</code> - pair containing the information of the executor id and task group id to mark as complete after the |
| update.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onExecutorAdded-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onExecutorAdded</h4> |
| <pre>void onExecutorAdded(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> executorId)</pre> |
| <div class="block">Called when an executor is added to Runtime, so that the extra resource can be used to execute the job.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executorId</code> - of the executor that has been added.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onExecutorRemoved-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onExecutorRemoved</h4> |
| <pre>void onExecutorRemoved(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> executorId)</pre> |
| <div class="block">Called when an executor is removed from Runtime, so that faults related to the removal can be handled.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executorId</code> - of the executor that has been removed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onTaskGroupStateChanged-java.lang.String-java.lang.String-edu.snu.coral.runtime.common.state.TaskGroupState.State-int-java.lang.String-edu.snu.coral.runtime.common.state.TaskGroupState.RecoverableFailureCause-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onTaskGroupStateChanged</h4> |
| <pre>void onTaskGroupStateChanged(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> executorId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> taskGroupId, |
| <a href="../../../../../../edu/snu/coral/runtime/common/state/TaskGroupState.State.html" title="enum in edu.snu.coral.runtime.common.state">TaskGroupState.State</a> newState, |
| int attemptIdx, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> taskPutOnHold, |
| <a href="../../../../../../edu/snu/coral/runtime/common/state/TaskGroupState.RecoverableFailureCause.html" title="enum in edu.snu.coral.runtime.common.state">TaskGroupState.RecoverableFailureCause</a> failureCause)</pre> |
| <div class="block">Called when a TaskGroup's execution state changes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executorId</code> - of the executor in which the TaskGroup is executing.</dd> |
| <dd><code>taskGroupId</code> - of the TaskGroup whose state must be updated.</dd> |
| <dd><code>newState</code> - for the TaskGroup.</dd> |
| <dd><code>attemptIdx</code> - the number of times this TaskGroup has executed. |
| the below parameters are only valid for failures *****************</dd> |
| <dd><code>taskPutOnHold</code> - the ID of task that are put on hold. It is null otherwise.</dd> |
| <dd><code>failureCause</code> - for which the TaskGroup failed in the case of a recoverable failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="terminate--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>terminate</h4> |
| <pre>void terminate()</pre> |
| <div class="block">To be called when a job should be terminated. |
| Any clean up code should be implemented in this method.</div> |
| </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="class-use/Scheduler.html">Use</a></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="../../../../../../edu/snu/coral/runtime/master/scheduler/RoundRobinSchedulingPolicy.html" title="class in edu.snu.coral.runtime.master.scheduler"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../edu/snu/coral/runtime/master/scheduler/SchedulerRunner.html" title="class in edu.snu.coral.runtime.master.scheduler"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?edu/snu/coral/runtime/master/scheduler/Scheduler.html" target="_top">Frames</a></li> |
| <li><a href="Scheduler.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>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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2018. All rights reserved.</small></p> |
| </body> |
| </html> |
