| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SimpleProcedureScheduler (Apache HBase 4.0.0-alpha-1-SNAPSHOT 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.hadoop.hbase.procedure2, class: SimpleProcedureScheduler"> |
| <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/SimpleProcedureScheduler.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>Nested | </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.hadoop.hbase.procedure2</a></div> |
| <h1 title="Class SimpleProcedureScheduler" class="title">Class SimpleProcedureScheduler</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/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"><a href="AbstractProcedureScheduler.html" title="class in org.apache.hadoop.hbase.procedure2">org.apache.hadoop.hbase.procedure2.AbstractProcedureScheduler</a> |
| <div class="inheritance">org.apache.hadoop.hbase.procedure2.SimpleProcedureScheduler</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="ProcedureScheduler.html" title="interface in org.apache.hadoop.hbase.procedure2">ProcedureScheduler</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| @Evolving |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-30">SimpleProcedureScheduler</a></span> |
| <span class="extends-implements">extends <a href="AbstractProcedureScheduler.html" title="class in org.apache.hadoop.hbase.procedure2">AbstractProcedureScheduler</a></span></div> |
| <div class="block">Simple scheduler for procedures</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== 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>private final <a href="ProcedureDeque.html" title="class in org.apache.hadoop.hbase.procedure2">ProcedureDeque</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#runnables" class="member-name-link">runnables</a></code></div> |
| <div class="col-last even-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()" class="member-name-link">SimpleProcedureScheduler</a>()</code></div> |
| <div class="col-last even-row-color"> </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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Clear current state of scheduler such that it is equivalent to newly created scheduler.</div> |
| </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="#completionCleanup(org.apache.hadoop.hbase.procedure2.Procedure)" class="member-name-link">completionCleanup</a><wbr>(<a href="Procedure.html" title="class in org.apache.hadoop.hbase.procedure2">Procedure</a> proc)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The procedure in execution completed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="Procedure.html" title="class in org.apache.hadoop.hbase.procedure2">Procedure</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dequeue()" class="member-name-link">dequeue</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Fetch one Procedure from the queue NOTE: this method is called with the sched lock held.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enqueue(org.apache.hadoop.hbase.procedure2.Procedure,boolean)" class="member-name-link">enqueue</a><wbr>(<a href="Procedure.html" title="class in org.apache.hadoop.hbase.procedure2">Procedure</a> procedure, |
| boolean addFront)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the procedure to the queue.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LockedResource.html" title="class in org.apache.hadoop.hbase.procedure2">LockedResource</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLockResource(org.apache.hadoop.hbase.procedure2.LockedResourceType,java.lang.String)" class="member-name-link">getLockResource</a><wbr>(<a href="LockedResourceType.html" title="enum class in org.apache.hadoop.hbase.procedure2">LockedResourceType</a> resourceType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resourceName)</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/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="LockedResource.html" title="class in org.apache.hadoop.hbase.procedure2">LockedResource</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocks()" class="member-name-link">getLocks</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">List lock queues.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queueHasRunnables()" class="member-name-link">queueHasRunnables</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if there are procedures available to process.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queueSize()" class="member-name-link">queueSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of elements in this queue.</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/17/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="#toString()" class="member-name-link">toString</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#yield(org.apache.hadoop.hbase.procedure2.Procedure)" class="member-name-link">yield</a><wbr>(<a href="Procedure.html" title="class in org.apache.hadoop.hbase.procedure2">Procedure</a> proc)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The procedure can't run at the moment.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.procedure2.AbstractProcedureScheduler">Methods inherited from class org.apache.hadoop.hbase.procedure2.<a href="AbstractProcedureScheduler.html" title="class in org.apache.hadoop.hbase.procedure2">AbstractProcedureScheduler</a></h3> |
| <code><a href="AbstractProcedureScheduler.html#addBack(org.apache.hadoop.hbase.procedure2.Procedure)">addBack</a>, <a href="AbstractProcedureScheduler.html#addBack(org.apache.hadoop.hbase.procedure2.Procedure,boolean)">addBack</a>, <a href="AbstractProcedureScheduler.html#addFront(java.util.Iterator)">addFront</a>, <a href="AbstractProcedureScheduler.html#addFront(org.apache.hadoop.hbase.procedure2.Procedure)">addFront</a>, <a href="AbstractProcedureScheduler.html#addFront(org.apache.hadoop.hbase.procedure2.Procedure,boolean)">addFront</a>, <a href="AbstractProcedureScheduler.html#getNullPollCalls()">getNullPollCalls</a>, <a href="AbstractProcedureScheduler.html#getPollCalls()">getPollCalls</a>, <a href="AbstractProcedureScheduler.html#hasRunnables()">hasRunnables</a>, <a href="AbstractProcedureScheduler.html#poll()">poll</a>, <a href="AbstractProcedureScheduler.html#poll(long)">poll</a>, <a href="AbstractProcedureScheduler.html#poll(long,java.util.concurrent.TimeUnit)">poll</a>, <a href="AbstractProcedureScheduler.html#push(org.apache.hadoop.hbase.procedure2.Procedure,boolean,boolean)">push</a>, <a href="AbstractProcedureScheduler.html#schedLock()">schedLock</a>, <a href="AbstractProcedureScheduler.html#schedUnlock()">schedUnlock</a>, <a href="AbstractProcedureScheduler.html#signalAll()">signalAll</a>, <a href="AbstractProcedureScheduler.html#size()">size</a>, <a href="AbstractProcedureScheduler.html#start()">start</a>, <a href="AbstractProcedureScheduler.html#stop()">stop</a>, <a href="AbstractProcedureScheduler.html#waitProcedure(org.apache.hadoop.hbase.procedure2.LockAndQueue,org.apache.hadoop.hbase.procedure2.Procedure)">waitProcedure</a>, <a href="AbstractProcedureScheduler.html#wakeEvents(org.apache.hadoop.hbase.procedure2.ProcedureEvent%5B%5D)">wakeEvents</a>, <a href="AbstractProcedureScheduler.html#wakePollIfNeeded(int)">wakePollIfNeeded</a>, <a href="AbstractProcedureScheduler.html#wakeProcedure(org.apache.hadoop.hbase.procedure2.Procedure)">wakeProcedure</a>, <a href="AbstractProcedureScheduler.html#wakeWaitingProcedures(org.apache.hadoop.hbase.procedure2.LockAndQueue)">wakeWaitingProcedures</a></code></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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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="runnables"> |
| <h3>runnables</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="ProcedureDeque.html" title="class in org.apache.hadoop.hbase.procedure2">ProcedureDeque</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-33">runnables</a></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>()"> |
| <h3>SimpleProcedureScheduler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-32">SimpleProcedureScheduler</a></span>()</div> |
| </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="enqueue(org.apache.hadoop.hbase.procedure2.Procedure,boolean)"> |
| <h3>enqueue</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-35">enqueue</a></span><wbr><span class="parameters">(<a href="Procedure.html" title="class in org.apache.hadoop.hbase.procedure2">Procedure</a> procedure, |
| boolean addFront)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="AbstractProcedureScheduler.html#enqueue(org.apache.hadoop.hbase.procedure2.Procedure,boolean)">AbstractProcedureScheduler</a></code></span></div> |
| <div class="block">Add the procedure to the queue. NOTE: this method is called with the sched lock held.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AbstractProcedureScheduler.html#enqueue(org.apache.hadoop.hbase.procedure2.Procedure,boolean)">enqueue</a></code> in class <code><a href="AbstractProcedureScheduler.html" title="class in org.apache.hadoop.hbase.procedure2">AbstractProcedureScheduler</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>procedure</code> - the Procedure to add</dd> |
| <dd><code>addFront</code> - true if the item should be added to the front of the queue</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dequeue()"> |
| <h3>dequeue</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="Procedure.html" title="class in org.apache.hadoop.hbase.procedure2">Procedure</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-44">dequeue</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="AbstractProcedureScheduler.html#dequeue()">AbstractProcedureScheduler</a></code></span></div> |
| <div class="block">Fetch one Procedure from the queue NOTE: this method is called with the sched lock held.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AbstractProcedureScheduler.html#dequeue()">dequeue</a></code> in class <code><a href="AbstractProcedureScheduler.html" title="class in org.apache.hadoop.hbase.procedure2">AbstractProcedureScheduler</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the Procedure to execute, or null if nothing is available.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-49">clear</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ProcedureScheduler.html#clear()">ProcedureScheduler</a></code></span></div> |
| <div class="block">Clear current state of scheduler such that it is equivalent to newly created scheduler. Used |
| for testing failure and recovery. To emulate server crash/restart, <a href="ProcedureExecutor.html" title="class in org.apache.hadoop.hbase.procedure2"><code>ProcedureExecutor</code></a> |
| resets its own state and calls clear() on scheduler.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="yield(org.apache.hadoop.hbase.procedure2.Procedure)"> |
| <h3>yield</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-59">yield</a></span><wbr><span class="parameters">(<a href="Procedure.html" title="class in org.apache.hadoop.hbase.procedure2">Procedure</a> proc)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ProcedureScheduler.html#yield(org.apache.hadoop.hbase.procedure2.Procedure)">ProcedureScheduler</a></code></span></div> |
| <div class="block">The procedure can't run at the moment. add it back to the queue, giving priority to someone |
| else.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>proc</code> - the Procedure to add back to the list</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="queueHasRunnables()"> |
| <h3>queueHasRunnables</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-64">queueHasRunnables</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="AbstractProcedureScheduler.html#queueHasRunnables()">AbstractProcedureScheduler</a></code></span></div> |
| <div class="block">Returns true if there are procedures available to process. NOTE: this method is called with the |
| sched lock held.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AbstractProcedureScheduler.html#queueHasRunnables()">queueHasRunnables</a></code> in class <code><a href="AbstractProcedureScheduler.html" title="class in org.apache.hadoop.hbase.procedure2">AbstractProcedureScheduler</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if there are procedures available to process, otherwise false.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="queueSize()"> |
| <h3>queueSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-69">queueSize</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="AbstractProcedureScheduler.html#queueSize()">AbstractProcedureScheduler</a></code></span></div> |
| <div class="block">Returns the number of elements in this queue. NOTE: this method is called with the sched lock |
| held.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="AbstractProcedureScheduler.html#queueSize()">queueSize</a></code> in class <code><a href="AbstractProcedureScheduler.html" title="class in org.apache.hadoop.hbase.procedure2">AbstractProcedureScheduler</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the number of elements in this queue.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="completionCleanup(org.apache.hadoop.hbase.procedure2.Procedure)"> |
| <h3>completionCleanup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-74">completionCleanup</a></span><wbr><span class="parameters">(<a href="Procedure.html" title="class in org.apache.hadoop.hbase.procedure2">Procedure</a> proc)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ProcedureScheduler.html#completionCleanup(org.apache.hadoop.hbase.procedure2.Procedure)">ProcedureScheduler</a></code></span></div> |
| <div class="block">The procedure in execution completed. This can be implemented to perform cleanups.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>proc</code> - the Procedure that completed the execution.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLocks()"> |
| <h3>getLocks</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="LockedResource.html" title="class in org.apache.hadoop.hbase.procedure2">LockedResource</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-78">getLocks</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ProcedureScheduler.html#getLocks()">ProcedureScheduler</a></code></span></div> |
| <div class="block">List lock queues.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the locks</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLockResource(org.apache.hadoop.hbase.procedure2.LockedResourceType,java.lang.String)"> |
| <h3>getLockResource</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LockedResource.html" title="class in org.apache.hadoop.hbase.procedure2">LockedResource</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-83">getLockResource</a></span><wbr><span class="parameters">(<a href="LockedResourceType.html" title="enum class in org.apache.hadoop.hbase.procedure2">LockedResourceType</a> resourceType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> resourceName)</span></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><a href="LockedResource.html" title="class in org.apache.hadoop.hbase.procedure2"><code>LockedResource</code></a> for resource of specified type & name. null if resource is not |
| locked.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/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"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/SimpleProcedureScheduler.html#line-88">toString</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractProcedureScheduler.html#toString()">toString</a></code> in class <code><a href="AbstractProcedureScheduler.html" title="class in org.apache.hadoop.hbase.procedure2">AbstractProcedureScheduler</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |