[#CCheckQueueControl]
= CCheckQueueControl
:mrdocs:

RAII‐style controller object for a CCheckQueue that guarantees the passed queue is finished before continuing.

== Synopsis

Declared in `<checkqueue.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    typename T,
    typename R = std::remove_cvref_t<decltype(std::declval<T>()().value())>>
class [[scoped_lockable]] CCheckQueueControl;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:CCheckQueueControl/2constructor-0e.adoc[`CCheckQueueControl`]         [.small]#[constructor]#
| Constructors
| xref:CCheckQueueControl/2destructor.adoc[`~CCheckQueueControl`] [.small]#[destructor]#
| Completes any outstanding checks (if not already done) and releases the lock.
| xref:CCheckQueueControl/operator_assign.adoc[`operator=`]  [.small]#[deleted]#
| Deleted copy assignment; the controller holds an exclusive lock.
| xref:CCheckQueueControl/Add.adoc[`Add`] 
| Adds a batch of checks to the controlled queue.
| xref:CCheckQueueControl/Complete.adoc[`Complete`] 
| Waits for all queued checks to finish and returns any failure.
|===



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