Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class TimeLimitingCollector.TimerThread

    Thread used to timeout search requests. Can be stopped completely with StopTimer()

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Inheritance
    object
    ThreadJob
    TimeLimitingCollector.TimerThread
    Implements
    IEquatable<ThreadJob>
    IEquatable<Thread>
    Inherited Members
    ThreadJob.Start()
    ThreadJob.Interrupt()
    ThreadJob.Join()
    ThreadJob.Join(long)
    ThreadJob.Join(long, int)
    ThreadJob.Resume()
    ThreadJob.Yield()
    ThreadJob.Suspend()
    ThreadJob.Sleep(long)
    ThreadJob.Sleep(long, int)
    ThreadJob.Sleep(TimeSpan)
    ThreadJob.Interrupted()
    ThreadJob.Equals(Thread)
    ThreadJob.Equals(ThreadJob)
    ThreadJob.Equals(object)
    ThreadJob.GetHashCode()
    ThreadJob.ToString()
    ThreadJob.SyncRoot
    ThreadJob.Instance
    ThreadJob.CurrentThread
    ThreadJob.Name
    ThreadJob.State
    ThreadJob.Priority
    ThreadJob.IsAlive
    ThreadJob.IsBackground
    ThreadJob.IsDebug
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Search
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class TimeLimitingCollector.TimerThread : ThreadJob, IEquatable<ThreadJob>, IEquatable<Thread>

    Constructors

    TimerThread(Counter)

    Thread used to timeout search requests. Can be stopped completely with StopTimer()

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Declaration
    public TimerThread(Counter counter)
    Parameters
    Type Name Description
    Counter counter

    TimerThread(long, Counter)

    Thread used to timeout search requests. Can be stopped completely with StopTimer()

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Declaration
    public TimerThread(long resolution, Counter counter)
    Parameters
    Type Name Description
    long resolution
    Counter counter

    Fields

    DEFAULT_RESOLUTION

    Thread used to timeout search requests. Can be stopped completely with StopTimer()

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Declaration
    public const int DEFAULT_RESOLUTION = 20
    Field Value
    Type Description
    int

    THREAD_NAME

    Thread used to timeout search requests. Can be stopped completely with StopTimer()

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Declaration
    public const string THREAD_NAME = "TimeLimitedCollector timer thread"
    Field Value
    Type Description
    string

    Properties

    Milliseconds

    Get the timer value in milliseconds.

    Declaration
    public long Milliseconds { get; }
    Property Value
    Type Description
    long

    Resolution

    Return the timer resolution.

    Declaration
    public long Resolution { get; set; }
    Property Value
    Type Description
    long

    Methods

    Run()

    Invokes the ThreadStart delegate that was passed into the constructor. If no ThreadStart was set, does nothing. Alternatively, this method may be overridden by subclasses to provide an implementation for the thread to run.

    Declaration
    public override void Run()
    Overrides
    J2N.Threading.ThreadJob.Run()

    StopTimer()

    Stops the timer thread

    Declaration
    public void StopTimer()

    Implements

    IEquatable<T>
    IEquatable<T>
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.