| <!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, class: ScheduledChore"> |
| <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;</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 com.google.errorprone.annotations.RestrictedApi;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.concurrent.ScheduledThreadPoolExecutor;</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.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.slf4j.Logger;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * ScheduledChore is a task performed on a period in hbase. ScheduledChores become active once</span> |
| <span class="source-line-no">030</span><span id="line-30"> * scheduled with a {@link ChoreService} via {@link ChoreService#scheduleChore(ScheduledChore)}. The</span> |
| <span class="source-line-no">031</span><span id="line-31"> * chore is run in a {@link ScheduledThreadPoolExecutor} and competes with other ScheduledChores for</span> |
| <span class="source-line-no">032</span><span id="line-32"> * access to the threads in the core thread pool. If an unhandled exception occurs, the chore</span> |
| <span class="source-line-no">033</span><span id="line-33"> * cancellation is logged. Implementers should consider whether or not the Chore will be able to</span> |
| <span class="source-line-no">034</span><span id="line-34"> * execute within the defined period. It is bad practice to define a ScheduledChore whose execution</span> |
| <span class="source-line-no">035</span><span id="line-35"> * time exceeds its period since it will try to hog one of the threads in the {@link ChoreService}'s</span> |
| <span class="source-line-no">036</span><span id="line-36"> * thread pool.</span> |
| <span class="source-line-no">037</span><span id="line-37"> * <p/></span> |
| <span class="source-line-no">038</span><span id="line-38"> * Don't subclass ScheduledChore if the task relies on being woken up for something to do, such as</span> |
| <span class="source-line-no">039</span><span id="line-39"> * an entry being added to a queue, etc.</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41">@InterfaceAudience.Private</span> |
| <span class="source-line-no">042</span><span id="line-42">public abstract class ScheduledChore implements Runnable {</span> |
| <span class="source-line-no">043</span><span id="line-43"> private static final Logger LOG = LoggerFactory.getLogger(ScheduledChore.class);</span> |
| <span class="source-line-no">044</span><span id="line-44"></span> |
| <span class="source-line-no">045</span><span id="line-45"> private final String name;</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> /**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * Default values for scheduling parameters should they be excluded during construction</span> |
| <span class="source-line-no">049</span><span id="line-49"> */</span> |
| <span class="source-line-no">050</span><span id="line-50"> private final static TimeUnit DEFAULT_TIME_UNIT = TimeUnit.MILLISECONDS;</span> |
| <span class="source-line-no">051</span><span id="line-51"> private final static long DEFAULT_INITIAL_DELAY = 0;</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> /**</span> |
| <span class="source-line-no">054</span><span id="line-54"> * Scheduling parameters. Used by ChoreService when scheduling the chore to run periodically</span> |
| <span class="source-line-no">055</span><span id="line-55"> */</span> |
| <span class="source-line-no">056</span><span id="line-56"> private final int period; // in TimeUnit units</span> |
| <span class="source-line-no">057</span><span id="line-57"> private final TimeUnit timeUnit;</span> |
| <span class="source-line-no">058</span><span id="line-58"> private final long initialDelay; // in TimeUnit units</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> /**</span> |
| <span class="source-line-no">061</span><span id="line-61"> * Interface to the ChoreService that this ScheduledChore is scheduled with. null if the chore is</span> |
| <span class="source-line-no">062</span><span id="line-62"> * not scheduled.</span> |
| <span class="source-line-no">063</span><span id="line-63"> */</span> |
| <span class="source-line-no">064</span><span id="line-64"> private ChoreService choreService;</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> /**</span> |
| <span class="source-line-no">067</span><span id="line-67"> * Variables that encapsulate the meaningful state information</span> |
| <span class="source-line-no">068</span><span id="line-68"> */</span> |
| <span class="source-line-no">069</span><span id="line-69"> private long timeOfLastRun = -1; // system time millis</span> |
| <span class="source-line-no">070</span><span id="line-70"> private long timeOfThisRun = -1; // system time millis</span> |
| <span class="source-line-no">071</span><span id="line-71"> private boolean initialChoreComplete = false;</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> /**</span> |
| <span class="source-line-no">074</span><span id="line-74"> * A means by which a ScheduledChore can be stopped. Once a chore recognizes that it has been</span> |
| <span class="source-line-no">075</span><span id="line-75"> * stopped, it will cancel itself. This is particularly useful in the case where a single stopper</span> |
| <span class="source-line-no">076</span><span id="line-76"> * instance is given to multiple chores. In such a case, a single {@link Stoppable#stop(String)}</span> |
| <span class="source-line-no">077</span><span id="line-77"> * command can cause many chores to stop together.</span> |
| <span class="source-line-no">078</span><span id="line-78"> */</span> |
| <span class="source-line-no">079</span><span id="line-79"> private final Stoppable stopper;</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> /**</span> |
| <span class="source-line-no">082</span><span id="line-82"> * Construct a ScheduledChore</span> |
| <span class="source-line-no">083</span><span id="line-83"> * <p></span> |
| <span class="source-line-no">084</span><span id="line-84"> * This constructor is for test only. It allows us to create an object and to call chore() on it.</span> |
| <span class="source-line-no">085</span><span id="line-85"> */</span> |
| <span class="source-line-no">086</span><span id="line-86"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">087</span><span id="line-87"> protected ScheduledChore() {</span> |
| <span class="source-line-no">088</span><span id="line-88"> this("TestChore", null, 0, DEFAULT_INITIAL_DELAY, DEFAULT_TIME_UNIT);</span> |
| <span class="source-line-no">089</span><span id="line-89"> }</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> /**</span> |
| <span class="source-line-no">092</span><span id="line-92"> * Construct a ScheduledChore</span> |
| <span class="source-line-no">093</span><span id="line-93"> * @param name Name assigned to Chore. Useful for identification amongst chores of the same</span> |
| <span class="source-line-no">094</span><span id="line-94"> * type</span> |
| <span class="source-line-no">095</span><span id="line-95"> * @param stopper When {@link Stoppable#isStopped()} is true, this chore will cancel and cleanup</span> |
| <span class="source-line-no">096</span><span id="line-96"> * @param period Period in millis with which this Chore repeats execution when scheduled.</span> |
| <span class="source-line-no">097</span><span id="line-97"> */</span> |
| <span class="source-line-no">098</span><span id="line-98"> public ScheduledChore(final String name, Stoppable stopper, final int period) {</span> |
| <span class="source-line-no">099</span><span id="line-99"> this(name, stopper, period, DEFAULT_INITIAL_DELAY);</span> |
| <span class="source-line-no">100</span><span id="line-100"> }</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> /**</span> |
| <span class="source-line-no">103</span><span id="line-103"> * Construct a ScheduledChore</span> |
| <span class="source-line-no">104</span><span id="line-104"> * @param name Name assigned to Chore. Useful for identification amongst chores of the</span> |
| <span class="source-line-no">105</span><span id="line-105"> * same type</span> |
| <span class="source-line-no">106</span><span id="line-106"> * @param stopper When {@link Stoppable#isStopped()} is true, this chore will cancel and</span> |
| <span class="source-line-no">107</span><span id="line-107"> * cleanup</span> |
| <span class="source-line-no">108</span><span id="line-108"> * @param period Period in millis with which this Chore repeats execution when scheduled.</span> |
| <span class="source-line-no">109</span><span id="line-109"> * @param initialDelay Delay before this Chore begins to execute once it has been scheduled. A</span> |
| <span class="source-line-no">110</span><span id="line-110"> * value of 0 means the chore will begin to execute immediately. Negative</span> |
| <span class="source-line-no">111</span><span id="line-111"> * delays are invalid and will be corrected to a value of 0.</span> |
| <span class="source-line-no">112</span><span id="line-112"> */</span> |
| <span class="source-line-no">113</span><span id="line-113"> public ScheduledChore(final String name, Stoppable stopper, final int period,</span> |
| <span class="source-line-no">114</span><span id="line-114"> final long initialDelay) {</span> |
| <span class="source-line-no">115</span><span id="line-115"> this(name, stopper, period, initialDelay, DEFAULT_TIME_UNIT);</span> |
| <span class="source-line-no">116</span><span id="line-116"> }</span> |
| <span class="source-line-no">117</span><span id="line-117"></span> |
| <span class="source-line-no">118</span><span id="line-118"> /**</span> |
| <span class="source-line-no">119</span><span id="line-119"> * Construct a ScheduledChore</span> |
| <span class="source-line-no">120</span><span id="line-120"> * @param name Name assigned to Chore. Useful for identification amongst chores of the</span> |
| <span class="source-line-no">121</span><span id="line-121"> * same type</span> |
| <span class="source-line-no">122</span><span id="line-122"> * @param stopper When {@link Stoppable#isStopped()} is true, this chore will cancel and</span> |
| <span class="source-line-no">123</span><span id="line-123"> * cleanup</span> |
| <span class="source-line-no">124</span><span id="line-124"> * @param period Period in Timeunit unit with which this Chore repeats execution when</span> |
| <span class="source-line-no">125</span><span id="line-125"> * scheduled.</span> |
| <span class="source-line-no">126</span><span id="line-126"> * @param initialDelay Delay in Timeunit unit before this Chore begins to execute once it has been</span> |
| <span class="source-line-no">127</span><span id="line-127"> * scheduled. A value of 0 means the chore will begin to execute immediately.</span> |
| <span class="source-line-no">128</span><span id="line-128"> * Negative delays are invalid and will be corrected to a value of 0.</span> |
| <span class="source-line-no">129</span><span id="line-129"> * @param unit The unit that is used to measure period and initialDelay</span> |
| <span class="source-line-no">130</span><span id="line-130"> */</span> |
| <span class="source-line-no">131</span><span id="line-131"> public ScheduledChore(final String name, Stoppable stopper, final int period,</span> |
| <span class="source-line-no">132</span><span id="line-132"> final long initialDelay, final TimeUnit unit) {</span> |
| <span class="source-line-no">133</span><span id="line-133"> this.name = name;</span> |
| <span class="source-line-no">134</span><span id="line-134"> this.stopper = stopper;</span> |
| <span class="source-line-no">135</span><span id="line-135"> this.period = period;</span> |
| <span class="source-line-no">136</span><span id="line-136"> this.initialDelay = initialDelay < 0 ? 0 : initialDelay;</span> |
| <span class="source-line-no">137</span><span id="line-137"> this.timeUnit = unit;</span> |
| <span class="source-line-no">138</span><span id="line-138"> }</span> |
| <span class="source-line-no">139</span><span id="line-139"></span> |
| <span class="source-line-no">140</span><span id="line-140"> @Override</span> |
| <span class="source-line-no">141</span><span id="line-141"> public void run() {</span> |
| <span class="source-line-no">142</span><span id="line-142"> updateTimeTrackingBeforeRun();</span> |
| <span class="source-line-no">143</span><span id="line-143"> if (missedStartTime() && isScheduled()) {</span> |
| <span class="source-line-no">144</span><span id="line-144"> onChoreMissedStartTime();</span> |
| <span class="source-line-no">145</span><span id="line-145"> LOG.info("Chore: {} missed its start time", getName());</span> |
| <span class="source-line-no">146</span><span id="line-146"> } else if (stopper.isStopped() || !isScheduled()) {</span> |
| <span class="source-line-no">147</span><span id="line-147"> // call shutdown here to cleanup the ScheduledChore.</span> |
| <span class="source-line-no">148</span><span id="line-148"> shutdown(false);</span> |
| <span class="source-line-no">149</span><span id="line-149"> LOG.info("Chore: {} was stopped", getName());</span> |
| <span class="source-line-no">150</span><span id="line-150"> } else {</span> |
| <span class="source-line-no">151</span><span id="line-151"> try {</span> |
| <span class="source-line-no">152</span><span id="line-152"> // TODO: Histogram metrics per chore name.</span> |
| <span class="source-line-no">153</span><span id="line-153"> // For now, just measure and log if DEBUG level logging is enabled.</span> |
| <span class="source-line-no">154</span><span id="line-154"> long start = 0;</span> |
| <span class="source-line-no">155</span><span id="line-155"> if (LOG.isDebugEnabled()) {</span> |
| <span class="source-line-no">156</span><span id="line-156"> start = System.nanoTime();</span> |
| <span class="source-line-no">157</span><span id="line-157"> }</span> |
| <span class="source-line-no">158</span><span id="line-158"> if (!initialChoreComplete) {</span> |
| <span class="source-line-no">159</span><span id="line-159"> initialChoreComplete = initialChore();</span> |
| <span class="source-line-no">160</span><span id="line-160"> } else {</span> |
| <span class="source-line-no">161</span><span id="line-161"> chore();</span> |
| <span class="source-line-no">162</span><span id="line-162"> }</span> |
| <span class="source-line-no">163</span><span id="line-163"> if (LOG.isDebugEnabled() && start > 0) {</span> |
| <span class="source-line-no">164</span><span id="line-164"> long end = System.nanoTime();</span> |
| <span class="source-line-no">165</span><span id="line-165"> LOG.debug("{} execution time: {} ms.", getName(),</span> |
| <span class="source-line-no">166</span><span id="line-166"> TimeUnit.NANOSECONDS.toMillis(end - start));</span> |
| <span class="source-line-no">167</span><span id="line-167"> }</span> |
| <span class="source-line-no">168</span><span id="line-168"> } catch (Throwable t) {</span> |
| <span class="source-line-no">169</span><span id="line-169"> LOG.error("Caught error", t);</span> |
| <span class="source-line-no">170</span><span id="line-170"> if (this.stopper.isStopped()) {</span> |
| <span class="source-line-no">171</span><span id="line-171"> cancel(false);</span> |
| <span class="source-line-no">172</span><span id="line-172"> }</span> |
| <span class="source-line-no">173</span><span id="line-173"> }</span> |
| <span class="source-line-no">174</span><span id="line-174"> }</span> |
| <span class="source-line-no">175</span><span id="line-175"> }</span> |
| <span class="source-line-no">176</span><span id="line-176"></span> |
| <span class="source-line-no">177</span><span id="line-177"> /**</span> |
| <span class="source-line-no">178</span><span id="line-178"> * Update our time tracking members. Called at the start of an execution of this chore's run()</span> |
| <span class="source-line-no">179</span><span id="line-179"> * method so that a correct decision can be made as to whether or not we missed the start time</span> |
| <span class="source-line-no">180</span><span id="line-180"> */</span> |
| <span class="source-line-no">181</span><span id="line-181"> private synchronized void updateTimeTrackingBeforeRun() {</span> |
| <span class="source-line-no">182</span><span id="line-182"> timeOfLastRun = timeOfThisRun;</span> |
| <span class="source-line-no">183</span><span id="line-183"> timeOfThisRun = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">184</span><span id="line-184"> }</span> |
| <span class="source-line-no">185</span><span id="line-185"></span> |
| <span class="source-line-no">186</span><span id="line-186"> /**</span> |
| <span class="source-line-no">187</span><span id="line-187"> * Notify the ChoreService that this chore has missed its start time. Allows the ChoreService to</span> |
| <span class="source-line-no">188</span><span id="line-188"> * make the decision as to whether or not it would be worthwhile to increase the number of core</span> |
| <span class="source-line-no">189</span><span id="line-189"> * pool threads</span> |
| <span class="source-line-no">190</span><span id="line-190"> */</span> |
| <span class="source-line-no">191</span><span id="line-191"> private synchronized void onChoreMissedStartTime() {</span> |
| <span class="source-line-no">192</span><span id="line-192"> if (choreService != null) {</span> |
| <span class="source-line-no">193</span><span id="line-193"> choreService.onChoreMissedStartTime(this);</span> |
| <span class="source-line-no">194</span><span id="line-194"> }</span> |
| <span class="source-line-no">195</span><span id="line-195"> }</span> |
| <span class="source-line-no">196</span><span id="line-196"></span> |
| <span class="source-line-no">197</span><span id="line-197"> /**</span> |
| <span class="source-line-no">198</span><span id="line-198"> * Return how long in millis has it been since this chore last run. Useful for checking if the</span> |
| <span class="source-line-no">199</span><span id="line-199"> * chore has missed its scheduled start time by too large of a margin</span> |
| <span class="source-line-no">200</span><span id="line-200"> */</span> |
| <span class="source-line-no">201</span><span id="line-201"> synchronized long getTimeBetweenRuns() {</span> |
| <span class="source-line-no">202</span><span id="line-202"> return timeOfThisRun - timeOfLastRun;</span> |
| <span class="source-line-no">203</span><span id="line-203"> }</span> |
| <span class="source-line-no">204</span><span id="line-204"></span> |
| <span class="source-line-no">205</span><span id="line-205"> /** Returns true when the time between runs exceeds the acceptable threshold */</span> |
| <span class="source-line-no">206</span><span id="line-206"> private synchronized boolean missedStartTime() {</span> |
| <span class="source-line-no">207</span><span id="line-207"> return isValidTime(timeOfLastRun) && isValidTime(timeOfThisRun)</span> |
| <span class="source-line-no">208</span><span id="line-208"> && getTimeBetweenRuns() > getMaximumAllowedTimeBetweenRuns();</span> |
| <span class="source-line-no">209</span><span id="line-209"> }</span> |
| <span class="source-line-no">210</span><span id="line-210"></span> |
| <span class="source-line-no">211</span><span id="line-211"> /** Returns max allowed time in millis between runs. */</span> |
| <span class="source-line-no">212</span><span id="line-212"> private double getMaximumAllowedTimeBetweenRuns() {</span> |
| <span class="source-line-no">213</span><span id="line-213"> // Threshold used to determine if the Chore's current run started too late</span> |
| <span class="source-line-no">214</span><span id="line-214"> return 1.5 * timeUnit.toMillis(period);</span> |
| <span class="source-line-no">215</span><span id="line-215"> }</span> |
| <span class="source-line-no">216</span><span id="line-216"></span> |
| <span class="source-line-no">217</span><span id="line-217"> /** Return true if time is earlier or equal to current time */</span> |
| <span class="source-line-no">218</span><span id="line-218"> private synchronized boolean isValidTime(final long time) {</span> |
| <span class="source-line-no">219</span><span id="line-219"> return time > 0 && time <= EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">220</span><span id="line-220"> }</span> |
| <span class="source-line-no">221</span><span id="line-221"></span> |
| <span class="source-line-no">222</span><span id="line-222"> /** Returns false when the Chore is not currently scheduled with a ChoreService */</span> |
| <span class="source-line-no">223</span><span id="line-223"> public synchronized boolean triggerNow() {</span> |
| <span class="source-line-no">224</span><span id="line-224"> if (choreService == null) {</span> |
| <span class="source-line-no">225</span><span id="line-225"> return false;</span> |
| <span class="source-line-no">226</span><span id="line-226"> }</span> |
| <span class="source-line-no">227</span><span id="line-227"> choreService.triggerNow(this);</span> |
| <span class="source-line-no">228</span><span id="line-228"> return true;</span> |
| <span class="source-line-no">229</span><span id="line-229"> }</span> |
| <span class="source-line-no">230</span><span id="line-230"></span> |
| <span class="source-line-no">231</span><span id="line-231"> @RestrictedApi(explanation = "Should only be called in ChoreService", link = "",</span> |
| <span class="source-line-no">232</span><span id="line-232"> allowedOnPath = ".*/org/apache/hadoop/hbase/ChoreService.java")</span> |
| <span class="source-line-no">233</span><span id="line-233"> synchronized void setChoreService(ChoreService service) {</span> |
| <span class="source-line-no">234</span><span id="line-234"> choreService = service;</span> |
| <span class="source-line-no">235</span><span id="line-235"> timeOfThisRun = -1;</span> |
| <span class="source-line-no">236</span><span id="line-236"> }</span> |
| <span class="source-line-no">237</span><span id="line-237"></span> |
| <span class="source-line-no">238</span><span id="line-238"> public synchronized void cancel() {</span> |
| <span class="source-line-no">239</span><span id="line-239"> cancel(true);</span> |
| <span class="source-line-no">240</span><span id="line-240"> }</span> |
| <span class="source-line-no">241</span><span id="line-241"></span> |
| <span class="source-line-no">242</span><span id="line-242"> public synchronized void cancel(boolean mayInterruptIfRunning) {</span> |
| <span class="source-line-no">243</span><span id="line-243"> if (isScheduled()) {</span> |
| <span class="source-line-no">244</span><span id="line-244"> choreService.cancelChore(this, mayInterruptIfRunning);</span> |
| <span class="source-line-no">245</span><span id="line-245"> }</span> |
| <span class="source-line-no">246</span><span id="line-246"> choreService = null;</span> |
| <span class="source-line-no">247</span><span id="line-247"> }</span> |
| <span class="source-line-no">248</span><span id="line-248"></span> |
| <span class="source-line-no">249</span><span id="line-249"> public String getName() {</span> |
| <span class="source-line-no">250</span><span id="line-250"> return name;</span> |
| <span class="source-line-no">251</span><span id="line-251"> }</span> |
| <span class="source-line-no">252</span><span id="line-252"></span> |
| <span class="source-line-no">253</span><span id="line-253"> public Stoppable getStopper() {</span> |
| <span class="source-line-no">254</span><span id="line-254"> return stopper;</span> |
| <span class="source-line-no">255</span><span id="line-255"> }</span> |
| <span class="source-line-no">256</span><span id="line-256"></span> |
| <span class="source-line-no">257</span><span id="line-257"> /** Returns period to execute chore in getTimeUnit() units */</span> |
| <span class="source-line-no">258</span><span id="line-258"> public int getPeriod() {</span> |
| <span class="source-line-no">259</span><span id="line-259"> return period;</span> |
| <span class="source-line-no">260</span><span id="line-260"> }</span> |
| <span class="source-line-no">261</span><span id="line-261"></span> |
| <span class="source-line-no">262</span><span id="line-262"> /** Returns initial delay before executing chore in getTimeUnit() units */</span> |
| <span class="source-line-no">263</span><span id="line-263"> public long getInitialDelay() {</span> |
| <span class="source-line-no">264</span><span id="line-264"> return initialDelay;</span> |
| <span class="source-line-no">265</span><span id="line-265"> }</span> |
| <span class="source-line-no">266</span><span id="line-266"></span> |
| <span class="source-line-no">267</span><span id="line-267"> public TimeUnit getTimeUnit() {</span> |
| <span class="source-line-no">268</span><span id="line-268"> return timeUnit;</span> |
| <span class="source-line-no">269</span><span id="line-269"> }</span> |
| <span class="source-line-no">270</span><span id="line-270"></span> |
| <span class="source-line-no">271</span><span id="line-271"> public synchronized boolean isInitialChoreComplete() {</span> |
| <span class="source-line-no">272</span><span id="line-272"> return initialChoreComplete;</span> |
| <span class="source-line-no">273</span><span id="line-273"> }</span> |
| <span class="source-line-no">274</span><span id="line-274"></span> |
| <span class="source-line-no">275</span><span id="line-275"> synchronized ChoreService getChoreService() {</span> |
| <span class="source-line-no">276</span><span id="line-276"> return choreService;</span> |
| <span class="source-line-no">277</span><span id="line-277"> }</span> |
| <span class="source-line-no">278</span><span id="line-278"></span> |
| <span class="source-line-no">279</span><span id="line-279"> synchronized long getTimeOfLastRun() {</span> |
| <span class="source-line-no">280</span><span id="line-280"> return timeOfLastRun;</span> |
| <span class="source-line-no">281</span><span id="line-281"> }</span> |
| <span class="source-line-no">282</span><span id="line-282"></span> |
| <span class="source-line-no">283</span><span id="line-283"> synchronized long getTimeOfThisRun() {</span> |
| <span class="source-line-no">284</span><span id="line-284"> return timeOfThisRun;</span> |
| <span class="source-line-no">285</span><span id="line-285"> }</span> |
| <span class="source-line-no">286</span><span id="line-286"></span> |
| <span class="source-line-no">287</span><span id="line-287"> /** Returns true when this Chore is scheduled with a ChoreService */</span> |
| <span class="source-line-no">288</span><span id="line-288"> public synchronized boolean isScheduled() {</span> |
| <span class="source-line-no">289</span><span id="line-289"> return choreService != null && choreService.isChoreScheduled(this);</span> |
| <span class="source-line-no">290</span><span id="line-290"> }</span> |
| <span class="source-line-no">291</span><span id="line-291"></span> |
| <span class="source-line-no">292</span><span id="line-292"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">293</span><span id="line-293"> @RestrictedApi(explanation = "Should only be called in tests", link = "",</span> |
| <span class="source-line-no">294</span><span id="line-294"> allowedOnPath = ".*/src/test/.*")</span> |
| <span class="source-line-no">295</span><span id="line-295"> public synchronized void choreForTesting() {</span> |
| <span class="source-line-no">296</span><span id="line-296"> chore();</span> |
| <span class="source-line-no">297</span><span id="line-297"> }</span> |
| <span class="source-line-no">298</span><span id="line-298"></span> |
| <span class="source-line-no">299</span><span id="line-299"> /** The task to execute on each scheduled execution of the Chore */</span> |
| <span class="source-line-no">300</span><span id="line-300"> protected abstract void chore();</span> |
| <span class="source-line-no">301</span><span id="line-301"></span> |
| <span class="source-line-no">302</span><span id="line-302"> /**</span> |
| <span class="source-line-no">303</span><span id="line-303"> * Override to run a task before we start looping.</span> |
| <span class="source-line-no">304</span><span id="line-304"> * @return true if initial chore was successful</span> |
| <span class="source-line-no">305</span><span id="line-305"> */</span> |
| <span class="source-line-no">306</span><span id="line-306"> protected boolean initialChore() {</span> |
| <span class="source-line-no">307</span><span id="line-307"> // Default does nothing</span> |
| <span class="source-line-no">308</span><span id="line-308"> return true;</span> |
| <span class="source-line-no">309</span><span id="line-309"> }</span> |
| <span class="source-line-no">310</span><span id="line-310"></span> |
| <span class="source-line-no">311</span><span id="line-311"> /**</span> |
| <span class="source-line-no">312</span><span id="line-312"> * Override to run cleanup tasks when the Chore encounters an error and must stop running</span> |
| <span class="source-line-no">313</span><span id="line-313"> */</span> |
| <span class="source-line-no">314</span><span id="line-314"> protected void cleanup() {</span> |
| <span class="source-line-no">315</span><span id="line-315"> }</span> |
| <span class="source-line-no">316</span><span id="line-316"></span> |
| <span class="source-line-no">317</span><span id="line-317"> /**</span> |
| <span class="source-line-no">318</span><span id="line-318"> * Call {@link #shutdown(boolean)} with {@code true}.</span> |
| <span class="source-line-no">319</span><span id="line-319"> * @see ScheduledChore#shutdown(boolean)</span> |
| <span class="source-line-no">320</span><span id="line-320"> */</span> |
| <span class="source-line-no">321</span><span id="line-321"> public synchronized void shutdown() {</span> |
| <span class="source-line-no">322</span><span id="line-322"> shutdown(true);</span> |
| <span class="source-line-no">323</span><span id="line-323"> }</span> |
| <span class="source-line-no">324</span><span id="line-324"></span> |
| <span class="source-line-no">325</span><span id="line-325"> /**</span> |
| <span class="source-line-no">326</span><span id="line-326"> * Completely shutdown the ScheduleChore, which means we will call cleanup and you should not</span> |
| <span class="source-line-no">327</span><span id="line-327"> * schedule it again.</span> |
| <span class="source-line-no">328</span><span id="line-328"> * <p/></span> |
| <span class="source-line-no">329</span><span id="line-329"> * This is another path to cleanup the chore, comparing to stop the stopper instance passed in.</span> |
| <span class="source-line-no">330</span><span id="line-330"> */</span> |
| <span class="source-line-no">331</span><span id="line-331"> public synchronized void shutdown(boolean mayInterruptIfRunning) {</span> |
| <span class="source-line-no">332</span><span id="line-332"> cancel(mayInterruptIfRunning);</span> |
| <span class="source-line-no">333</span><span id="line-333"> cleanup();</span> |
| <span class="source-line-no">334</span><span id="line-334"> }</span> |
| <span class="source-line-no">335</span><span id="line-335"></span> |
| <span class="source-line-no">336</span><span id="line-336"> /**</span> |
| <span class="source-line-no">337</span><span id="line-337"> * A summation of this chore in human readable format. Downstream users should not presume parsing</span> |
| <span class="source-line-no">338</span><span id="line-338"> * of this string can relaibly be done between versions. Instead, they should rely on the public</span> |
| <span class="source-line-no">339</span><span id="line-339"> * accessor methods to get the information they desire.</span> |
| <span class="source-line-no">340</span><span id="line-340"> */</span> |
| <span class="source-line-no">341</span><span id="line-341"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">342</span><span id="line-342"> @Override</span> |
| <span class="source-line-no">343</span><span id="line-343"> public String toString() {</span> |
| <span class="source-line-no">344</span><span id="line-344"> return "ScheduledChore name=" + getName() + ", period=" + getPeriod() + ", unit="</span> |
| <span class="source-line-no">345</span><span id="line-345"> + getTimeUnit();</span> |
| <span class="source-line-no">346</span><span id="line-346"> }</span> |
| <span class="source-line-no">347</span><span id="line-347">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
