class ThreadMainBase in Tinman.Core.Threading

Abstract base class for IThreadMain implementations.

abstract class	ThreadMainBase	extends	Disposable
		implements	IThreadMain

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.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]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

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

RequestStop

Signals the running thread main method to terminate gracefully.

public virtual method	RequestStop ()
implements	IThreadMain.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.

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

WaitingForStop

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

public virtual method	WaitingForStop ()
implements	IThreadMain.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.

Protected / Methods

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected virtual method	DisposeManaged ()
inherited	Disposable.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method	DisposeUnmanaged ()
inherited	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.