C# Class BEPUphysics.Threading.SpecializedThreadManager

Manages the engine's threads.

Separates the management of ThreadTasks and loops into specialized systems. Should have generally higher performance than the SimpleThreadManager.

Inheritance: IParallelLooper

Mostrar archivo Open project: Indiefreaks/igf Class Usage Examples

Public Methods

Method	Description
AddThread ( ) : void	Adds a new worker thread to the engine.
AddThread ( Action	Adds a new worker thread to the engine.
Dispose ( ) : void	Releases resources used by the object.
EnqueueTask ( Action	Enqueues a task to the thread manager. This should be safe to call from multiple threads and from other tasks.
ForLoop ( int startIndex, int endIndex, Action loopBody ) : void	Loops from the starting index (inclusive) to the ending index (exclusive), calling the loopBody at each iteration. The forLoop function will not return until all iterations are complete. This is meant to be used in a 'fork-join' model; only a single thread should be running a forLoop at any time.
RemoveThread ( ) : void	Removes a worker thread from the engine.
SpecializedThreadManager ( ) : System	Constructs a new specialized thread manager that manages loops and tasks separately.
WaitForTaskCompletion ( ) : void	Waits until all tasks enqueued using enqueueTask are complete.

Method Details

AddThread() public method

Adds a new worker thread to the engine.

public AddThread ( ) : void
return	void

AddThread() public method

Adds a new worker thread to the engine.

public AddThread ( Action
initialization	Action	Function that each of the new threads will call before entering its work loop. Note that this type of thread manager spawns two worker threads for each given thread; /// the initializer will run twice.
initializationInformation	object	Data to give the initializer.
return	void

Dispose() public method

Releases resources used by the object.

public Dispose ( ) : void
return	void

EnqueueTask() public method

Enqueues a task to the thread manager. This should be safe to call from multiple threads and from other tasks.

public EnqueueTask ( Action
taskBody	Action	Method to run.
taskInformation	object	Data to give to the task.
return	void

ForLoop() public method

Loops from the starting index (inclusive) to the ending index (exclusive), calling the loopBody at each iteration. The forLoop function will not return until all iterations are complete. This is meant to be used in a 'fork-join' model; only a single thread should be running a forLoop at any time.

public ForLoop ( int startIndex, int endIndex, Action loopBody ) : void
startIndex	int	Inclusive starting index.
endIndex	int	Exclusive ending index.
loopBody	Action	Function that handles an individual iteration of the loop.
return	void

RemoveThread() public method

Removes a worker thread from the engine.

public RemoveThread ( ) : void
return	void

SpecializedThreadManager() public method

Constructs a new specialized thread manager that manages loops and tasks separately.

public SpecializedThreadManager ( ) : System
return	System

WaitForTaskCompletion() public method

Waits until all tasks enqueued using enqueueTask are complete.

public WaitForTaskCompletion ( ) : void
return	void