[#BloombergLP-bdlmt-MultiQueueThreadPool_Queue-enqueueDeletion]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/MultiQueueThreadPool_Queue.adoc[MultiQueueThreadPool_Queue]::enqueueDeletion
:relfileprefix: ../../../
:mrdocs:

Permanently disable enqueueing from this queue, and enqueue a job that will delete this queue. Optionally specify `cleanupFunctor`, which, if supplied, will be invoked immediately prior to this queue's deletion. Optionally specify `completionSignal`, on which (if the calling thread is not processing a job ‐ or batch of jobs ‐ for this queue) to invoke `arrive` when the queue is deleted. Return `true` if the current thread is the thread processing a job (or batch of jobs), and `false` otherwise. Note that if `completionSignal` is supplied, a return status of `false` typically indicates that `completionSignal‐>wait()` should be invoked from the calling function', while a return status of `true` indicates this is an attempt to delete the queue from within a job being processed on the queue (so waiting on the queue's deletion would result in a dead‐lock).

== Synopsis

Declared in `<bdlmt_multiqueuethreadpool.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
enqueueDeletion(
    xref:BloombergLP/bdlmt/MultiQueueThreadPool_Queue/Job.adoc[Job] const& cleanupFunctor = Job(),
    xref:BloombergLP/bslmt/Latch.adoc[bslmt::Latch]* completionSignal = 0);
----


[.small]#Created with https://www.mrdocs.com[MrDocs]#