Generic FunctionPackage: mpToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.2
Unrevised from 8.1 to 8.2. Significant update since 8.2 release.
8.1 version

dequeue

Arguments: queue &key wait empty-queue-result whostate

In an April, 2011 update, there is a new empty-queue-result argument and the wait argument has new possible values.

Removes the object at the head of the queued sequence queue, that is, the one that has been queued the longest, and returns that object.

If queue is empty, then the result depends on the values of the wait and empty-queue-result keyword arguments.

The predefined method is for the queue class.

The function queue-empty-p indicates whether the queue is empty or not (but the returned value cannot be depended upon if other processes and also dequeuing the queue).

Interlocks ensure that no entry in the queue will be retrieved by more than one process (once the dequeuing starts, it will complete). If the process does wait, its whostate will be set from the whostate keyword argument, which defaults to the string "dequeue".

See Queues in multiprocessing.htm for more information.


Copyright (c) 1998-2015, Franz Inc. Oakland, CA., USA. All rights reserved.
Documentation for Allegro CL version 8.2. This page was not revised from the 8.1 page.
Created 2010.1.21.

ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.2
Unrevised from 8.1 to 8.2. Significant update since 8.2 release.
8.1 version