| <!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.io.hfile, interface: BlockCache"> |
| <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.io.hfile;</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.Map;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Optional;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.Pair;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">/**</span> |
| <span class="source-line-no">028</span><span id="line-28"> * Block cache interface. Anything that implements the {@link Cacheable} interface can be put in the</span> |
| <span class="source-line-no">029</span><span id="line-29"> * cache.</span> |
| <span class="source-line-no">030</span><span id="line-30"> */</span> |
| <span class="source-line-no">031</span><span id="line-31">@InterfaceAudience.Private</span> |
| <span class="source-line-no">032</span><span id="line-32">public interface BlockCache extends Iterable<CachedBlock> {</span> |
| <span class="source-line-no">033</span><span id="line-33"> /**</span> |
| <span class="source-line-no">034</span><span id="line-34"> * Add block to cache.</span> |
| <span class="source-line-no">035</span><span id="line-35"> * @param cacheKey The block's cache key.</span> |
| <span class="source-line-no">036</span><span id="line-36"> * @param buf The block contents wrapped in a ByteBuffer.</span> |
| <span class="source-line-no">037</span><span id="line-37"> * @param inMemory Whether block should be treated as in-memory</span> |
| <span class="source-line-no">038</span><span id="line-38"> */</span> |
| <span class="source-line-no">039</span><span id="line-39"> void cacheBlock(BlockCacheKey cacheKey, Cacheable buf, boolean inMemory);</span> |
| <span class="source-line-no">040</span><span id="line-40"></span> |
| <span class="source-line-no">041</span><span id="line-41"> /**</span> |
| <span class="source-line-no">042</span><span id="line-42"> * Add block to cache.</span> |
| <span class="source-line-no">043</span><span id="line-43"> * @param cacheKey The block's cache key.</span> |
| <span class="source-line-no">044</span><span id="line-44"> * @param buf The block contents wrapped in a ByteBuffer.</span> |
| <span class="source-line-no">045</span><span id="line-45"> * @param inMemory Whether block should be treated as in-memory</span> |
| <span class="source-line-no">046</span><span id="line-46"> * @param waitWhenCache Whether to wait for the cache to be flushed mainly when BucketCache is</span> |
| <span class="source-line-no">047</span><span id="line-47"> * configured.</span> |
| <span class="source-line-no">048</span><span id="line-48"> */</span> |
| <span class="source-line-no">049</span><span id="line-49"> default void cacheBlock(BlockCacheKey cacheKey, Cacheable buf, boolean inMemory,</span> |
| <span class="source-line-no">050</span><span id="line-50"> boolean waitWhenCache) {</span> |
| <span class="source-line-no">051</span><span id="line-51"> cacheBlock(cacheKey, buf, inMemory);</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"> /**</span> |
| <span class="source-line-no">055</span><span id="line-55"> * Add block to cache (defaults to not in-memory).</span> |
| <span class="source-line-no">056</span><span id="line-56"> * @param cacheKey The block's cache key.</span> |
| <span class="source-line-no">057</span><span id="line-57"> * @param buf The object to cache.</span> |
| <span class="source-line-no">058</span><span id="line-58"> */</span> |
| <span class="source-line-no">059</span><span id="line-59"> void cacheBlock(BlockCacheKey cacheKey, Cacheable buf);</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> /**</span> |
| <span class="source-line-no">062</span><span id="line-62"> * Fetch block from cache.</span> |
| <span class="source-line-no">063</span><span id="line-63"> * @param cacheKey Block to fetch.</span> |
| <span class="source-line-no">064</span><span id="line-64"> * @param caching Whether this request has caching enabled (used for stats)</span> |
| <span class="source-line-no">065</span><span id="line-65"> * @param repeat Whether this is a repeat lookup for the same block (used to avoid</span> |
| <span class="source-line-no">066</span><span id="line-66"> * double counting cache misses when doing double-check locking)</span> |
| <span class="source-line-no">067</span><span id="line-67"> * @param updateCacheMetrics Whether to update cache metrics or not</span> |
| <span class="source-line-no">068</span><span id="line-68"> * @return Block or null if block is not in 2 cache.</span> |
| <span class="source-line-no">069</span><span id="line-69"> */</span> |
| <span class="source-line-no">070</span><span id="line-70"> Cacheable getBlock(BlockCacheKey cacheKey, boolean caching, boolean repeat,</span> |
| <span class="source-line-no">071</span><span id="line-71"> boolean updateCacheMetrics);</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"> * Fetch block from cache.</span> |
| <span class="source-line-no">075</span><span id="line-75"> * @param cacheKey Block to fetch.</span> |
| <span class="source-line-no">076</span><span id="line-76"> * @param caching Whether this request has caching enabled (used for stats)</span> |
| <span class="source-line-no">077</span><span id="line-77"> * @param repeat Whether this is a repeat lookup for the same block (used to avoid</span> |
| <span class="source-line-no">078</span><span id="line-78"> * double counting cache misses when doing double-check locking)</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @param updateCacheMetrics Whether to update cache metrics or not</span> |
| <span class="source-line-no">080</span><span id="line-80"> * @param blockType BlockType</span> |
| <span class="source-line-no">081</span><span id="line-81"> * @return Block or null if block is not in 2 cache.</span> |
| <span class="source-line-no">082</span><span id="line-82"> */</span> |
| <span class="source-line-no">083</span><span id="line-83"> default Cacheable getBlock(BlockCacheKey cacheKey, boolean caching, boolean repeat,</span> |
| <span class="source-line-no">084</span><span id="line-84"> boolean updateCacheMetrics, BlockType blockType) {</span> |
| <span class="source-line-no">085</span><span id="line-85"> return getBlock(cacheKey, caching, repeat, updateCacheMetrics);</span> |
| <span class="source-line-no">086</span><span id="line-86"> }</span> |
| <span class="source-line-no">087</span><span id="line-87"></span> |
| <span class="source-line-no">088</span><span id="line-88"> /**</span> |
| <span class="source-line-no">089</span><span id="line-89"> * Evict block from cache.</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @param cacheKey Block to evict</span> |
| <span class="source-line-no">091</span><span id="line-91"> * @return true if block existed and was evicted, false if not</span> |
| <span class="source-line-no">092</span><span id="line-92"> */</span> |
| <span class="source-line-no">093</span><span id="line-93"> boolean evictBlock(BlockCacheKey cacheKey);</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> /**</span> |
| <span class="source-line-no">096</span><span id="line-96"> * Evicts all blocks for the given HFile.</span> |
| <span class="source-line-no">097</span><span id="line-97"> * @return the number of blocks evicted</span> |
| <span class="source-line-no">098</span><span id="line-98"> */</span> |
| <span class="source-line-no">099</span><span id="line-99"> int evictBlocksByHfileName(String hfileName);</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"> * Get the statistics for this block cache.</span> |
| <span class="source-line-no">103</span><span id="line-103"> */</span> |
| <span class="source-line-no">104</span><span id="line-104"> CacheStats getStats();</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> /**</span> |
| <span class="source-line-no">107</span><span id="line-107"> * Shutdown the cache.</span> |
| <span class="source-line-no">108</span><span id="line-108"> */</span> |
| <span class="source-line-no">109</span><span id="line-109"> void shutdown();</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> /**</span> |
| <span class="source-line-no">112</span><span id="line-112"> * Returns the total size of the block cache, in bytes.</span> |
| <span class="source-line-no">113</span><span id="line-113"> * @return size of cache, in bytes</span> |
| <span class="source-line-no">114</span><span id="line-114"> */</span> |
| <span class="source-line-no">115</span><span id="line-115"> long size();</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"> * Returns the Max size of the block cache, in bytes.</span> |
| <span class="source-line-no">119</span><span id="line-119"> * @return size of cache, in bytes</span> |
| <span class="source-line-no">120</span><span id="line-120"> */</span> |
| <span class="source-line-no">121</span><span id="line-121"> long getMaxSize();</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> /**</span> |
| <span class="source-line-no">124</span><span id="line-124"> * Returns the free size of the block cache, in bytes.</span> |
| <span class="source-line-no">125</span><span id="line-125"> * @return free space in cache, in bytes</span> |
| <span class="source-line-no">126</span><span id="line-126"> */</span> |
| <span class="source-line-no">127</span><span id="line-127"> long getFreeSize();</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> /**</span> |
| <span class="source-line-no">130</span><span id="line-130"> * Returns the occupied size of the block cache, in bytes.</span> |
| <span class="source-line-no">131</span><span id="line-131"> * @return occupied space in cache, in bytes</span> |
| <span class="source-line-no">132</span><span id="line-132"> */</span> |
| <span class="source-line-no">133</span><span id="line-133"> long getCurrentSize();</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> /**</span> |
| <span class="source-line-no">136</span><span id="line-136"> * Returns the occupied size of data blocks, in bytes.</span> |
| <span class="source-line-no">137</span><span id="line-137"> * @return occupied space in cache, in bytes</span> |
| <span class="source-line-no">138</span><span id="line-138"> */</span> |
| <span class="source-line-no">139</span><span id="line-139"> long getCurrentDataSize();</span> |
| <span class="source-line-no">140</span><span id="line-140"></span> |
| <span class="source-line-no">141</span><span id="line-141"> /**</span> |
| <span class="source-line-no">142</span><span id="line-142"> * Returns the number of blocks currently cached in the block cache.</span> |
| <span class="source-line-no">143</span><span id="line-143"> * @return number of blocks in the cache</span> |
| <span class="source-line-no">144</span><span id="line-144"> */</span> |
| <span class="source-line-no">145</span><span id="line-145"> long getBlockCount();</span> |
| <span class="source-line-no">146</span><span id="line-146"></span> |
| <span class="source-line-no">147</span><span id="line-147"> /**</span> |
| <span class="source-line-no">148</span><span id="line-148"> * Returns the number of data blocks currently cached in the block cache.</span> |
| <span class="source-line-no">149</span><span id="line-149"> * @return number of blocks in the cache</span> |
| <span class="source-line-no">150</span><span id="line-150"> */</span> |
| <span class="source-line-no">151</span><span id="line-151"> long getDataBlockCount();</span> |
| <span class="source-line-no">152</span><span id="line-152"></span> |
| <span class="source-line-no">153</span><span id="line-153"> /** Returns Iterator over the blocks in the cache. */</span> |
| <span class="source-line-no">154</span><span id="line-154"> @Override</span> |
| <span class="source-line-no">155</span><span id="line-155"> Iterator<CachedBlock> iterator();</span> |
| <span class="source-line-no">156</span><span id="line-156"></span> |
| <span class="source-line-no">157</span><span id="line-157"> /** Returns The list of sub blockcaches that make up this one; returns null if no sub caches. */</span> |
| <span class="source-line-no">158</span><span id="line-158"> BlockCache[] getBlockCaches();</span> |
| <span class="source-line-no">159</span><span id="line-159"></span> |
| <span class="source-line-no">160</span><span id="line-160"> /**</span> |
| <span class="source-line-no">161</span><span id="line-161"> * Check if block type is meta or index block</span> |
| <span class="source-line-no">162</span><span id="line-162"> * @param blockType block type of a given HFile block</span> |
| <span class="source-line-no">163</span><span id="line-163"> * @return true if block type is non-data block</span> |
| <span class="source-line-no">164</span><span id="line-164"> */</span> |
| <span class="source-line-no">165</span><span id="line-165"> default boolean isMetaBlock(BlockType blockType) {</span> |
| <span class="source-line-no">166</span><span id="line-166"> return blockType != null && blockType.getCategory() != BlockType.BlockCategory.DATA;</span> |
| <span class="source-line-no">167</span><span id="line-167"> }</span> |
| <span class="source-line-no">168</span><span id="line-168"></span> |
| <span class="source-line-no">169</span><span id="line-169"> /**</span> |
| <span class="source-line-no">170</span><span id="line-170"> * Notifies the cache implementation that the given file has been fully cached (all its blocks</span> |
| <span class="source-line-no">171</span><span id="line-171"> * made into the cache).</span> |
| <span class="source-line-no">172</span><span id="line-172"> * @param fileName the file that has been completely cached.</span> |
| <span class="source-line-no">173</span><span id="line-173"> * @param totalBlockCount the total of blocks cached for this file.</span> |
| <span class="source-line-no">174</span><span id="line-174"> * @param dataBlockCount number of DATA block type cached.</span> |
| <span class="source-line-no">175</span><span id="line-175"> * @param size the size, in bytes, cached.</span> |
| <span class="source-line-no">176</span><span id="line-176"> */</span> |
| <span class="source-line-no">177</span><span id="line-177"> default void notifyFileCachingCompleted(Path fileName, int totalBlockCount, int dataBlockCount,</span> |
| <span class="source-line-no">178</span><span id="line-178"> long size) {</span> |
| <span class="source-line-no">179</span><span id="line-179"> // noop</span> |
| <span class="source-line-no">180</span><span id="line-180"> }</span> |
| <span class="source-line-no">181</span><span id="line-181"></span> |
| <span class="source-line-no">182</span><span id="line-182"> /**</span> |
| <span class="source-line-no">183</span><span id="line-183"> * Checks whether there's enough space left in the cache to accommodate the passed block. This</span> |
| <span class="source-line-no">184</span><span id="line-184"> * method may not be overridden by all implementing classes. In such cases, the returned Optional</span> |
| <span class="source-line-no">185</span><span id="line-185"> * will be empty. For subclasses implementing this logic, the returned Optional would contain the</span> |
| <span class="source-line-no">186</span><span id="line-186"> * boolean value reflecting if the passed block fits into the remaining cache space available.</span> |
| <span class="source-line-no">187</span><span id="line-187"> * @param block the block we want to check if fits into the cache.</span> |
| <span class="source-line-no">188</span><span id="line-188"> * @return empty optional if this method is not supported, otherwise the returned optional</span> |
| <span class="source-line-no">189</span><span id="line-189"> * contains the boolean value informing if the block fits into the cache available space.</span> |
| <span class="source-line-no">190</span><span id="line-190"> */</span> |
| <span class="source-line-no">191</span><span id="line-191"> default Optional<Boolean> blockFitsIntoTheCache(HFileBlock block) {</span> |
| <span class="source-line-no">192</span><span id="line-192"> return Optional.empty();</span> |
| <span class="source-line-no">193</span><span id="line-193"> }</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"> * Checks whether blocks for the passed file should be cached or not. This method may not be</span> |
| <span class="source-line-no">197</span><span id="line-197"> * overridden by all implementing classes. In such cases, the returned Optional will be empty. For</span> |
| <span class="source-line-no">198</span><span id="line-198"> * subclasses implementing this logic, the returned Optional would contain the boolean value</span> |
| <span class="source-line-no">199</span><span id="line-199"> * reflecting if the passed file should indeed be cached.</span> |
| <span class="source-line-no">200</span><span id="line-200"> * @param fileName to check if it should be cached.</span> |
| <span class="source-line-no">201</span><span id="line-201"> * @return empty optional if this method is not supported, otherwise the returned optional</span> |
| <span class="source-line-no">202</span><span id="line-202"> * contains the boolean value informing if the file should be cached.</span> |
| <span class="source-line-no">203</span><span id="line-203"> */</span> |
| <span class="source-line-no">204</span><span id="line-204"> default Optional<Boolean> shouldCacheFile(String fileName) {</span> |
| <span class="source-line-no">205</span><span id="line-205"> return Optional.empty();</span> |
| <span class="source-line-no">206</span><span id="line-206"> }</span> |
| <span class="source-line-no">207</span><span id="line-207"></span> |
| <span class="source-line-no">208</span><span id="line-208"> /**</span> |
| <span class="source-line-no">209</span><span id="line-209"> * Checks whether the block for the passed key is already cached. This method may not be</span> |
| <span class="source-line-no">210</span><span id="line-210"> * overridden by all implementing classes. In such cases, the returned Optional will be empty. For</span> |
| <span class="source-line-no">211</span><span id="line-211"> * subclasses implementing this logic, the returned Optional would contain the boolean value</span> |
| <span class="source-line-no">212</span><span id="line-212"> * reflecting if the block for the passed key is already cached or not.</span> |
| <span class="source-line-no">213</span><span id="line-213"> * @param key for the block we want to check if it's already in the cache.</span> |
| <span class="source-line-no">214</span><span id="line-214"> * @return empty optional if this method is not supported, otherwise the returned optional</span> |
| <span class="source-line-no">215</span><span id="line-215"> * contains the boolean value informing if the block is already cached.</span> |
| <span class="source-line-no">216</span><span id="line-216"> */</span> |
| <span class="source-line-no">217</span><span id="line-217"> default Optional<Boolean> isAlreadyCached(BlockCacheKey key) {</span> |
| <span class="source-line-no">218</span><span id="line-218"> return Optional.empty();</span> |
| <span class="source-line-no">219</span><span id="line-219"> }</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 an Optional containing the size of the block related to the passed key. If the block is</span> |
| <span class="source-line-no">223</span><span id="line-223"> * not in the cache, returned optional will be empty. Also, this method may not be overridden by</span> |
| <span class="source-line-no">224</span><span id="line-224"> * all implementing classes. In such cases, the returned Optional will be empty.</span> |
| <span class="source-line-no">225</span><span id="line-225"> * @param key for the block we want to check if it's already in the cache.</span> |
| <span class="source-line-no">226</span><span id="line-226"> * @return empty optional if this method is not supported, otherwise the returned optional</span> |
| <span class="source-line-no">227</span><span id="line-227"> * contains the boolean value informing if the block is already cached.</span> |
| <span class="source-line-no">228</span><span id="line-228"> */</span> |
| <span class="source-line-no">229</span><span id="line-229"> default Optional<Integer> getBlockSize(BlockCacheKey key) {</span> |
| <span class="source-line-no">230</span><span id="line-230"> return Optional.empty();</span> |
| <span class="source-line-no">231</span><span id="line-231"> }</span> |
| <span class="source-line-no">232</span><span id="line-232"></span> |
| <span class="source-line-no">233</span><span id="line-233"> /**</span> |
| <span class="source-line-no">234</span><span id="line-234"> * Returns an Optional containing the map of files that have been fully cached (all its blocks are</span> |
| <span class="source-line-no">235</span><span id="line-235"> * present in the cache. This method may not be overridden by all implementing classes. In such</span> |
| <span class="source-line-no">236</span><span id="line-236"> * cases, the returned Optional will be empty.</span> |
| <span class="source-line-no">237</span><span id="line-237"> * @return empty optional if this method is not supported, otherwise the returned optional</span> |
| <span class="source-line-no">238</span><span id="line-238"> * contains a map of all files that have been fully cached.</span> |
| <span class="source-line-no">239</span><span id="line-239"> */</span> |
| <span class="source-line-no">240</span><span id="line-240"> default Optional<Map<String, Pair<String, Long>>> getFullyCachedFiles() {</span> |
| <span class="source-line-no">241</span><span id="line-241"> return Optional.empty();</span> |
| <span class="source-line-no">242</span><span id="line-242"> }</span> |
| <span class="source-line-no">243</span><span id="line-243"></span> |
| <span class="source-line-no">244</span><span id="line-244"> /**</span> |
| <span class="source-line-no">245</span><span id="line-245"> * Returns an Optional containing a map of regions and the percentage of how much of it has been</span> |
| <span class="source-line-no">246</span><span id="line-246"> * cached so far.</span> |
| <span class="source-line-no">247</span><span id="line-247"> * @return empty optional if this method is not supported, otherwise the returned optional</span> |
| <span class="source-line-no">248</span><span id="line-248"> * contains a map of current regions caching percentage.</span> |
| <span class="source-line-no">249</span><span id="line-249"> */</span> |
| <span class="source-line-no">250</span><span id="line-250"> default Optional<Map<String, Long>> getRegionCachedInfo() {</span> |
| <span class="source-line-no">251</span><span id="line-251"> return Optional.empty();</span> |
| <span class="source-line-no">252</span><span id="line-252"> }</span> |
| <span class="source-line-no">253</span><span id="line-253"></span> |
| <span class="source-line-no">254</span><span id="line-254"> /**</span> |
| <span class="source-line-no">255</span><span id="line-255"> * Evict all blocks for the given file name between the passed offset values.</span> |
| <span class="source-line-no">256</span><span id="line-256"> * @param hfileName The file for which blocks should be evicted.</span> |
| <span class="source-line-no">257</span><span id="line-257"> * @param initOffset the initial offset for the range of blocks to be evicted.</span> |
| <span class="source-line-no">258</span><span id="line-258"> * @param endOffset the end offset for the range of blocks to be evicted.</span> |
| <span class="source-line-no">259</span><span id="line-259"> * @return number of blocks evicted.</span> |
| <span class="source-line-no">260</span><span id="line-260"> */</span> |
| <span class="source-line-no">261</span><span id="line-261"> default int evictBlocksRangeByHfileName(String hfileName, long initOffset, long endOffset) {</span> |
| <span class="source-line-no">262</span><span id="line-262"> return 0;</span> |
| <span class="source-line-no">263</span><span id="line-263"> }</span> |
| <span class="source-line-no">264</span><span id="line-264"></span> |
| <span class="source-line-no">265</span><span id="line-265"> /**</span> |
| <span class="source-line-no">266</span><span id="line-266"> * API to check whether or not, the cache is enabled.</span> |
| <span class="source-line-no">267</span><span id="line-267"> * @return returns true if the cache is enabled, false otherwise.</span> |
| <span class="source-line-no">268</span><span id="line-268"> */</span> |
| <span class="source-line-no">269</span><span id="line-269"> default boolean isCacheEnabled() {</span> |
| <span class="source-line-no">270</span><span id="line-270"> return true;</span> |
| <span class="source-line-no">271</span><span id="line-271"> }</span> |
| <span class="source-line-no">272</span><span id="line-272"></span> |
| <span class="source-line-no">273</span><span id="line-273"> /**</span> |
| <span class="source-line-no">274</span><span id="line-274"> * Wait for the bucket cache to be enabled while server restart</span> |
| <span class="source-line-no">275</span><span id="line-275"> * @param timeout time to wait for the bucket cache to be enable</span> |
| <span class="source-line-no">276</span><span id="line-276"> * @return boolean true if the bucket cache is enabled, false otherwise</span> |
| <span class="source-line-no">277</span><span id="line-277"> */</span> |
| <span class="source-line-no">278</span><span id="line-278"> default boolean waitForCacheInitialization(long timeout) {</span> |
| <span class="source-line-no">279</span><span id="line-279"> return true;</span> |
| <span class="source-line-no">280</span><span id="line-280"> }</span> |
| <span class="source-line-no">281</span><span id="line-281">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
