C# Class BEPUphysics.Threading.ThreadManagerTPL

Uses the .NET Task Parallel library to manage the engine's threads.
Inheritance: IThreadManager
Datei anzeigen Open project: Indiefreaks/igf

Public Methods

Method Description
AddThread ( ) : void

Notifies the thread manager that it should use another thread.
AddThread ( Action initialization, object initializationInformation ) : void

Notifies the thread manager that it should use another thread.
Dispose ( ) : void

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
EnqueueTask ( Action taskBody, object taskInformation ) : void

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

Notifies the thread manager that it should decrease the number of threads used.
ThreadManagerTPL ( ) : System

Constructs the TPL thread manager.
WaitForTaskCompletion ( ) : void

Waits until all tasks enqueued using enqueueTask are complete.

Method Details

AddThread() public method

Notifies the thread manager that it should use another thread.
public AddThread ( ) : void
return void

AddThread() public method

Notifies the thread manager that it should use another thread.
public AddThread ( Action initialization, object initializationInformation ) : void
initialization Action Function to use to initialize the thread.
initializationInformation object Information to provide to the initializer.
return void

Dispose() public method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
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, object taskInformation ) : void
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

Notifies the thread manager that it should decrease the number of threads used.
public RemoveThread ( ) : void
return void

ThreadManagerTPL() public method

Constructs the TPL thread manager.
public ThreadManagerTPL ( ) : System
return System

WaitForTaskCompletion() public method

Waits until all tasks enqueued using enqueueTask are complete.
public WaitForTaskCompletion ( ) : void
return void