interface IThreadMain in Tinman.Core.Threading

Base interface for classes that provide a main method for a background thread.

interface	IThreadMain	extends	IDisposable
		base of	ThreadMainBase

Attributes

LifecycleState

Returns the lifecycle state of this object.

property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	ILifecycleState.LifecycleState

Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	IDisposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
method	Dispose ()
inherited	IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

RequestStop

Signals the running thread main method to terminate gracefully.

method

RequestStop ()

Remarks:

This method is called exactly once; either when the Stop method is invoked for the first time or when the thread is disposed.

Run

This is the main method of the thread.

method	Run (ThreadContext context)
params	context	[not-null]	The thread context object.

WaitingForStop

This method is invoked regularly when one thread has requested another one to stop and is waiting for its termination.

method

WaitingForStop ()

Remarks:

This callback allows a thread to perform actions while being blocked inside Join resp. Dispose (which implicitly joins on the thread), for example flushing buffers in order to avoid dead locks.