| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.procedure2, interface: ProcedureScheduler"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.procedure2;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.util.Iterator;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.List;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.concurrent.TimeUnit;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">024</span><span id="line-24"></span> |
| <span class="source-line-no">025</span><span id="line-25">/**</span> |
| <span class="source-line-no">026</span><span id="line-26"> * Keep track of the runnable procedures</span> |
| <span class="source-line-no">027</span><span id="line-27"> */</span> |
| <span class="source-line-no">028</span><span id="line-28">@InterfaceAudience.Private</span> |
| <span class="source-line-no">029</span><span id="line-29">public interface ProcedureScheduler {</span> |
| <span class="source-line-no">030</span><span id="line-30"> /**</span> |
| <span class="source-line-no">031</span><span id="line-31"> * Start the scheduler</span> |
| <span class="source-line-no">032</span><span id="line-32"> */</span> |
| <span class="source-line-no">033</span><span id="line-33"> void start();</span> |
| <span class="source-line-no">034</span><span id="line-34"></span> |
| <span class="source-line-no">035</span><span id="line-35"> /**</span> |
| <span class="source-line-no">036</span><span id="line-36"> * Stop the scheduler</span> |
| <span class="source-line-no">037</span><span id="line-37"> */</span> |
| <span class="source-line-no">038</span><span id="line-38"> void stop();</span> |
| <span class="source-line-no">039</span><span id="line-39"></span> |
| <span class="source-line-no">040</span><span id="line-40"> /**</span> |
| <span class="source-line-no">041</span><span id="line-41"> * In case the class is blocking on poll() waiting for items to be added, this method should awake</span> |
| <span class="source-line-no">042</span><span id="line-42"> * poll() and poll() should return.</span> |
| <span class="source-line-no">043</span><span id="line-43"> */</span> |
| <span class="source-line-no">044</span><span id="line-44"> void signalAll();</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46"> /**</span> |
| <span class="source-line-no">047</span><span id="line-47"> * Inserts the specified element at the front of this queue.</span> |
| <span class="source-line-no">048</span><span id="line-48"> * @param proc the Procedure to add</span> |
| <span class="source-line-no">049</span><span id="line-49"> */</span> |
| <span class="source-line-no">050</span><span id="line-50"> void addFront(Procedure proc);</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> /**</span> |
| <span class="source-line-no">053</span><span id="line-53"> * Inserts the specified element at the front of this queue.</span> |
| <span class="source-line-no">054</span><span id="line-54"> * @param proc the Procedure to add</span> |
| <span class="source-line-no">055</span><span id="line-55"> * @param notify whether need to notify worker</span> |
| <span class="source-line-no">056</span><span id="line-56"> */</span> |
| <span class="source-line-no">057</span><span id="line-57"> void addFront(Procedure proc, boolean notify);</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> /**</span> |
| <span class="source-line-no">060</span><span id="line-60"> * Inserts all elements in the iterator at the front of this queue.</span> |
| <span class="source-line-no">061</span><span id="line-61"> */</span> |
| <span class="source-line-no">062</span><span id="line-62"> void addFront(Iterator<Procedure> procedureIterator);</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> /**</span> |
| <span class="source-line-no">065</span><span id="line-65"> * Inserts the specified element at the end of this queue.</span> |
| <span class="source-line-no">066</span><span id="line-66"> * @param proc the Procedure to add</span> |
| <span class="source-line-no">067</span><span id="line-67"> */</span> |
| <span class="source-line-no">068</span><span id="line-68"> void addBack(Procedure proc);</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> /**</span> |
| <span class="source-line-no">071</span><span id="line-71"> * Inserts the specified element at the end of this queue.</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @param proc the Procedure to add</span> |
| <span class="source-line-no">073</span><span id="line-73"> * @param notify whether need to notify worker</span> |
| <span class="source-line-no">074</span><span id="line-74"> */</span> |
| <span class="source-line-no">075</span><span id="line-75"> void addBack(Procedure proc, boolean notify);</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> /**</span> |
| <span class="source-line-no">078</span><span id="line-78"> * The procedure can't run at the moment. add it back to the queue, giving priority to someone</span> |
| <span class="source-line-no">079</span><span id="line-79"> * else.</span> |
| <span class="source-line-no">080</span><span id="line-80"> * @param proc the Procedure to add back to the list</span> |
| <span class="source-line-no">081</span><span id="line-81"> */</span> |
| <span class="source-line-no">082</span><span id="line-82"> void yield(Procedure proc);</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /**</span> |
| <span class="source-line-no">085</span><span id="line-85"> * The procedure in execution completed. This can be implemented to perform cleanups.</span> |
| <span class="source-line-no">086</span><span id="line-86"> * @param proc the Procedure that completed the execution.</span> |
| <span class="source-line-no">087</span><span id="line-87"> */</span> |
| <span class="source-line-no">088</span><span id="line-88"> void completionCleanup(Procedure proc);</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> /** Returns true if there are procedures available to process, otherwise false. */</span> |
| <span class="source-line-no">091</span><span id="line-91"> boolean hasRunnables();</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> /**</span> |
| <span class="source-line-no">094</span><span id="line-94"> * Fetch one Procedure from the queue</span> |
| <span class="source-line-no">095</span><span id="line-95"> * @return the Procedure to execute, or null if nothing present.</span> |
| <span class="source-line-no">096</span><span id="line-96"> */</span> |
| <span class="source-line-no">097</span><span id="line-97"> Procedure poll();</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> /**</span> |
| <span class="source-line-no">100</span><span id="line-100"> * Fetch one Procedure from the queue</span> |
| <span class="source-line-no">101</span><span id="line-101"> * @param timeout how long to wait before giving up, in units of unit</span> |
| <span class="source-line-no">102</span><span id="line-102"> * @param unit a TimeUnit determining how to interpret the timeout parameter</span> |
| <span class="source-line-no">103</span><span id="line-103"> * @return the Procedure to execute, or null if nothing present.</span> |
| <span class="source-line-no">104</span><span id="line-104"> */</span> |
| <span class="source-line-no">105</span><span id="line-105"> Procedure poll(long timeout, TimeUnit unit);</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> /**</span> |
| <span class="source-line-no">108</span><span id="line-108"> * List lock queues.</span> |
| <span class="source-line-no">109</span><span id="line-109"> * @return the locks</span> |
| <span class="source-line-no">110</span><span id="line-110"> */</span> |
| <span class="source-line-no">111</span><span id="line-111"> List<LockedResource> getLocks();</span> |
| <span class="source-line-no">112</span><span id="line-112"></span> |
| <span class="source-line-no">113</span><span id="line-113"> /**</span> |
| <span class="source-line-no">114</span><span id="line-114"> * @return {@link LockedResource} for resource of specified type & name. null if resource is not</span> |
| <span class="source-line-no">115</span><span id="line-115"> * locked.</span> |
| <span class="source-line-no">116</span><span id="line-116"> */</span> |
| <span class="source-line-no">117</span><span id="line-117"> LockedResource getLockResource(LockedResourceType resourceType, String resourceName);</span> |
| <span class="source-line-no">118</span><span id="line-118"></span> |
| <span class="source-line-no">119</span><span id="line-119"> /**</span> |
| <span class="source-line-no">120</span><span id="line-120"> * Returns the number of elements in this queue.</span> |
| <span class="source-line-no">121</span><span id="line-121"> * @return the number of elements in this queue.</span> |
| <span class="source-line-no">122</span><span id="line-122"> */</span> |
| <span class="source-line-no">123</span><span id="line-123"> int size();</span> |
| <span class="source-line-no">124</span><span id="line-124"></span> |
| <span class="source-line-no">125</span><span id="line-125"> /**</span> |
| <span class="source-line-no">126</span><span id="line-126"> * Clear current state of scheduler such that it is equivalent to newly created scheduler. Used</span> |
| <span class="source-line-no">127</span><span id="line-127"> * for testing failure and recovery. To emulate server crash/restart, {@link ProcedureExecutor}</span> |
| <span class="source-line-no">128</span><span id="line-128"> * resets its own state and calls clear() on scheduler.</span> |
| <span class="source-line-no">129</span><span id="line-129"> */</span> |
| <span class="source-line-no">130</span><span id="line-130"> void clear();</span> |
| <span class="source-line-no">131</span><span id="line-131">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
