| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>NodeSorterHostProximity (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.scheduler.resource.strategies.scheduling.sorter, class: NodeSorterHostProximity"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/NodeSorterHostProximity.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.scheduler.resource.strategies.scheduling.sorter</a></div> |
| <h1 title="Class NodeSorterHostProximity" class="title">Class NodeSorterHostProximity</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.storm.scheduler.resource.strategies.scheduling.sorter.NodeSorterHostProximity</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">INodeSorter</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">NodeSorterHostProximity</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">INodeSorter</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="NodeSorterHostProximity.ExistingScheduleFunc.html" class="type-name-link" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">NodeSorterHostProximity.ExistingScheduleFunc</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">interface for calculating the number of existing executors scheduled on a object (rack or node).</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="../../../../Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#cluster" class="member-name-link">cluster</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#favoredNodeIds" class="member-name-link">favoredNodeIds</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#greyListedSupervisorIds" class="member-name-link">greyListedSupervisorIds</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="../BaseResourceAwareStrategy.NodeSortType.html" title="enum in org.apache.storm.scheduler.resource.strategies.scheduling">BaseResourceAwareStrategy.NodeSortType</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#nodeSortType" class="member-name-link">nodeSortType</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="../../../../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#topologyDetails" class="member-name-link">topologyDetails</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#unFavoredNodeIds" class="member-name-link">unFavoredNodeIds</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.scheduler.Cluster,org.apache.storm.scheduler.TopologyDetails)" class="member-name-link">NodeSorterHostProximity</a><wbr>(<a href="../../../../Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a> cluster, |
| <a href="../../../../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topologyDetails)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.scheduler.Cluster,org.apache.storm.scheduler.TopologyDetails,org.apache.storm.scheduler.resource.strategies.scheduling.BaseResourceAwareStrategy.NodeSortType)" class="member-name-link">NodeSorterHostProximity</a><wbr>(<a href="../../../../Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a> cluster, |
| <a href="../../../../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topologyDetails, |
| <a href="../BaseResourceAwareStrategy.NodeSortType.html" title="enum in org.apache.storm.scheduler.resource.strategies.scheduling">BaseResourceAwareStrategy.NodeSortType</a> nodeSortType)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Initialize for the default implementation node sorting.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRackIdToHosts()" class="member-name-link">getRackIdToHosts</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicInteger.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicInteger</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScheduledExecCntByRackId()" class="member-name-link">getScheduledExecCntByRackId</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSortedRacks()" class="member-name-link">getSortedRacks</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Racks are sorted by two criteria.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../../RasNode.html" title="class in org.apache.storm.scheduler.resource">RasNode</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hostnameToNodes(java.lang.String)" class="member-name-link">hostnameToNodes</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> hostname)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">hostname to Ids.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#makeHostToNodeIds(java.util.List)" class="member-name-link">makeHostToNodeIds</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> hosts)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#prepare(org.apache.storm.scheduler.ExecutorDetails)" class="member-name-link">prepare</a><wbr>(<a href="../../../../ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a> exec)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prepare for node sorting.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sortAllNodes()" class="member-name-link">sortAllNodes</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sortObjectResources(org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesSummary,org.apache.storm.scheduler.ExecutorDetails,org.apache.storm.scheduler.resource.strategies.scheduling.sorter.NodeSorterHostProximity.ExistingScheduleFunc)" class="member-name-link">sortObjectResources</a><wbr>(<a href="../ObjectResourcesSummary.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesSummary</a> resourcesSummary, |
| <a href="../../../../ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a> exec, |
| <a href="NodeSorterHostProximity.ExistingScheduleFunc.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">NodeSorterHostProximity.ExistingScheduleFunc</a> existingScheduleFunc)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Scheduling uses <a href="#sortAllNodes()"><code>sortAllNodes()</code></a> which eventually |
| calls this method whose behavior can be altered by setting <a href="#nodeSortType"><code>nodeSortType</code></a>.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="nodeSortType"> |
| <h3>nodeSortType</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../BaseResourceAwareStrategy.NodeSortType.html" title="enum in org.apache.storm.scheduler.resource.strategies.scheduling">BaseResourceAwareStrategy.NodeSortType</a></span> <span class="element-name">nodeSortType</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cluster"> |
| <h3>cluster</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../../../Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a></span> <span class="element-name">cluster</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="topologyDetails"> |
| <h3>topologyDetails</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../../../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a></span> <span class="element-name">topologyDetails</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="greyListedSupervisorIds"> |
| <h3>greyListedSupervisorIds</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">greyListedSupervisorIds</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="favoredNodeIds"> |
| <h3>favoredNodeIds</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">favoredNodeIds</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unFavoredNodeIds"> |
| <h3>unFavoredNodeIds</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">unFavoredNodeIds</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.storm.scheduler.Cluster,org.apache.storm.scheduler.TopologyDetails)"> |
| <h3>NodeSorterHostProximity</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">NodeSorterHostProximity</span><wbr><span class="parameters">(<a href="../../../../Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a> cluster, |
| <a href="../../../../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topologyDetails)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.storm.scheduler.Cluster,org.apache.storm.scheduler.TopologyDetails,org.apache.storm.scheduler.resource.strategies.scheduling.BaseResourceAwareStrategy.NodeSortType)"> |
| <h3>NodeSorterHostProximity</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">NodeSorterHostProximity</span><wbr><span class="parameters">(<a href="../../../../Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a> cluster, |
| <a href="../../../../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topologyDetails, |
| <a href="../BaseResourceAwareStrategy.NodeSortType.html" title="enum in org.apache.storm.scheduler.resource.strategies.scheduling">BaseResourceAwareStrategy.NodeSortType</a> nodeSortType)</span></div> |
| <div class="block">Initialize for the default implementation node sorting.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cluster</code> - for which nodes will be sorted.</dd> |
| <dd><code>topologyDetails</code> - the topology to sort for.</dd> |
| <dd><code>nodeSortType</code> - type of sorting to be applied to object resource collection <a href="../BaseResourceAwareStrategy.NodeSortType.html" title="enum in org.apache.storm.scheduler.resource.strategies.scheduling"><code>BaseResourceAwareStrategy.NodeSortType</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getRackIdToHosts()"> |
| <h3>getRackIdToHosts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>></span> <span class="element-name">getRackIdToHosts</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="prepare(org.apache.storm.scheduler.ExecutorDetails)"> |
| <h3>prepare</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">prepare</span><wbr><span class="parameters">(<a href="../../../../ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a> exec)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="INodeSorter.html#prepare(org.apache.storm.scheduler.ExecutorDetails)">INodeSorter</a></code></span></div> |
| <div class="block">Prepare for node sorting. This method must be called before <a href="INodeSorter.html#getSortedRacks()"><code>INodeSorter.getSortedRacks()</code></a> and <a href="INodeSorter.html#sortAllNodes()"><code>INodeSorter.sortAllNodes()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="INodeSorter.html#prepare(org.apache.storm.scheduler.ExecutorDetails)">prepare</a></code> in interface <code><a href="INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">INodeSorter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>exec</code> - optional, may be null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sortObjectResources(org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesSummary,org.apache.storm.scheduler.ExecutorDetails,org.apache.storm.scheduler.resource.strategies.scheduling.sorter.NodeSorterHostProximity.ExistingScheduleFunc)"> |
| <h3>sortObjectResources</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a>></span> <span class="element-name">sortObjectResources</span><wbr><span class="parameters">(<a href="../ObjectResourcesSummary.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesSummary</a> resourcesSummary, |
| <a href="../../../../ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a> exec, |
| <a href="NodeSorterHostProximity.ExistingScheduleFunc.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">NodeSorterHostProximity.ExistingScheduleFunc</a> existingScheduleFunc)</span></div> |
| <div class="block">Scheduling uses <a href="#sortAllNodes()"><code>sortAllNodes()</code></a> which eventually |
| calls this method whose behavior can be altered by setting <a href="#nodeSortType"><code>nodeSortType</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>resourcesSummary</code> - contains all individual <a href="../ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>ObjectResourcesItem</code></a> as well as cumulative stats</dd> |
| <dd><code>exec</code> - executor for which the sorting is done</dd> |
| <dd><code>existingScheduleFunc</code> - a function to get existing executors already scheduled on this object</dd> |
| <dt>Returns:</dt> |
| <dd>an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link"><code>Iterable</code></a> of sorted <a href="../ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling"><code>ObjectResourcesItem</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="makeHostToNodeIds(java.util.List)"> |
| <h3>makeHostToNodeIds</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">makeHostToNodeIds</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> hosts)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sortAllNodes()"> |
| <h3>sortAllNodes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">sortAllNodes</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="INodeSorter.html#sortAllNodes()">sortAllNodes</a></code> in interface <code><a href="INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">INodeSorter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScheduledExecCntByRackId()"> |
| <h3>getScheduledExecCntByRackId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicInteger.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicInteger</a>></span> <span class="element-name">getScheduledExecCntByRackId</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSortedRacks()"> |
| <h3>getSortedRacks</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a>></span> <span class="element-name">getSortedRacks</span>()</div> |
| <div class="block">Racks are sorted by two criteria. |
| |
| <p>1) the number executors of the topology that needs to be scheduled is already on the rack in descending order. |
| The reasoning to sort based on criterion 1 is so we schedule the rest of a topology on the same rack as the existing executors of the |
| topology. |
| |
| <p>2) the subordinate/subservient resource availability percentage of a rack in descending order We calculate |
| the resource availability percentage by dividing the resource availability on the rack by the resource availability of the entire |
| cluster By doing this calculation, racks that have exhausted or little of one of the resources mentioned above will be ranked after |
| racks that have more balanced resource availability. So we will be less likely to pick a rack that have a lot of one resource but a |
| low amount of another.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="INodeSorter.html#getSortedRacks()">getSortedRacks</a></code> in interface <code><a href="INodeSorter.html" title="interface in org.apache.storm.scheduler.resource.strategies.scheduling.sorter">INodeSorter</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>an iterable of sorted racks</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hostnameToNodes(java.lang.String)"> |
| <h3>hostnameToNodes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../../RasNode.html" title="class in org.apache.storm.scheduler.resource">RasNode</a>></span> <span class="element-name">hostnameToNodes</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> hostname)</span></div> |
| <div class="block">hostname to Ids.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>hostname</code> - the hostname.</dd> |
| <dt>Returns:</dt> |
| <dd>the ids n that node.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
