Class ThreadControlQueue

void Block ()

Block queue, all calls to Pop will block until Unblock is called.

void Lock ()

Aquires a lock on this queue.

Must be paired with a call to Unlock

Path Pop ()

Pops the next item off the queue.

This call will block if there are no items in the queue or if the queue is currently blocked.

Path PopNoBlock (

bool

blockedBefore

)

Pops the next item off the queue, this call will not block.

To ensure stability, the caller must follow this pattern. 1. Call PopNoBlock(false), if a null value is returned, wait for a bit (e.g yield return null in a Unity coroutine) 2. try again with PopNoBlock(true), if still null, wait for a bit 3. Repeat from step 2.

void Push (

Path

path

)

Push a path to the end of the queue.

void PushFront (

Path

path

)

Push a path to the front of the queue.

void ReceiverTerminated ()

Call when a receiver was terminated in other ways than by a QueueTerminationException.

After this call, the receiver should be dead and not call anything else in this class.

void TerminateReceivers ()

All calls to Pop and PopNoBlock will now generate exceptions.

ThreadControlQueue (

int

numReceivers

)

Create a new queue with the specified number of receivers.

It is important that the number of receivers is fixed. Properties like AllReceiversBlocked rely on knowing the exact number of receivers using the Pop (or PopNoBlock) methods.

void Unblock ()

Unblock queue.

Calls to Pop will not block anymore.

void Unlock ()

Releases the lock on this queue.

bool AllReceiversBlocked

True if blocking and all receivers are waiting for unblocking.

bool IsEmpty

True if the queue is empty.

bool IsTerminating

True if TerminateReceivers has been called.

ManualResetEvent block = new ManualResetEvent(true)

bool blocked

int blockedReceivers

Number of receiver threads that are currently blocked.

This is only modified while a thread has a lock on lockObj

Path head

System.Object lockObj = new System.Object()

int numReceivers

bool starving

True while head == null.

This is only modified while a thread has a lock on lockObj

void Starving ()

Path tail

bool terminate

True after TerminateReceivers has been called.

All receivers will be terminated when they next call Pop.