| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 --> |
| <title>Scheduler (Nemo Project 0.4 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-09"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Scheduler (Nemo Project 0.4 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.nemo.runtime.master.scheduler</a></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><code><a href="BatchScheduler.html" title="class in org.apache.nemo.runtime.master.scheduler">BatchScheduler</a></code>, <code><a href="SimulationScheduler.html" title="class in org.apache.nemo.runtime.master.scheduler">SimulationScheduler</a></code>, <code><a href="StreamingScheduler.html" title="class in org.apache.nemo.runtime.master.scheduler">StreamingScheduler</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Scheduler</span></pre> |
| <div class="block">Only two threads call scheduling code: RuntimeMaster thread (RMT), and SchedulerThread(ST). |
| RMT and ST meet only at two points: <a href="ExecutorRegistry.html" title="class in org.apache.nemo.runtime.master.scheduler"><code>ExecutorRegistry</code></a>, and <a href="PendingTaskCollectionPointer.html" title="class in org.apache.nemo.runtime.master.scheduler"><code>PendingTaskCollectionPointer</code></a>, |
| which are synchronized(ThreadSafe). |
| Other scheduler-related classes that are accessed by only one of the two threads are not synchronized(NotThreadSafe).</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onExecutorAdded(org.apache.nemo.runtime.master.resource.ExecutorRepresenter)">onExecutorAdded</a></span>​(<a href="../resource/ExecutorRepresenter.html" title="interface in org.apache.nemo.runtime.master.resource">ExecutorRepresenter</a> executorRepresenter)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onExecutorRemoved(java.lang.String)">onExecutorRemoved</a></span>​(java.lang.String executorId)</code></th> |
| <td class="colLast"> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onSpeculativeExecutionCheck()">onSpeculativeExecutionCheck</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Called to check for speculative execution.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onTaskStateReportFromExecutor(java.lang.String,java.lang.String,int,org.apache.nemo.runtime.common.state.TaskState.State,java.lang.String,org.apache.nemo.runtime.common.state.TaskState.RecoverableTaskFailureCause)">onTaskStateReportFromExecutor</a></span>​(java.lang.String executorId, |
| java.lang.String taskId, |
| int attemptIdx, |
| <a href="../../common/state/TaskState.State.html" title="enum in org.apache.nemo.runtime.common.state">TaskState.State</a> newState, |
| java.lang.String taskPutOnHold, |
| <a href="../../common/state/TaskState.RecoverableTaskFailureCause.html" title="enum in org.apache.nemo.runtime.common.state">TaskState.RecoverableTaskFailureCause</a> failureCause)</code></th> |
| <td class="colLast"> |
| <div class="block">Called when a Task's execution state changes.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#schedulePlan(org.apache.nemo.runtime.common.plan.PhysicalPlan,int)">schedulePlan</a></span>​(<a href="../../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a> physicalPlan, |
| int maxScheduleAttempt)</code></th> |
| <td class="colLast"> |
| <div class="block">Schedules the given plan.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#terminate()">terminate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">To be called when a job should be terminated.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updatePlan(org.apache.nemo.runtime.common.plan.PhysicalPlan)">updatePlan</a></span>​(<a href="../../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a> newPhysicalPlan)</code></th> |
| <td class="colLast"> |
| <div class="block">Receives and updates the scheduler with a new physical plan for a job.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="schedulePlan(org.apache.nemo.runtime.common.plan.PhysicalPlan,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schedulePlan</h4> |
| <pre class="methodSignature">void schedulePlan​(<a href="../../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a> physicalPlan, |
| int maxScheduleAttempt)</pre> |
| <div class="block">Schedules the given plan.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>physicalPlan</code> - the plan of the job being submitted.</dd> |
| <dd><code>maxScheduleAttempt</code> - the max number of times this plan/sub-part of the plan should be attempted.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="updatePlan(org.apache.nemo.runtime.common.plan.PhysicalPlan)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updatePlan</h4> |
| <pre class="methodSignature">void updatePlan​(<a href="../../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a> newPhysicalPlan)</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>newPhysicalPlan</code> - new physical plan for the job.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onExecutorAdded(org.apache.nemo.runtime.master.resource.ExecutorRepresenter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onExecutorAdded</h4> |
| <pre class="methodSignature">void onExecutorAdded​(<a href="../resource/ExecutorRepresenter.html" title="interface in org.apache.nemo.runtime.master.resource">ExecutorRepresenter</a> executorRepresenter)</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>executorRepresenter</code> - a representation of the added executor.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onExecutorRemoved(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onExecutorRemoved</h4> |
| <pre class="methodSignature">void onExecutorRemoved​(java.lang.String 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 id="onTaskStateReportFromExecutor(java.lang.String,java.lang.String,int,org.apache.nemo.runtime.common.state.TaskState.State,java.lang.String,org.apache.nemo.runtime.common.state.TaskState.RecoverableTaskFailureCause)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onTaskStateReportFromExecutor</h4> |
| <pre class="methodSignature">void onTaskStateReportFromExecutor​(java.lang.String executorId, |
| java.lang.String taskId, |
| int attemptIdx, |
| <a href="../../common/state/TaskState.State.html" title="enum in org.apache.nemo.runtime.common.state">TaskState.State</a> newState, |
| @Nullable |
| java.lang.String taskPutOnHold, |
| <a href="../../common/state/TaskState.RecoverableTaskFailureCause.html" title="enum in org.apache.nemo.runtime.common.state">TaskState.RecoverableTaskFailureCause</a> failureCause)</pre> |
| <div class="block">Called when a Task's execution state changes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executorId</code> - of the executor in which the Task is executing.</dd> |
| <dd><code>taskId</code> - of the Task whose state must be updated.</dd> |
| <dd><code>newState</code> - for the Task.</dd> |
| <dd><code>attemptIdx</code> - the number of times this Task 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 Task failed in the case of a recoverable failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onSpeculativeExecutionCheck()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onSpeculativeExecutionCheck</h4> |
| <pre class="methodSignature">void onSpeculativeExecutionCheck()</pre> |
| <div class="block">Called to check for speculative execution.</div> |
| </li> |
| </ul> |
| <a id="terminate()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>terminate</h4> |
| <pre class="methodSignature">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> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |