| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SharedMemHFileBlock (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.io.hfile, class: SharedMemHFileBlock"> |
| <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/SharedMemHFileBlock.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><a href="#nested-class-summary">Nested</a> | </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>Field | </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.io.hfile</a></div> |
| <h1 title="Class SharedMemHFileBlock" class="title">Class SharedMemHFileBlock</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="HFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile">org.apache.hadoop.hbase.io.hfile.HFileBlock</a> |
| <div class="inheritance">org.apache.hadoop.hbase.io.hfile.SharedMemHFileBlock</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a></code>, <code><a href="Cacheable.html" title="interface in org.apache.hadoop.hbase.io.hfile">Cacheable</a></code>, <code><a href="../../nio/HBaseReferenceCounted.html" title="interface in org.apache.hadoop.hbase.nio">HBaseReferenceCounted</a></code>, <code>org.apache.hbase.thirdparty.io.netty.util.ReferenceCounted</code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/SharedMemHFileBlock.html#line-31">SharedMemHFileBlock</a></span> |
| <span class="extends-implements">extends <a href="HFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock</a></span></div> |
| <div class="block">The <a href="../ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io"><code>ByteBuffAllocator</code></a> won't allocate pooled heap <a href="../../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio"><code>ByteBuff</code></a> now; at the same time, |
| if allocate an off-heap <a href="../../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio"><code>ByteBuff</code></a> from allocator, then it must be a pooled one. That's to |
| say, an exclusive memory HFileBlock would must be an heap block and a shared memory HFileBlock |
| would must be an off-heap block.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="ExclusiveMemHFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>ExclusiveMemHFileBlock</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.hadoop.hbase.io.hfile.HFileBlock">Nested classes/interfaces inherited from class org.apache.hadoop.hbase.io.hfile.<a href="HFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock</a></h2> |
| <code><a href="HFileBlock.BlockDeserializer.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock.BlockDeserializer</a>, <a href="HFileBlock.BlockIterator.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileBlock.BlockIterator</a>, <a href="HFileBlock.BlockWritable.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileBlock.BlockWritable</a>, <a href="HFileBlock.FSReader.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileBlock.FSReader</a>, <a href="HFileBlock.FSReaderImpl.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock.FSReaderImpl</a>, <a href="HFileBlock.Header.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock.Header</a>, <a href="HFileBlock.Writer.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock.Writer</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.io.hfile.HFileBlock">Fields inherited from class org.apache.hadoop.hbase.io.hfile.<a href="HFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock</a></h3> |
| <code><a href="HFileBlock.html#BLOCK_DESERIALIZER">BLOCK_DESERIALIZER</a>, <a href="HFileBlock.html#BLOCK_METADATA_SPACE">BLOCK_METADATA_SPACE</a>, <a href="HFileBlock.html#CHECKSUM_SIZE">CHECKSUM_SIZE</a>, <a href="HFileBlock.html#CHECKSUM_VERIFICATION_NUM_IO_THRESHOLD">CHECKSUM_VERIFICATION_NUM_IO_THRESHOLD</a>, <a href="HFileBlock.html#DONT_FILL_HEADER">DONT_FILL_HEADER</a>, <a href="HFileBlock.html#DUMMY_HEADER_NO_CHECKSUM">DUMMY_HEADER_NO_CHECKSUM</a>, <a href="HFileBlock.html#FILL_HEADER">FILL_HEADER</a>, <a href="HFileBlock.html#FIXED_OVERHEAD">FIXED_OVERHEAD</a>, <a href="HFileBlock.html#MULTI_BYTE_BUFFER_HEAP_SIZE">MULTI_BYTE_BUFFER_HEAP_SIZE</a></code></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(org.apache.hadoop.hbase.io.hfile.BlockType,int,int,long,org.apache.hadoop.hbase.nio.ByteBuff,boolean,long,int,int,org.apache.hadoop.hbase.io.hfile.HFileContext,org.apache.hadoop.hbase.io.ByteBuffAllocator)" class="member-name-link">SharedMemHFileBlock</a><wbr>(<a href="BlockType.html" title="enum class in org.apache.hadoop.hbase.io.hfile">BlockType</a> blockType, |
| int onDiskSizeWithoutHeader, |
| int uncompressedSizeWithoutHeader, |
| long prevBlockOffset, |
| <a href="../../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a> buf, |
| boolean fillHeader, |
| long offset, |
| int nextBlockOnDiskSize, |
| int onDiskDataSizeWithHeader, |
| <a href="HFileContext.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileContext</a> fileContext, |
| <a href="../ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a> alloc)</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSharedMem()" class="member-name-link">isSharedMem</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Will be override by <a href="SharedMemHFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>SharedMemHFileBlock</code></a> or <a href="ExclusiveMemHFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>ExclusiveMemHFileBlock</code></a>.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.io.hfile.HFileBlock">Methods inherited from class org.apache.hadoop.hbase.io.hfile.<a href="HFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock</a></h3> |
| <code><a href="HFileBlock.html#createFromBuff(org.apache.hadoop.hbase.nio.ByteBuff,boolean,long,int,org.apache.hadoop.hbase.io.hfile.HFileContext,org.apache.hadoop.hbase.io.ByteBuffAllocator)">createFromBuff</a>, <a href="HFileBlock.html#deepCloneOnHeap(org.apache.hadoop.hbase.io.hfile.HFileBlock)">deepCloneOnHeap</a>, <a href="HFileBlock.html#equals(java.lang.Object)">equals</a>, <a href="HFileBlock.html#getBlockType()">getBlockType</a>, <a href="HFileBlock.html#getBufferReadOnly()">getBufferReadOnly</a>, <a href="HFileBlock.html#getBufferWithoutHeader()">getBufferWithoutHeader</a>, <a href="HFileBlock.html#getByteBuffAllocator()">getByteBuffAllocator</a>, <a href="HFileBlock.html#getBytesPerChecksum()">getBytesPerChecksum</a>, <a href="HFileBlock.html#getByteStream()">getByteStream</a>, <a href="HFileBlock.html#getChecksumType()">getChecksumType</a>, <a href="HFileBlock.html#getDataBlockEncoding()">getDataBlockEncoding</a>, <a href="HFileBlock.html#getDataBlockEncodingId()">getDataBlockEncodingId</a>, <a href="HFileBlock.html#getDeserializer()">getDeserializer</a>, <a href="HFileBlock.html#getDummyHeaderForVersion()">getDummyHeaderForVersion</a>, <a href="HFileBlock.html#getHFileContext()">getHFileContext</a>, <a href="HFileBlock.html#getMetaData(java.nio.ByteBuffer)">getMetaData</a>, <a href="HFileBlock.html#getNextBlockOnDiskSize()">getNextBlockOnDiskSize</a>, <a href="HFileBlock.html#getOffset()">getOffset</a>, <a href="HFileBlock.html#getOnDiskDataSizeWithHeader()">getOnDiskDataSizeWithHeader</a>, <a href="HFileBlock.html#getOnDiskSizeWithHeader()">getOnDiskSizeWithHeader</a>, <a href="HFileBlock.html#getOnDiskSizeWithoutHeader()">getOnDiskSizeWithoutHeader</a>, <a href="HFileBlock.html#getPrevBlockOffset()">getPrevBlockOffset</a>, <a href="HFileBlock.html#getSerializedLength()">getSerializedLength</a>, <a href="HFileBlock.html#getUncompressedSizeWithoutHeader()">getUncompressedSizeWithoutHeader</a>, <a href="HFileBlock.html#hashCode()">hashCode</a>, <a href="HFileBlock.html#headerSize()">headerSize</a>, <a href="HFileBlock.html#headerSize(boolean)">headerSize</a>, <a href="HFileBlock.html#heapSize()">heapSize</a>, <a href="HFileBlock.html#isUnpacked()">isUnpacked</a>, <a href="HFileBlock.html#refCnt()">refCnt</a>, <a href="HFileBlock.html#release()">release</a>, <a href="HFileBlock.html#retain()">retain</a>, <a href="HFileBlock.html#sanityCheck()">sanityCheck</a>, <a href="HFileBlock.html#sanityCheckUncompressed()">sanityCheckUncompressed</a>, <a href="HFileBlock.html#serialize(java.nio.ByteBuffer,boolean)">serialize</a>, <a href="HFileBlock.html#toString()">toString</a>, <a href="HFileBlock.html#toStringHeader(org.apache.hadoop.hbase.nio.ByteBuff)">toStringHeader</a>, <a href="HFileBlock.html#totalChecksumBytes()">totalChecksumBytes</a>, <a href="HFileBlock.html#touch()">touch</a>, <a href="HFileBlock.html#touch(java.lang.Object)">touch</a>, <a href="HFileBlock.html#unpack(org.apache.hadoop.hbase.io.hfile.HFileContext,org.apache.hadoop.hbase.io.hfile.HFileBlock.FSReader)">unpack</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#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#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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.nio.HBaseReferenceCounted">Methods inherited from interface org.apache.hadoop.hbase.nio.<a href="../../nio/HBaseReferenceCounted.html" title="interface in org.apache.hadoop.hbase.nio">HBaseReferenceCounted</a></h3> |
| <code><a href="../../nio/HBaseReferenceCounted.html#release(int)">release</a>, <a href="../../nio/HBaseReferenceCounted.html#retain(int)">retain</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.hbase.io.hfile.BlockType,int,int,long,org.apache.hadoop.hbase.nio.ByteBuff,boolean,long,int,int,org.apache.hadoop.hbase.io.hfile.HFileContext,org.apache.hadoop.hbase.io.ByteBuffAllocator)"> |
| <h3>SharedMemHFileBlock</h3> |
| <div class="member-signature"><span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/SharedMemHFileBlock.html#line-34">SharedMemHFileBlock</a></span><wbr><span class="parameters">(<a href="BlockType.html" title="enum class in org.apache.hadoop.hbase.io.hfile">BlockType</a> blockType, |
| int onDiskSizeWithoutHeader, |
| int uncompressedSizeWithoutHeader, |
| long prevBlockOffset, |
| <a href="../../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a> buf, |
| boolean fillHeader, |
| long offset, |
| int nextBlockOnDiskSize, |
| int onDiskDataSizeWithHeader, |
| <a href="HFileContext.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileContext</a> fileContext, |
| <a href="../ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a> alloc)</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="isSharedMem()"> |
| <h3>isSharedMem</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/io/hfile/SharedMemHFileBlock.html#line-42">isSharedMem</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="HFileBlock.html#isSharedMem()">HFileBlock</a></code></span></div> |
| <div class="block">Will be override by <a href="SharedMemHFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>SharedMemHFileBlock</code></a> or <a href="ExclusiveMemHFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>ExclusiveMemHFileBlock</code></a>. Return true |
| by default.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="HFileBlock.html#isSharedMem()">isSharedMem</a></code> in class <code><a href="HFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock</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> |
