Support class used to handle threads More...

Inherits Lucene.Net.Support.IThreadRunnable.

Inherited by Lucene.Net.Demo.Html.ParserThread, Lucene.Net.Index.ConcurrentMergeScheduler.MergeThread, and Lucene.Net.Search.TimeLimitingCollector.TimerThread.

Public Member Functions
	ThreadClass ()
	Initializes a new instance of the ThreadClass class

	ThreadClass (System.String Name)
	Initializes a new instance of the Thread class.

	ThreadClass (System.Threading.ThreadStart Start)
	Initializes a new instance of the Thread class.

	ThreadClass (System.Threading.ThreadStart Start, System.String Name)
	Initializes a new instance of the Thread class.

virtual void	Run ()
	This method has no functionality unless the method is overridden

virtual void	Start ()
	Causes the operating system to change the state of the current thread instance to ThreadState.Running

virtual void	Interrupt ()
	Interrupts a thread that is in the WaitSleepJoin thread state

void	SetDaemon (bool isDaemon)

void	Join ()
	Blocks the calling thread until a thread terminates

void	Join (long MiliSeconds)
	Blocks the calling thread until a thread terminates or the specified time elapses

void	Join (long MiliSeconds, int NanoSeconds)
	Blocks the calling thread until a thread terminates or the specified time elapses

void	Resume ()
	Resumes a thread that has been suspended

void	Abort ()
	Raises a ThreadAbortException in the thread on which it is invoked, to begin the process of terminating the thread. Calling this method usually terminates the thread

void	Abort (object stateInfo)
	Raises a ThreadAbortException in the thread on which it is invoked, to begin the process of terminating the thread while also providing exception information about the thread termination. Calling this method usually terminates the thread.

void	Suspend ()
	Suspends the thread, if the thread is already suspended it has no effect

override System.String	ToString ()
	Obtain a String that represents the current object

override bool	Equals (object obj)

override int	GetHashCode ()

Static Public Member Functions
static ThreadClass	CurrentThread ()

static void	Sleep (long ms)

static ThreadClass	Current ()
	Gets the currently running thread

static bool	operator== (ThreadClass t1, object t2)

static bool	operator!= (ThreadClass t1, object t2)

Properties
System.Threading.Thread	Instance `[get, set]`
	Gets the current thread instance

System.String	Name `[get, set]`
	Gets or sets the name of the thread

System.Threading.ThreadPriority	Priority `[get, set]`
	Gets or sets a value indicating the scheduling priority of a thread

bool	IsAlive `[get]`
	Gets a value indicating the execution status of the current thread

bool	IsBackground `[get, set]`
	Gets or sets a value indicating whether or not a thread is a background thread.

Detailed Description

Support class used to handle threads

Definition at line 30 of file ThreadClass.cs.

Constructor & Destructor Documentation

Lucene.Net.Support.ThreadClass.ThreadClass ( )

Initializes a new instance of the ThreadClass class

Definition at line 41 of file ThreadClass.cs.

Lucene.Net.Support.ThreadClass.ThreadClass ( System.String Name )

Initializes a new instance of the Thread class.

Parameters

Name	The name of the thread

Definition at line 50 of file ThreadClass.cs.

Lucene.Net.Support.ThreadClass.ThreadClass ( System.Threading.ThreadStart Start )

Initializes a new instance of the Thread class.

Parameters

Start A ThreadStart delegate that references the methods to be invoked when this thread begins executing

Definition at line 60 of file ThreadClass.cs.

Lucene.Net.Support.ThreadClass.ThreadClass	(	System.Threading.ThreadStart	Start,
		System.String	Name
	)

Initializes a new instance of the Thread class.

Parameters

Start	A ThreadStart delegate that references the methods to be invoked when this thread begins executing
Name	The name of the thread

Definition at line 70 of file ThreadClass.cs.

Member Function Documentation

void Lucene.Net.Support.ThreadClass.Abort ( )

Raises a ThreadAbortException in the thread on which it is invoked, to begin the process of terminating the thread. Calling this method usually terminates the thread

Definition at line 228 of file ThreadClass.cs.

void Lucene.Net.Support.ThreadClass.Abort ( object stateInfo )

Raises a ThreadAbortException in the thread on which it is invoked, to begin the process of terminating the thread while also providing exception information about the thread termination. Calling this method usually terminates the thread.

Parameters

