| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class ControlledRealTimeReopenThread<T> |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class ControlledRealTimeReopenThread<T> |
| | Apache Lucene.NET 4.8.0-beta00013 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-beta00009/">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.Search.ControlledRealTimeReopenThread`1"> |
| |
| |
| <h1 id="Lucene_Net_Search_ControlledRealTimeReopenThread_1" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1" class="text-break">Class ControlledRealTimeReopenThread<T> |
| </h1> |
| <div class="markdown level0 summary"><p>Utility class that runs a thread to manage periodic |
| reopens of a <a class="xref" href="Lucene.Net.Search.ReferenceManager-1.html">ReferenceManager<G></a>, with methods to wait for a specific |
| index changes to become visible. To use this class you |
| must first wrap your <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> with a |
| <a class="xref" href="Lucene.Net.Index.TrackingIndexWriter.html">TrackingIndexWriter</a> and always use it to make changes |
| to the index, saving the returned generation. Then, |
| when a given search request needs to see a specific |
| index change, call the <a class="xref" href="Lucene.Net.Search.ControlledRealTimeReopenThread-1.html#Lucene_Net_Search_ControlledRealTimeReopenThread_1_WaitForGeneration_System_Int64_">WaitForGeneration(Int64)</a> to wait for |
| that change to be visible. Note that this will only |
| scale well if most searches do not need to wait for a |
| specific index generation. |
| <p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL 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"><span class="xref">J2N.Threading.ThreadJob</span></div> |
| <div class="level2"><span class="xref">ControlledRealTimeReopenThread<T></span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">System.IEquatable</span><<span class="xref">J2N.Threading.ThreadJob</span>></div> |
| <div><span class="xref">System.IEquatable</span><<span class="xref">System.Threading.Thread</span>></div> |
| <div><span class="xref">System.IDisposable</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.SafeRun(System.Threading.ThreadStart)</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Start()</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Interrupt()</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Join()</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Join(System.Int64)</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Join(System.Int64, System.Int32)</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Resume()</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Abort()</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Abort(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Yield()</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Suspend()</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Sleep(System.Int64)</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Sleep(System.Int64, System.Int32)</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Sleep(System.TimeSpan)</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Interrupted()</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Equals(System.Threading.Thread)</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Equals(J2N.Threading.ThreadJob)</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.ToString()</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.SyncRoot</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Instance</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.CurrentThread</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Name</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.State</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.Priority</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.IsAlive</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.IsBackground</span> |
| </div> |
| <div> |
| <span class="xref">J2N.Threading.ThreadJob.IsDebug</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</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> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.html">Lucene.Net.Search</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Search_ControlledRealTimeReopenThread_1_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class ControlledRealTimeReopenThread<T> : ThreadJob, IEquatable<ThreadJob>, IEquatable<Thread>, IDisposable where T : class</code></pre> |
| </div> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_ControlledRealTimeReopenThread_1__ctor_Lucene_Net_Index_TrackingIndexWriter_Lucene_Net_Search_ReferenceManager__0__System_Double_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Search.ControlledRealTimeReopenThread%601.%23ctor(Lucene.Net.Index.TrackingIndexWriter%2CLucene.Net.Search.ReferenceManager%7B%600%7D%2CSystem.Double%2CSystem.Double)%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/fix/apidocs-layout/src/Lucene.Net/Search/ControlledRealTimeReopenThread.cs/#L73">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_ControlledRealTimeReopenThread_1__ctor_" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_ControlledRealTimeReopenThread_1__ctor_Lucene_Net_Index_TrackingIndexWriter_Lucene_Net_Search_ReferenceManager__0__System_Double_System_Double_" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.#ctor(Lucene.Net.Index.TrackingIndexWriter,Lucene.Net.Search.ReferenceManager{`0},System.Double,System.Double)">ControlledRealTimeReopenThread(TrackingIndexWriter, ReferenceManager<T>, Double, Double)</h4> |
| <div class="markdown level1 summary"><p>Create <a class="xref" href="Lucene.Net.Search.ControlledRealTimeReopenThread-1.html">ControlledRealTimeReopenThread<T></a>, to periodically |
| reopen the a <a class="xref" href="Lucene.Net.Search.ReferenceManager-1.html">ReferenceManager<G></a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ControlledRealTimeReopenThread(TrackingIndexWriter writer, ReferenceManager<T> manager, double targetMaxStaleSec, double targetMinStaleSec)</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><a class="xref" href="Lucene.Net.Index.TrackingIndexWriter.html">TrackingIndexWriter</a></td> |
| <td><span class="parametername">writer</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.ReferenceManager-1.html">ReferenceManager</a><T></td> |
| <td><span class="parametername">manager</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">targetMaxStaleSec</span></td> |
| <td><p>Maximum time until a new |
| reader must be opened; this sets the upper bound |
| on how slowly reopens may occur, when no |
| caller is waiting for a specific generation to |
| become visible.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">targetMinStaleSec</span></td> |
| <td><p>Mininum time until a new |
| reader can be opened; this sets the lower bound |
| on how quickly reopens may occur, when a caller |
| is waiting for a specific generation to |
| become visible. </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_ControlledRealTimeReopenThread_1_Dispose.md&value=---%0Auid%3A%20Lucene.Net.Search.ControlledRealTimeReopenThread%601.Dispose%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/fix/apidocs-layout/src/Lucene.Net/Search/ControlledRealTimeReopenThread.cs/#L119">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_ControlledRealTimeReopenThread_1_Dispose_" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.Dispose*"></a> |
| <h4 id="Lucene_Net_Search_ControlledRealTimeReopenThread_1_Dispose" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.Dispose">Dispose()</h4> |
| <div class="markdown level1 summary"><p>Releases all resources used by the <a class="xref" href="Lucene.Net.Search.ControlledRealTimeReopenThread-1.html">ControlledRealTimeReopenThread<T></a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void Dispose()</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_ControlledRealTimeReopenThread_1_Dispose_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.ControlledRealTimeReopenThread%601.Dispose(System.Boolean)%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/fix/apidocs-layout/src/Lucene.Net/Search/ControlledRealTimeReopenThread.cs/#L133">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_ControlledRealTimeReopenThread_1_Dispose_" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.Dispose*"></a> |
| <h4 id="Lucene_Net_Search_ControlledRealTimeReopenThread_1_Dispose_System_Boolean_" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.Dispose(System.Boolean)">Dispose(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Releases resources used by the <a class="xref" href="Lucene.Net.Search.ControlledRealTimeReopenThread-1.html">ControlledRealTimeReopenThread<T></a> and |
| if overridden in a derived class, optionally releases unmanaged resources.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</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.Boolean</span></td> |
| <td><span class="parametername">disposing</span></td> |
| <td><p><code>true</code> to release both managed and unmanaged resources; |
| <code>false</code> to release only unmanaged resources.</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_ControlledRealTimeReopenThread_1_Run.md&value=---%0Auid%3A%20Lucene.Net.Search.ControlledRealTimeReopenThread%601.Run%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/fix/apidocs-layout/src/Lucene.Net/Search/ControlledRealTimeReopenThread.cs/#L232">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_ControlledRealTimeReopenThread_1_Run_" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.Run*"></a> |
| <h4 id="Lucene_Net_Search_ControlledRealTimeReopenThread_1_Run" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.Run">Run()</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 Run()</code></pre> |
| </div> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">J2N.Threading.ThreadJob.Run()</span></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_ControlledRealTimeReopenThread_1_WaitForGeneration_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Search.ControlledRealTimeReopenThread%601.WaitForGeneration(System.Int64)%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/fix/apidocs-layout/src/Lucene.Net/Search/ControlledRealTimeReopenThread.cs/#L166">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_ControlledRealTimeReopenThread_1_WaitForGeneration_" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.WaitForGeneration*"></a> |
| <h4 id="Lucene_Net_Search_ControlledRealTimeReopenThread_1_WaitForGeneration_System_Int64_" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.WaitForGeneration(System.Int64)">WaitForGeneration(Int64)</h4> |
| <div class="markdown level1 summary"><p>Waits for the target generation to become visible in |
| the searcher. |
| If the current searcher is older than the |
| target generation, this method will block |
| until the searcher is reopened, by another via |
| <a class="xref" href="Lucene.Net.Search.ReferenceManager-1.html#Lucene_Net_Search_ReferenceManager_1_MaybeRefresh">MaybeRefresh()</a> or until the <a class="xref" href="Lucene.Net.Search.ReferenceManager-1.html">ReferenceManager<G></a> is closed.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void WaitForGeneration(long targetGen)</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.Int64</span></td> |
| <td><span class="parametername">targetGen</span></td> |
| <td><p>The generation to wait for </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_ControlledRealTimeReopenThread_1_WaitForGeneration_System_Int64_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.ControlledRealTimeReopenThread%601.WaitForGeneration(System.Int64%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/fix/apidocs-layout/src/Lucene.Net/Search/ControlledRealTimeReopenThread.cs/#L189">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_ControlledRealTimeReopenThread_1_WaitForGeneration_" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.WaitForGeneration*"></a> |
| <h4 id="Lucene_Net_Search_ControlledRealTimeReopenThread_1_WaitForGeneration_System_Int64_System_Int32_" data-uid="Lucene.Net.Search.ControlledRealTimeReopenThread`1.WaitForGeneration(System.Int64,System.Int32)">WaitForGeneration(Int64, Int32)</h4> |
| <div class="markdown level1 summary"><p>Waits for the target generation to become visible in |
| the searcher, up to a maximum specified milli-seconds. |
| If the current searcher is older than the target |
| generation, this method will block until the |
| searcher has been reopened by another thread via |
| <a class="xref" href="Lucene.Net.Search.ReferenceManager-1.html#Lucene_Net_Search_ReferenceManager_1_MaybeRefresh">MaybeRefresh()</a>, the given waiting time has elapsed, or until |
| the <a class="xref" href="Lucene.Net.Search.ReferenceManager-1.html">ReferenceManager<G></a> is closed. |
| <p> |
| NOTE: if the waiting time elapses before the requested target generation is |
| available the current <a class="xref" href="Lucene.Net.Search.SearcherManager.html">SearcherManager</a> is returned instead.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool WaitForGeneration(long targetGen, int maxMS)</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.Int64</span></td> |
| <td><span class="parametername">targetGen</span></td> |
| <td><p>The generation to wait for </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxMS</span></td> |
| <td><p>Maximum milliseconds to wait, or -1 to wait indefinitely </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.Boolean</span></td> |
| <td><p><code>true</code> if the <code data-dev-comment-type="paramref" class="paramref">targetGen</code> is now available, |
| or false if <code data-dev-comment-type="paramref" class="paramref">maxMS</code> wait time was exceeded </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">System.IEquatable<T></span> |
| </div> |
| <div> |
| <span class="xref">System.IEquatable<T></span> |
| </div> |
| <div> |
| <span class="xref">System.IDisposable</span> |
| </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_ControlledRealTimeReopenThread_1.md&value=---%0Auid%3A%20Lucene.Net.Search.ControlledRealTimeReopenThread%601%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/fix/apidocs-layout/src/Lucene.Net/Search/ControlledRealTimeReopenThread.cs/#L43" 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 © 2020 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> |
