[This is preliminary documentation and is subject to change.]
Removes and returns the object at the beginning of the
BlockingQueue, waiting no more than a timeout period for an object to be
available.
Declaration Syntax| C# |
public T Dequeue( int millisecondsTimeout )
Parameters- millisecondsTimeout (Int32)
- The number of milliseconds to wait on an item appearing in the queue.
Return ValueThe object that is removed from the beginning of the
BlockingQueue, or default(T) if no object was available when the timeout
expired.
Remarks If the BlockingQueue is empty, then this method will block up to
a particular number of milliseconds. Any number of threads can be blocked,
waiting on the same BlockingQueue. When a thread enqueues an item, one of
the waiting threads is unblocked and receives the item.