stateInfo An object that contains application-specific information, such as state, which can be used by the thread being aborted

Definition at line 240 of file ThreadClass.cs.

static ThreadClass Lucene.Net.Support.ThreadClass.Current ( )

static

Gets the currently running thread

Returns: The currently running thread

Definition at line 282 of file ThreadClass.cs.

static ThreadClass Lucene.Net.Support.ThreadClass.CurrentThread ( )

static

Definition at line 266 of file ThreadClass.cs.

override bool Lucene.Net.Support.ThreadClass.Equals ( object obj )

Definition at line 303 of file ThreadClass.cs.

override int Lucene.Net.Support.ThreadClass.GetHashCode ( )

Definition at line 310 of file ThreadClass.cs.

virtual void Lucene.Net.Support.ThreadClass.Interrupt ( )

virtual

Interrupts a thread that is in the WaitSleepJoin thread state

Definition at line 94 of file ThreadClass.cs.

void Lucene.Net.Support.ThreadClass.Join ( )

Blocks the calling thread until a thread terminates

Definition at line 191 of file ThreadClass.cs.

void Lucene.Net.Support.ThreadClass.Join ( long MiliSeconds )

Blocks the calling thread until a thread terminates or the specified time elapses

Parameters

MiliSeconds Time of wait in milliseconds

Definition at line 200 of file ThreadClass.cs.

void Lucene.Net.Support.ThreadClass.Join	(	long	MiliSeconds,
		int	NanoSeconds
	)

Blocks the calling thread until a thread terminates or the specified time elapses

Parameters

MiliSeconds	Time of wait in milliseconds
NanoSeconds	Time of wait in nanoseconds

Definition at line 210 of file ThreadClass.cs.

static bool Lucene.Net.Support.ThreadClass.operator!=	(	ThreadClass	t1,
		object	t2
	)

static

Definition at line 298 of file ThreadClass.cs.

static bool Lucene.Net.Support.ThreadClass.operator==	(	ThreadClass	t1,
		object	t2
	)

static

Definition at line 292 of file ThreadClass.cs.

void Lucene.Net.Support.ThreadClass.Resume ( )

Resumes a thread that has been suspended

Definition at line 218 of file ThreadClass.cs.

virtual void Lucene.Net.Support.ThreadClass.Run ( )

virtual

This method has no functionality unless the method is overridden

Implements Lucene.Net.Support.IThreadRunnable.

Reimplemented in Lucene.Net.Index.ConcurrentMergeScheduler.MergeThread, and Lucene.Net.Demo.Html.ParserThread.

Definition at line 79 of file ThreadClass.cs.

void Lucene.Net.Support.ThreadClass.SetDaemon ( bool isDaemon )

Definition at line 130 of file ThreadClass.cs.

static void Lucene.Net.Support.ThreadClass.Sleep ( long ms )

static

Definition at line 271 of file ThreadClass.cs.

virtual void Lucene.Net.Support.ThreadClass.Start ( )

virtual

Causes the operating system to change the state of the current thread instance to ThreadState.Running

Definition at line 86 of file ThreadClass.cs.

void Lucene.Net.Support.ThreadClass.Suspend ( )

Suspends the thread, if the thread is already suspended it has no effect

Definition at line 248 of file ThreadClass.cs.

override System.String Lucene.Net.Support.ThreadClass.ToString ( )

Obtain a String that represents the current object

Returns: A String that represents the current object

Definition at line 257 of file ThreadClass.cs.

Property Documentation

System.Threading.Thread Lucene.Net.Support.ThreadClass.Instance

getset

Gets the current thread instance

Definition at line 103 of file ThreadClass.cs.

bool Lucene.Net.Support.ThreadClass.IsAlive

get

Gets a value indicating the execution status of the current thread

Definition at line 166 of file ThreadClass.cs.

bool Lucene.Net.Support.ThreadClass.IsBackground

getset

Gets or sets a value indicating whether or not a thread is a background thread.

Definition at line 177 of file ThreadClass.cs.

System.String Lucene.Net.Support.ThreadClass.Name

getset

Gets or sets the name of the thread

Definition at line 118 of file ThreadClass.cs.

System.Threading.ThreadPriority Lucene.Net.Support.ThreadClass.Priority

getset

Gets or sets a value indicating the scheduling priority of a thread

Definition at line 139 of file ThreadClass.cs.

The documentation for this class was generated from the following file:

core/Support/ThreadClass.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation