.TH "std::unique_lock< _Mutex >" 3cxx "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::unique_lock< _Mutex > \- A movable scoped lock type\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <unique_lock\&.h>\fP
.SS "Public Types"

.in +1c
.ti -1c
.RI "\fBtypedef\fP \fB_Mutex\fP \fBmutex_type\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBunique_lock\fP (\fBconst\fP \fBunique_lock\fP &)=\fBdelete\fP"
.br
.ti -1c
.RI "\fBunique_lock\fP (mutex_type &\fB__m\fP)"
.br
.ti -1c
.RI "\fBunique_lock\fP (mutex_type &\fB__m\fP, \fBadopt_lock_t\fP) \fBnoexcept\fP"
.br
.ti -1c
.RI "template<\fBtypename\fP _Rep , \fBtypename\fP \fB_Period\fP > \fBunique_lock\fP (mutex_type &\fB__m\fP, \fBconst\fP \fBchrono::duration\fP< _Rep, \fB_Period\fP > &\fB__rtime\fP)"
.br
.ti -1c
.RI "template<\fBtypename\fP \fB_Clock\fP , \fBtypename\fP \fB_Duration\fP > \fBunique_lock\fP (mutex_type &\fB__m\fP, \fBconst\fP \fBchrono::time_point\fP< \fB_Clock\fP, \fB_Duration\fP > &\fB__atime\fP)"
.br
.ti -1c
.RI "\fBunique_lock\fP (mutex_type &\fB__m\fP, \fBdefer_lock_t\fP) \fBnoexcept\fP"
.br
.ti -1c
.RI "\fBunique_lock\fP (mutex_type &\fB__m\fP, \fBtry_to_lock_t\fP)"
.br
.ti -1c
.RI "\fBunique_lock\fP (\fBunique_lock\fP &&\fB__u\fP) \fBnoexcept\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBlock\fP ()"
.br
.ti -1c
.RI "mutex_type * \fBmutex\fP () \fBconst\fP \fBnoexcept\fP"
.br
.ti -1c
.RI "\fBoperator bool\fP () \fBconst\fP \fBnoexcept\fP"
.br
.ti -1c
.RI "\fBunique_lock\fP & \fBoperator=\fP (\fBconst\fP \fBunique_lock\fP &)=\fBdelete\fP"
.br
.ti -1c
.RI "\fBunique_lock\fP & \fBoperator=\fP (\fBunique_lock\fP &&\fB__u\fP) \fBnoexcept\fP"
.br
.ti -1c
.RI "bool \fBowns_lock\fP () \fBconst\fP \fBnoexcept\fP"
.br
.ti -1c
.RI "mutex_type * \fBrelease\fP () \fBnoexcept\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBswap\fP (\fBunique_lock\fP &\fB__u\fP) \fBnoexcept\fP"
.br
.ti -1c
.RI "bool \fBtry_lock\fP ()"
.br
.ti -1c
.RI "template<\fBtypename\fP _Rep , \fBtypename\fP \fB_Period\fP > bool \fBtry_lock_for\fP (\fBconst\fP \fBchrono::duration\fP< _Rep, \fB_Period\fP > &\fB__rtime\fP)"
.br
.ti -1c
.RI "template<\fBtypename\fP \fB_Clock\fP , \fBtypename\fP \fB_Duration\fP > bool \fBtry_lock_until\fP (\fBconst\fP \fBchrono::time_point\fP< \fB_Clock\fP, \fB_Duration\fP > &\fB__atime\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBunlock\fP ()"
.br
.in -1c
.SS "Related Symbols"
(Note that these are not member symbols\&.) 
.in +1c
.ti -1c
.RI "template<\fBtypename\fP \fB_Mutex\fP > \fBvoid\fP \fBswap\fP (\fBunique_lock\fP< \fB_Mutex\fP > &__x, \fBunique_lock\fP< \fB_Mutex\fP > &\fB__y\fP) \fBnoexcept\fP"
.br
.RI "Swap overload for unique_lock objects\&. "
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<\fBtypename\fP \fB_Mutex\fP>
.br
class std::unique_lock< _Mutex >"A movable scoped lock type\&. 

A unique_lock controls mutex ownership within a scope\&. Ownership of the mutex can be delayed until after construction and can be transferred to another unique_lock by move construction or move assignment\&. If a mutex lock is owned when the destructor runs ownership will be released\&. 
.SH "Friends And Related Symbol Documentation"
.PP 
.SS "template<\fBtypename\fP \fB_Mutex\fP > \fBvoid\fP swap (\fBunique_lock\fP< \fB_Mutex\fP > & __x, \fBunique_lock\fP< \fB_Mutex\fP > & __y)\fC [related]\fP"

.PP
Swap overload for unique_lock objects\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for libstdc++ from the source code\&.