MatchQueue MethodsNaiad Help

[This is preliminary documentation and is subject to change.]

The MatchingCoordinatorTInput, TCategory, TWorkStub, TWorkDescription, TWorkerDescriptionMatchQueue type exposes the following members.

Methods

  NameDescription
Public methodStatic memberCompare
Comparison function to use when sorting MatchQueues. a sorts before b if a contains more available matches than b, or if they contain the same number of available matches and a's uid is less than b's uid.
Public methodDequeue
Return the next unused matched in the queue. Throws an exception if there are no remaining matches. DOES NOT UPDATE THE COUNT OF UNUSED MATCHES. The caller is responsible for decrementing the count of unused matches for every queue the return value appears in, including this one, by calling MarkTaken on the relevant queues.
Public methodEnqueue
Add an unused Match to the queue. Throws an exception if the Match has been taken
Public methodMarkTaken
Indicate that an unused entry in this queue has either been dequeued or marked as taken by another queue. This must be called appropriately to ensure the invariant that this.unusedMatches is equal to the number of unused Match elements in this.queue. Throws an exception if there are no unused matches in the queue.
Top
See Also

Reference