blob: dbf89621a619c593ccefdd248707b6f6cdb7d2c9 [file] [log] [blame]
<!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_121) on Sun Jul 09 07:41:27 CEST 2017 -->
<title>JarScheduler</title>
<meta name="date" content="2017-07-09">
<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="JarScheduler";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="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="../../../../../org/apache/gearpump/streaming/appmaster/HistoryMetricsServiceSpec.html" title="class in org.apache.gearpump.streaming.appmaster"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ExecutorFailed.html" title="class in org.apache.gearpump.streaming.appmaster"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/gearpump/streaming/appmaster/JarScheduler.html" target="_top">Frames</a></li>
<li><a href="JarScheduler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">org.apache.gearpump.streaming.appmaster</div>
<h2 title="Class JarScheduler" class="title">Class JarScheduler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.gearpump.streaming.appmaster.JarScheduler</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">JarScheduler</span>
extends java.lang.Object</pre>
<div class="block">Different processors of the stream application can use different jars. JarScheduler is the
scheduler for different jars.
<p>
For a DAG of multiple processors, each processor can have its own jar. Tasks of same jar
is scheduled by TaskScheduler, and TaskSchedulers are scheduled by JarScheduler.
<p>
In runtime, the implementation is delegated to actor JarSchedulerImpl</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="memberSummary" 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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ExecutorFailed.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.ExecutorFailed</a></span></code>
<div class="block">Some executor JVM is dead, try to recover tasks that are located on failed executor</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ExecutorFailed$.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.ExecutorFailed$</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.GetResourceRequestDetails$.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.GetResourceRequestDetails$</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.JarSchedulerImpl.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.JarSchedulerImpl</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.NewDag.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.NewDag</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.NewDag$.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.NewDag$</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ResourceRequestDetail.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.ResourceRequestDetail</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ResourceRequestDetail$.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.ResourceRequestDetail$</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ScheduleTask.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.ScheduleTask</a></span></code>
<div class="block">Schedule tasks for one appJar.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ScheduleTask$.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.ScheduleTask$</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.TransitToNewDag$.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.TransitToNewDag$</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.html#JarScheduler-int-java.lang.String-com.typesafe.config.Config-akka.actor.ActorRefFactory-">JarScheduler</a></span>(int&nbsp;appId,
java.lang.String&nbsp;appName,
com.typesafe.config.Config&nbsp;config,
akka.actor.ActorRefFactory&nbsp;factory)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>scala.concurrent.Future&lt;scala.Option&lt;<a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ResourceRequestDetail.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.ResourceRequestDetail</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.html#executorFailed-int-">executorFailed</a></span>(int&nbsp;executorId)</code>
<div class="block">Some executor JVM process is dead.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>scala.concurrent.Future&lt;<a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ResourceRequestDetail.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.ResourceRequestDetail</a>[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.html#getResourceRequestDetails--">getResourceRequestDetails</a></span>()</code>
<div class="block">AppMaster ask JarScheduler about how many resource it wants</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>scala.concurrent.Future&lt;scala.collection.immutable.List&lt;<a href="../../../../../org/apache/gearpump/streaming/task/TaskId.html" title="class in org.apache.gearpump.streaming.task">TaskId</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.html#scheduleTask-org.apache.gearpump.cluster.AppJar-org.apache.gearpump.cluster.worker.WorkerId-int-org.apache.gearpump.cluster.scheduler.Resource-">scheduleTask</a></span>(<a href="../../../../../org/apache/gearpump/cluster/AppJar.html" title="class in org.apache.gearpump.cluster">AppJar</a>&nbsp;appJar,
<a href="../../../../../org/apache/gearpump/cluster/worker/WorkerId.html" title="class in org.apache.gearpump.cluster.worker">WorkerId</a>&nbsp;workerId,
int&nbsp;executorId,
<a href="../../../../../org/apache/gearpump/cluster/scheduler/Resource.html" title="class in org.apache.gearpump.cluster.scheduler">Resource</a>&nbsp;resource)</code>
<div class="block">AppMaster has resource allocated, and ask the jar scheduler to schedule tasks
for this executor.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.html#setDag-org.apache.gearpump.streaming.DAG-scala.concurrent.Future-">setDag</a></span>(<a href="../../../../../org/apache/gearpump/streaming/DAG.html" title="class in org.apache.gearpump.streaming">DAG</a>&nbsp;dag,
scala.concurrent.Future&lt;java.lang.Object&gt;&nbsp;startClock)</code>
<div class="block">Set the current DAG version active</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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="JarScheduler-int-java.lang.String-com.typesafe.config.Config-akka.actor.ActorRefFactory-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JarScheduler</h4>
<pre>public&nbsp;JarScheduler(int&nbsp;appId,
java.lang.String&nbsp;appName,
com.typesafe.config.Config&nbsp;config,
akka.actor.ActorRefFactory&nbsp;factory)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setDag-org.apache.gearpump.streaming.DAG-scala.concurrent.Future-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDag</h4>
<pre>public&nbsp;void&nbsp;setDag(<a href="../../../../../org/apache/gearpump/streaming/DAG.html" title="class in org.apache.gearpump.streaming">DAG</a>&nbsp;dag,
scala.concurrent.Future&lt;java.lang.Object&gt;&nbsp;startClock)</pre>
<div class="block">Set the current DAG version active</div>
</li>
</ul>
<a name="getResourceRequestDetails--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceRequestDetails</h4>
<pre>public&nbsp;scala.concurrent.Future&lt;<a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ResourceRequestDetail.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.ResourceRequestDetail</a>[]&gt;&nbsp;getResourceRequestDetails()</pre>
<div class="block">AppMaster ask JarScheduler about how many resource it wants</div>
</li>
</ul>
<a name="scheduleTask-org.apache.gearpump.cluster.AppJar-org.apache.gearpump.cluster.worker.WorkerId-int-org.apache.gearpump.cluster.scheduler.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduleTask</h4>
<pre>public&nbsp;scala.concurrent.Future&lt;scala.collection.immutable.List&lt;<a href="../../../../../org/apache/gearpump/streaming/task/TaskId.html" title="class in org.apache.gearpump.streaming.task">TaskId</a>&gt;&gt;&nbsp;scheduleTask(<a href="../../../../../org/apache/gearpump/cluster/AppJar.html" title="class in org.apache.gearpump.cluster">AppJar</a>&nbsp;appJar,
<a href="../../../../../org/apache/gearpump/cluster/worker/WorkerId.html" title="class in org.apache.gearpump.cluster.worker">WorkerId</a>&nbsp;workerId,
int&nbsp;executorId,
<a href="../../../../../org/apache/gearpump/cluster/scheduler/Resource.html" title="class in org.apache.gearpump.cluster.scheduler">Resource</a>&nbsp;resource)</pre>
<div class="block">AppMaster has resource allocated, and ask the jar scheduler to schedule tasks
for this executor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>appJar</code> - (undocumented)</dd>
<dd><code>workerId</code> - (undocumented)</dd>
<dd><code>executorId</code> - (undocumented)</dd>
<dd><code>resource</code> - (undocumented)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="executorFailed-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>executorFailed</h4>
<pre>public&nbsp;scala.concurrent.Future&lt;scala.Option&lt;<a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ResourceRequestDetail.html" title="class in org.apache.gearpump.streaming.appmaster">JarScheduler.ResourceRequestDetail</a>&gt;&gt;&nbsp;executorFailed(int&nbsp;executorId)</pre>
<div class="block">Some executor JVM process is dead. AppMaster asks jar scheduler to re-schedule the impacted
tasks.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>executorId</code> - (undocumented)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</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>
<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="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="../../../../../org/apache/gearpump/streaming/appmaster/HistoryMetricsServiceSpec.html" title="class in org.apache.gearpump.streaming.appmaster"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/gearpump/streaming/appmaster/JarScheduler.ExecutorFailed.html" title="class in org.apache.gearpump.streaming.appmaster"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/gearpump/streaming/appmaster/JarScheduler.html" target="_top">Frames</a></li>
<li><a href="JarScheduler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>