[#StdMutex]
= StdMutex
:mrdocs:

An annotated version of std::mutex for Clang Thread Safety Analysis.

== Synopsis

Declared in `<util/stdmutex.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class [[capability]] StdMutex
    : public std::mutex
----

== Description

Should only be used when the sync.h Mutex/LOCK primitives are not usable.

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `std::mutex`
| 
|===

== Types

[cols="1,4"]
|===
| Name| Description
| xref:StdMutex/Guard.adoc[`Guard`] 
| An annotated version of std::lock_guard for StdMutex.
|===


== Type Aliases

[cols="1"]
|===
| Name
| xref:StdMutex/native_handle_type.adoc[`native_handle_type`] 
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:StdMutex/operator_assign.adoc[`operator=`]  [.small]#[deleted]#
| 
| xref:StdMutex/lock.adoc[`lock`] 
| 
| xref:StdMutex/native_handle.adoc[`native_handle`] 
| 
| xref:StdMutex/try_lock.adoc[`try_lock`] 
| 
| xref:StdMutex/unlock.adoc[`unlock`] 
| 
| xref:StdMutex/operator_not.adoc[`operator!`] 
| Expose the mutex as a negative capability for Clang Thread Safety Analysis.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:StdMutex/CheckNotHeld.adoc[`CheckNotHeld`] 
| Assert (for the analyzer) that a mutex is not currently held and return it.
|===



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