Hydrogen.Threading.Forker Class Reference

Provides a caller-friendly wrapper around parallel actions. More...

Classes
class	ParallelEventArgs
	Event arguments representing the completion of a parallel action. More...

Public Member Functions
int	CountRunning ()
	Indicates the number of incomplete operations. More...
Forker	Fork (ThreadStart action)
	Enqueues an operation. More...
Forker	Fork (ThreadStart action, object state)
	Enqueues an operation. More...
void	Join ()
	Waits for all operations to complete. More...
bool	Join (int millisecondsTimeout)
	Waits (with timeout) for all operations to complete. More...
Forker	OnItemComplete (EventHandler< ParallelEventArgs > handler)
	Adds a callback to invoke when each operation completes. More...
Forker	OnAllComplete (EventHandler handler)
	Adds a callback to invoke when all operations are complete. More...

Events
EventHandler	AllComplete [add, remove]
	Raised when all operations have completed. More...
EventHandler< ParallelEventArgs >	ItemComplete [add, remove]
	Raised when each operation completes. More...

Detailed Description

Provides a caller-friendly wrapper around parallel actions.

Definition at line 38 of file Forker.cs.

Member Function Documentation

int Hydrogen.Threading.Forker.CountRunning

(

)

Indicates the number of incomplete operations.

Returns

The number of incomplete operations.

Definition at line 97 of file Forker.cs.

                {
                        return Interlocked.CompareExchange (ref _runningCount, 0, 0);
                }

Forker Hydrogen.Threading.Forker.Fork

(

ThreadStart

action

)

Enqueues an operation.

Parameters

action

The operation to perform.

Returns

The current instance (for fluent API).

Definition at line 107 of file Forker.cs.

                {
                        return Fork (action, null);
                }

Forker Hydrogen.Threading.Forker.Fork	(	ThreadStart	action,
		object	state
	)

Enqueues an operation.

Parameters

action	The operation to perform.
state	An opaque object, allowing the caller to identify operations.

Returns

The current instance (for fluent API).

Definition at line 118 of file Forker.cs.

                {
                        if (action == null)
                                throw new ArgumentNullException ("action");
                        Interlocked.Increment (ref _runningCount);
                        ThreadPool.QueueUserWorkItem (delegate {
                                Exception exception = null;
                                try {
                                        action ();
                                } catch (Exception ex) {
                                        exception = ex;
                                }
                                OnItemComplete (state, exception);
                        });
                        return this;
                }

void Hydrogen.Threading.Forker.Join

(

)

Waits for all operations to complete.

Definition at line 138 of file Forker.cs.

                {
                        Join (-1);
                }

bool Hydrogen.Threading.Forker.Join

(

int

millisecondsTimeout

)

Waits (with timeout) for all operations to complete.

Returns

Whether all operations had completed before the timeout.

Definition at line 147 of file Forker.cs.

                {
                        lock (_joinLock) {
                                if (CountRunning () == 0)
                                        return true;
                                Thread.SpinWait (1); // try our luck...
                                return (CountRunning () == 0) ||
                                Monitor.Wait (_joinLock, millisecondsTimeout);
                        }
                }

Forker Hydrogen.Threading.Forker.OnAllComplete

(

EventHandler

handler

)

Adds a callback to invoke when all operations are complete.

Returns

Current instance (for fluent API).

Definition at line 174 of file Forker.cs.

                {
                        if (handler == null)
                                throw new ArgumentNullException ("handler");
                        AllComplete += handler;
                        return this;
                }

Forker Hydrogen.Threading.Forker.OnItemComplete

(

EventHandler< ParallelEventArgs >

handler

)

Adds a callback to invoke when each operation completes.

Returns

Current instance (for fluent API).

Definition at line 162 of file Forker.cs.

                {
                        if (handler == null)
                                throw new ArgumentNullException ("handler");
                        ItemComplete += handler;
                        return this;
                }

Event Documentation

EventHandler Hydrogen.Threading.Forker.AllComplete

addremove

Raised when all operations have completed.

Definition at line 64 of file Forker.cs.

EventHandler< ParallelEventArgs> Hydrogen.Threading.Forker.ItemComplete

addremove

Raised when each operation completes.

Definition at line 80 of file Forker.cs.