Class ControlledRealTimeReopenThread<T>

Utility class that runs a thread to manage periodic reopens of a ReferenceManager<G>, with methods to wait for a specific index changes to become visible. To use this class you must first wrap your IndexWriter with a TrackingIndexWriter 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 WaitForGeneration(Int64) 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.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk
Inheritance
System.Object
ThreadClass
ControlledRealTimeReopenThread<T>
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Search
Assembly: Lucene.Net.dll
Syntax
public class ControlledRealTimeReopenThread<T> : ThreadClass, IThreadRunnable, IDisposable where T : class
Type Parameters
Name Description
T

Constructors

| Improve this Doc View Source

ControlledRealTimeReopenThread(TrackingIndexWriter, ReferenceManager<T>, Double, Double)

Create ControlledRealTimeReopenThread<T>, to periodically reopen the a ReferenceManager<G>.

Declaration
public ControlledRealTimeReopenThread(TrackingIndexWriter writer, ReferenceManager<T> manager, double targetMaxStaleSec, double targetMinStaleSec)
Parameters
Type Name Description
TrackingIndexWriter writer
ReferenceManager<T> manager
System.Double targetMaxStaleSec

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.
System.Double targetMinStaleSec

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.

Methods

| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

Run()

Declaration
public override void Run()
Overrides
| Improve this Doc View Source

WaitForGeneration(Int64)

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 MaybeRefresh() or until the ReferenceManager<G> is closed.

Declaration
public virtual void WaitForGeneration(long targetGen)
Parameters
Type Name Description
System.Int64 targetGen

The generation to wait for

| Improve this Doc View Source

WaitForGeneration(Int64, Int32)

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 MaybeRefresh(), the given waiting time has elapsed, or until the ReferenceManager<G> is closed.

NOTE: if the waiting time elapses before the requested target generation is available the current SearcherManager is returned instead.

Declaration
public virtual bool WaitForGeneration(long targetGen, int maxMS)
Parameters
Type Name Description
System.Int64 targetGen

The generation to wait for

System.Int32 maxMS

Maximum milliseconds to wait, or -1 to wait indefinitely

Returns
Type Description
System.Boolean

true if the targetGen is now available, or false if maxMS wait time was exceeded

Implements

System.IDisposable

Extension Methods