| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class RecyclingByteBlockAllocator |
| | Apache Lucene.NET 4.8.0-beta00014 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class RecyclingByteBlockAllocator |
| | Apache Lucene.NET 4.8.0-beta00014 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="core/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00014/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator"> |
| |
| |
| <h1 id="Lucene_Net_Util_RecyclingByteBlockAllocator" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator" class="text-break">Class RecyclingByteBlockAllocator |
| </h1> |
| <div class="markdown level0 summary"><p>A <a class="xref" href="Lucene.Net.Util.ByteBlockPool.Allocator.html">ByteBlockPool.Allocator</a> implementation that recycles unused byte |
| blocks in a buffer and reuses them in subsequent calls to |
| <a class="xref" href="Lucene.Net.Util.RecyclingByteBlockAllocator.html#Lucene_Net_Util_RecyclingByteBlockAllocator_GetByteBlock">GetByteBlock()</a>. |
| <p> |
| Note: this class is not thread-safe. |
| </p></p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><a class="xref" href="Lucene.Net.Util.ByteBlockPool.Allocator.html">ByteBlockPool.Allocator</a></div> |
| <div class="level2"><span class="xref">RecyclingByteBlockAllocator</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.ByteBlockPool.Allocator.html#Lucene_Net_Util_ByteBlockPool_Allocator_m_blockSize">ByteBlockPool.Allocator.m_blockSize</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.ByteBlockPool.Allocator.html#Lucene_Net_Util_ByteBlockPool_Allocator_RecycleByteBlocks_System_Collections_Generic_IList_System_Byte____">ByteBlockPool.Allocator.RecycleByteBlocks(IList<Byte[]>)</a> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Util.html">Lucene.Net.Util</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Util_RecyclingByteBlockAllocator_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class RecyclingByteBlockAllocator : ByteBlockPool.Allocator</code></pre> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00014/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_RecyclingByteBlockAllocator__ctor.md&value=---%0Auid%3A%20Lucene.Net.Util.RecyclingByteBlockAllocator.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/docs/4.8.0-beta00014/src/Lucene.Net/Util/RecyclingByteBlockAllocator.cs/#L74">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_RecyclingByteBlockAllocator__ctor_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.#ctor*"></a> |
| <h4 id="Lucene_Net_Util_RecyclingByteBlockAllocator__ctor" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.#ctor">RecyclingByteBlockAllocator()</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Util.RecyclingByteBlockAllocator.html">RecyclingByteBlockAllocator</a> with a block size of |
| <a class="xref" href="Lucene.Net.Util.ByteBlockPool.html#Lucene_Net_Util_ByteBlockPool_BYTE_BLOCK_SIZE">BYTE_BLOCK_SIZE</a>, upper buffered docs limit of |
| <a class="xref" href="Lucene.Net.Util.RecyclingByteBlockAllocator.html#Lucene_Net_Util_RecyclingByteBlockAllocator_DEFAULT_BUFFERED_BLOCKS">DEFAULT_BUFFERED_BLOCKS</a> (64).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public RecyclingByteBlockAllocator()</code></pre> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00014/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_RecyclingByteBlockAllocator__ctor_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.RecyclingByteBlockAllocator.%23ctor(System.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/docs/4.8.0-beta00014/src/Lucene.Net/Util/RecyclingByteBlockAllocator.cs/#L64">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_RecyclingByteBlockAllocator__ctor_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.#ctor*"></a> |
| <h4 id="Lucene_Net_Util_RecyclingByteBlockAllocator__ctor_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.#ctor(System.Int32,System.Int32)">RecyclingByteBlockAllocator(Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Util.RecyclingByteBlockAllocator.html">RecyclingByteBlockAllocator</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public RecyclingByteBlockAllocator(int blockSize, int maxBufferedBlocks)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">blockSize</span></td> |
| <td><p>The block size in bytes. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxBufferedBlocks</span></td> |
| <td><p>Maximum number of buffered byte block. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00014/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_RecyclingByteBlockAllocator__ctor_System_Int32_System_Int32_Lucene_Net_Util_Counter_.md&value=---%0Auid%3A%20Lucene.Net.Util.RecyclingByteBlockAllocator.%23ctor(System.Int32%2CSystem.Int32%2CLucene.Net.Util.Counter)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/docs/4.8.0-beta00014/src/Lucene.Net/Util/RecyclingByteBlockAllocator.cs/#L49">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_RecyclingByteBlockAllocator__ctor_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.#ctor*"></a> |
| <h4 id="Lucene_Net_Util_RecyclingByteBlockAllocator__ctor_System_Int32_System_Int32_Lucene_Net_Util_Counter_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.#ctor(System.Int32,System.Int32,Lucene.Net.Util.Counter)">RecyclingByteBlockAllocator(Int32, Int32, Counter)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Util.RecyclingByteBlockAllocator.html">RecyclingByteBlockAllocator</a></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public RecyclingByteBlockAllocator(int blockSize, int maxBufferedBlocks, Counter bytesUsed)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">blockSize</span></td> |
| <td><p>The block size in bytes. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxBufferedBlocks</span></td> |
| <td><p>Maximum number of buffered byte block. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Counter.html">Counter</a></td> |
| <td><span class="parametername">bytesUsed</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Util.Counter.html">Counter</a> reference counting internally allocated bytes. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="fields">Fields |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00014/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_RecyclingByteBlockAllocator_DEFAULT_BUFFERED_BLOCKS.md&value=---%0Auid%3A%20Lucene.Net.Util.RecyclingByteBlockAllocator.DEFAULT_BUFFERED_BLOCKS%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/docs/4.8.0-beta00014/src/Lucene.Net/Util/RecyclingByteBlockAllocator.cs/#L38">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Util_RecyclingByteBlockAllocator_DEFAULT_BUFFERED_BLOCKS" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.DEFAULT_BUFFERED_BLOCKS">DEFAULT_BUFFERED_BLOCKS</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const int DEFAULT_BUFFERED_BLOCKS = 64</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00014/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_RecyclingByteBlockAllocator_BytesUsed.md&value=---%0Auid%3A%20Lucene.Net.Util.RecyclingByteBlockAllocator.BytesUsed%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/docs/4.8.0-beta00014/src/Lucene.Net/Util/RecyclingByteBlockAllocator.cs/#L119">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_RecyclingByteBlockAllocator_BytesUsed_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.BytesUsed*"></a> |
| <h4 id="Lucene_Net_Util_RecyclingByteBlockAllocator_BytesUsed" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.BytesUsed">BytesUsed</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public long BytesUsed { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><p>The number of bytes currently allocated by this <a class="xref" href="Lucene.Net.Util.ByteBlockPool.Allocator.html">ByteBlockPool.Allocator</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00014/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_RecyclingByteBlockAllocator_MaxBufferedBlocks.md&value=---%0Auid%3A%20Lucene.Net.Util.RecyclingByteBlockAllocator.MaxBufferedBlocks%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/docs/4.8.0-beta00014/src/Lucene.Net/Util/RecyclingByteBlockAllocator.cs/#L122">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_RecyclingByteBlockAllocator_MaxBufferedBlocks_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.MaxBufferedBlocks*"></a> |
| <h4 id="Lucene_Net_Util_RecyclingByteBlockAllocator_MaxBufferedBlocks" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.MaxBufferedBlocks">MaxBufferedBlocks</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int MaxBufferedBlocks { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><p>The maximum number of buffered byte blocks. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00014/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_RecyclingByteBlockAllocator_NumBufferedBlocks.md&value=---%0Auid%3A%20Lucene.Net.Util.RecyclingByteBlockAllocator.NumBufferedBlocks%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/docs/4.8.0-beta00014/src/Lucene.Net/Util/RecyclingByteBlockAllocator.cs/#L116">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_RecyclingByteBlockAllocator_NumBufferedBlocks_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.NumBufferedBlocks*"></a> |
| <h4 id="Lucene_Net_Util_RecyclingByteBlockAllocator_NumBufferedBlocks" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.NumBufferedBlocks">NumBufferedBlocks</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int NumBufferedBlocks { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><p>The number of currently buffered blocks. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00014/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_RecyclingByteBlockAllocator_FreeBlocks_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.RecyclingByteBlockAllocator.FreeBlocks(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/docs/4.8.0-beta00014/src/Lucene.Net/Util/RecyclingByteBlockAllocator.cs/#L130">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_RecyclingByteBlockAllocator_FreeBlocks_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.FreeBlocks*"></a> |
| <h4 id="Lucene_Net_Util_RecyclingByteBlockAllocator_FreeBlocks_System_Int32_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.FreeBlocks(System.Int32)">FreeBlocks(Int32)</h4> |
| <div class="markdown level1 summary"><p>Removes the given number of byte blocks from the buffer if possible.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int FreeBlocks(int num)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">num</span></td> |
| <td><p>The number of byte blocks to remove. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><p>The number of actually removed buffers. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00014/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_RecyclingByteBlockAllocator_GetByteBlock.md&value=---%0Auid%3A%20Lucene.Net.Util.RecyclingByteBlockAllocator.GetByteBlock%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/docs/4.8.0-beta00014/src/Lucene.Net/Util/RecyclingByteBlockAllocator.cs/#L79">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_RecyclingByteBlockAllocator_GetByteBlock_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.GetByteBlock*"></a> |
| <h4 id="Lucene_Net_Util_RecyclingByteBlockAllocator_GetByteBlock" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.GetByteBlock">GetByteBlock()</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override byte[] GetByteBlock()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Byte</span>[]</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Util.ByteBlockPool.Allocator.html#Lucene_Net_Util_ByteBlockPool_Allocator_GetByteBlock">ByteBlockPool.Allocator.GetByteBlock()</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00014/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_RecyclingByteBlockAllocator_RecycleByteBlocks_System_Byte_____System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.RecyclingByteBlockAllocator.RecycleByteBlocks(System.Byte%5B%5D%5B%5D%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/docs/4.8.0-beta00014/src/Lucene.Net/Util/RecyclingByteBlockAllocator.cs/#L91">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_RecyclingByteBlockAllocator_RecycleByteBlocks_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.RecycleByteBlocks*"></a> |
| <h4 id="Lucene_Net_Util_RecyclingByteBlockAllocator_RecycleByteBlocks_System_Byte_____System_Int32_System_Int32_" data-uid="Lucene.Net.Util.RecyclingByteBlockAllocator.RecycleByteBlocks(System.Byte[][],System.Int32,System.Int32)">RecycleByteBlocks(Byte[][], Int32, Int32)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override void RecycleByteBlocks(byte[][] blocks, int start, int end)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Byte</span>[][]</td> |
| <td><span class="parametername">blocks</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">start</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">end</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Util.ByteBlockPool.Allocator.html#Lucene_Net_Util_ByteBlockPool_Allocator_RecycleByteBlocks_System_Byte_____System_Int32_System_Int32_">ByteBlockPool.Allocator.RecycleByteBlocks(Byte[][], Int32, Int32)</a></div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00014/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_RecyclingByteBlockAllocator.md&value=---%0Auid%3A%20Lucene.Net.Util.RecyclingByteBlockAllocator%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/docs/4.8.0-beta00014/src/Lucene.Net/Util/RecyclingByteBlockAllocator.cs/#L32" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2021 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |