blob: 45ce5e42a9cf3dad583bda22ce59cfbe23dce570 [file] [log] [blame]
<!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.mob, class: MobCell">
<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.mob;</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.io.Closeable;</span>
<span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.Cell;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.ExtendedCell;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.regionserver.StoreFileScanner;</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"> * The MobCell will maintain a {@link Cell} and a {@link StoreFileScanner} inside. Now, the mob cell</span>
<span class="source-line-no">029</span><span id="line-29"> * is backend by NIO ByteBuffers which are allocated from ByteBuffAllocator, so we cannot just read</span>
<span class="source-line-no">030</span><span id="line-30"> * the cell and close the MOB file scanner because the MOB file scanner closing will deallocate the</span>
<span class="source-line-no">031</span><span id="line-31"> * NIO ByteBuffers, which resulting memory leak.</span>
<span class="source-line-no">032</span><span id="line-32"> * &lt;p&gt;</span>
<span class="source-line-no">033</span><span id="line-33"> * Actually, the right solution is: &lt;br&gt;</span>
<span class="source-line-no">034</span><span id="line-34"> * 1. Read the normal cell; &lt;br&gt;</span>
<span class="source-line-no">035</span><span id="line-35"> * 2. Parse the value of normal cell and get MOB fileName,offset,length; &lt;br&gt;</span>
<span class="source-line-no">036</span><span id="line-36"> * 3. Open scanner to read the mob value; &lt;br&gt;</span>
<span class="source-line-no">037</span><span id="line-37"> * 4. Construct the response cell whose key is from the normal cell and value is from the mob cell.</span>
<span class="source-line-no">038</span><span id="line-38"> * &lt;br&gt;</span>
<span class="source-line-no">039</span><span id="line-39"> * 5. Ship the response cell to HBase client. &lt;br&gt;</span>
<span class="source-line-no">040</span><span id="line-40"> * 6. Release both normal cell's block and mob cell's block. &lt;br&gt;</span>
<span class="source-line-no">041</span><span id="line-41"> * &lt;p&gt;</span>
<span class="source-line-no">042</span><span id="line-42"> * For mob cell, the block releasing just means closing the the mob scanner, so here we need to keep</span>
<span class="source-line-no">043</span><span id="line-43"> * the {@link StoreFileScanner} inside and close only when we're ensure that the MobCell has been</span>
<span class="source-line-no">044</span><span id="line-44"> * shipped to RPC client.</span>
<span class="source-line-no">045</span><span id="line-45"> */</span>
<span class="source-line-no">046</span><span id="line-46">@InterfaceAudience.Private</span>
<span class="source-line-no">047</span><span id="line-47">public class MobCell implements Closeable {</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> private final ExtendedCell cell;</span>
<span class="source-line-no">050</span><span id="line-50"> private final StoreFileScanner sfScanner;</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> public MobCell(ExtendedCell cell) {</span>
<span class="source-line-no">053</span><span id="line-53"> this.cell = cell;</span>
<span class="source-line-no">054</span><span id="line-54"> this.sfScanner = null;</span>
<span class="source-line-no">055</span><span id="line-55"> }</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> public MobCell(ExtendedCell cell, StoreFileScanner sfScanner) {</span>
<span class="source-line-no">058</span><span id="line-58"> this.cell = cell;</span>
<span class="source-line-no">059</span><span id="line-59"> this.sfScanner = sfScanner;</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"> public ExtendedCell getCell() {</span>
<span class="source-line-no">063</span><span id="line-63"> return cell;</span>
<span class="source-line-no">064</span><span id="line-64"> }</span>
<span class="source-line-no">065</span><span id="line-65"></span>
<span class="source-line-no">066</span><span id="line-66"> @Override</span>
<span class="source-line-no">067</span><span id="line-67"> public void close() throws IOException {</span>
<span class="source-line-no">068</span><span id="line-68"> if (this.sfScanner != null) {</span>
<span class="source-line-no">069</span><span id="line-69"> this.sfScanner.close();</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72">}</span>
</pre>
</div>
</main>
</body>
</html>