C# Класс EpLibrary.cs.BaseWorkerThread

A class that implements Base Worker Thread Class.

Наследование: ThreadEx

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
m_callBackFunc	Action
m_callBackLock	Object
m_jobProcessor	EpLibrary.cs.BaseJobProcessor
m_lifePolicy	ThreadLifePolicy
m_workPool	JobScheduleQueue

Открытые методы

Метод	Описание
BaseWorkerThread ( BaseWorkerThread b ) : System	Default copy constructor
BaseWorkerThread ( ThreadLifePolicy policy ) : System	Default Constructor
Erase ( BaseJob work ) : bool	Erase the given work from the work pool.
Front ( ) : BaseJob	Get First Job in the Job Queue.
GetJobCount ( ) : int	Get job count in work pool.
GetJobProcessor ( ) : EpLibrary.cs.BaseJobProcessor	Get Job Processor.
GetLifePolicy ( ) : ThreadLifePolicy	Return the life policy of this worker thread.
Pop ( ) : BaseJob	Pop a work from the work pool.
Push ( BaseJob work ) : void	Push in the new work to the work pool.
SetCallBackClass ( Action callBackFunc ) : void	Set call back class to call when work is done.
SetJobProcessor ( EpLibrary.cs.BaseJobProcessor jobProcessor ) : void	Set new Job Processor.
TerminateWorker ( int waitTimeInMilliSec = Timeout.Infinite ) : TerminateResult	Wait for worker thread to terminate, and if not terminated, then Terminate.

Защищенные методы

Метод	Описание
callCallBack ( ) : void	Call the Call Back Class if callback class is assigned.
execute ( ) : void	Pure Worker Thread Code.

Описание методов

BaseWorkerThread() публичный Метод

Default copy constructor

public BaseWorkerThread ( BaseWorkerThread b ) : System
b	BaseWorkerThread	the object to copy from
Результат	System

BaseWorkerThread() публичный Метод

Default Constructor

public BaseWorkerThread ( ThreadLifePolicy policy ) : System
policy	ThreadLifePolicy	the life policy of this worker thread.
Результат	System

Erase() публичный Метод

Erase the given work from the work pool.

public Erase ( BaseJob work ) : bool
work	BaseJob	the work to erase from the work pool
Результат	bool

Front() публичный Метод

Get First Job in the Job Queue.

public Front ( ) : BaseJob
Результат	BaseJob

GetJobCount() публичный Метод

Get job count in work pool.

public GetJobCount ( ) : int
Результат	int

GetJobProcessor() публичный Метод

Get Job Processor.

public GetJobProcessor ( ) : EpLibrary.cs.BaseJobProcessor
Результат	EpLibrary.cs.BaseJobProcessor

GetLifePolicy() публичный Метод

Return the life policy of this worker thread.

public GetLifePolicy ( ) : ThreadLifePolicy
Результат	ThreadLifePolicy

Pop() публичный Метод

Pop a work from the work pool.

public Pop ( ) : BaseJob
Результат	BaseJob

Push() публичный Метод

Push in the new work to the work pool.

public Push ( BaseJob work ) : void
work	BaseJob	the new work to put into the work pool.
Результат	void

SetCallBackClass() публичный Метод

Set call back class to call when work is done.

public SetCallBackClass ( Action callBackFunc ) : void
callBackFunc	Action	the call back function.
Результат	void

SetJobProcessor() публичный Метод

Set new Job Processor.

public SetJobProcessor ( EpLibrary.cs.BaseJobProcessor jobProcessor ) : void
jobProcessor	EpLibrary.cs.BaseJobProcessor	set new Job Processor for this thread.
Результат	void

TerminateWorker() публичный Метод

Wait for worker thread to terminate, and if not terminated, then Terminate.

public TerminateWorker ( int waitTimeInMilliSec = Timeout.Infinite ) : TerminateResult
waitTimeInMilliSec	int	the time-out interval, in milliseconds.
Результат	TerminateResult

callCallBack() защищенный Метод

Call the Call Back Class if callback class is assigned.

protected callCallBack ( ) : void
Результат	void

execute() защищенный абстрактный Метод

Pure Worker Thread Code.

protected abstract execute ( ) : void
Результат	void

Описание свойств

m_callBackFunc защищенное свойство

the call back class

protected Action m_callBackFunc
Результат	Action

m_callBackLock защищенное свойство

callback Lock

protected Object m_callBackLock
Результат	Object

m_jobProcessor защищенное свойство

Job Processor

protected BaseJobProcessor,EpLibrary.cs m_jobProcessor
Результат	EpLibrary.cs.BaseJobProcessor

m_lifePolicy защищенное свойство

the life policy of the thread

protected ThreadLifePolicy m_lifePolicy
Результат	ThreadLifePolicy

m_workPool защищенное свойство

the work list

protected JobScheduleQueue m_workPool
Результат	JobScheduleQueue