.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 \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 &__m)" .br .ti -1c .RI "\fBunique_lock\fP (mutex_type &__m, \fBadopt_lock_t\fP) \fBnoexcept\fP" .br .ti -1c .RI "template<\fBtypename\fP _Rep , \fBtypename\fP \fB_Period\fP > \fBunique_lock\fP (mutex_type &__m, \fBconst\fP \fBchrono::duration\fP< _Rep, \fB_Period\fP > &__rtime)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Clock\fP , \fBtypename\fP _Duration > \fBunique_lock\fP (mutex_type &__m, \fBconst\fP \fBchrono::time_point\fP< \fB_Clock\fP, _Duration > &__atime)" .br .ti -1c .RI "\fBunique_lock\fP (mutex_type &__m, \fBdefer_lock_t\fP) \fBnoexcept\fP" .br .ti -1c .RI "\fBunique_lock\fP (mutex_type &__m, \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 > &__rtime)" .br .ti -1c .RI "template<\fBtypename\fP \fB_Clock\fP , \fBtypename\fP _Duration > bool \fBtry_lock_until\fP (\fBconst\fP \fBchrono::time_point\fP< \fB_Clock\fP, _Duration > &__atime)" .br .ti -1c .RI "\fBvoid\fP \fBunlock\fP ()" .br .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\&. .PP Definition at line \fB59\fP of file \fBunique_lock\&.h\fP\&. .SH "Member Typedef Documentation" .PP .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBtypedef\fP \fB_Mutex\fP \fBstd::unique_lock\fP< \fB_Mutex\fP >::mutex_type" .PP Definition at line \fB62\fP of file \fBunique_lock\&.h\fP\&. .SH "Constructor & Destructor Documentation" .PP .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBstd::unique_lock\fP< \fB_Mutex\fP >::unique_lock ()\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB64\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBstd::unique_lock\fP< \fB_Mutex\fP >::unique_lock (mutex_type & __m)\fC [inline]\fP, \fC [explicit]\fP" .PP Definition at line \fB68\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBstd::unique_lock\fP< \fB_Mutex\fP >::unique_lock (mutex_type & __m, \fBdefer_lock_t\fP)\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB75\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBstd::unique_lock\fP< \fB_Mutex\fP >::unique_lock (mutex_type & __m, \fBtry_to_lock_t\fP)\fC [inline]\fP" .PP Definition at line \fB79\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBstd::unique_lock\fP< \fB_Mutex\fP >::unique_lock (mutex_type & __m, \fBadopt_lock_t\fP)\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB83\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > template<\fBtypename\fP \fB_Clock\fP , \fBtypename\fP _Duration > \fBstd::unique_lock\fP< \fB_Mutex\fP >::unique_lock (mutex_type & __m, \fBconst\fP \fBchrono::time_point\fP< \fB_Clock\fP, _Duration > & __atime)\fC [inline]\fP" .PP Definition at line \fB90\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > template<\fBtypename\fP _Rep , \fBtypename\fP \fB_Period\fP > \fBstd::unique_lock\fP< \fB_Mutex\fP >::unique_lock (mutex_type & __m, \fBconst\fP \fBchrono::duration\fP< _Rep, \fB_Period\fP > & __rtime)\fC [inline]\fP" .PP Definition at line \fB97\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBstd::unique_lock\fP< \fB_Mutex\fP >::~\fBunique_lock\fP ()\fC [inline]\fP" .PP Definition at line \fB103\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBstd::unique_lock\fP< \fB_Mutex\fP >::unique_lock (\fBunique_lock\fP< \fB_Mutex\fP > && __u)\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB112\fP of file \fBunique_lock\&.h\fP\&. .SH "Member Function Documentation" .PP .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBvoid\fP \fBstd::unique_lock\fP< \fB_Mutex\fP >::lock ()\fC [inline]\fP" .PP Definition at line \fB133\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > mutex_type * \fBstd::unique_lock\fP< \fB_Mutex\fP >::mutex () const\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB226\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBstd::unique_lock\fP< \fB_Mutex\fP >::operator bool () const\fC [inline]\fP, \fC [explicit]\fP, \fC [noexcept]\fP" .PP Definition at line \fB222\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBunique_lock\fP & \fBstd::unique_lock\fP< \fB_Mutex\fP >::operator= (\fBunique_lock\fP< \fB_Mutex\fP > && __u)\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB119\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > bool \fBstd::unique_lock\fP< \fB_Mutex\fP >::owns_lock () const\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB219\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > mutex_type * \fBstd::unique_lock\fP< \fB_Mutex\fP >::release ()\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB210\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBvoid\fP \fBstd::unique_lock\fP< \fB_Mutex\fP >::swap (\fBunique_lock\fP< \fB_Mutex\fP > & __u)\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB203\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > bool \fBstd::unique_lock\fP< \fB_Mutex\fP >::try_lock ()\fC [inline]\fP" .PP Definition at line \fB147\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > template<\fBtypename\fP _Rep , \fBtypename\fP \fB_Period\fP > bool \fBstd::unique_lock\fP< \fB_Mutex\fP >::try_lock_for (\fBconst\fP \fBchrono::duration\fP< _Rep, \fB_Period\fP > & __rtime)\fC [inline]\fP" .PP Definition at line \fB177\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > template<\fBtypename\fP \fB_Clock\fP , \fBtypename\fP _Duration > bool \fBstd::unique_lock\fP< \fB_Mutex\fP >::try_lock_until (\fBconst\fP \fBchrono::time_point\fP< \fB_Clock\fP, _Duration > & __atime)\fC [inline]\fP" .PP Definition at line \fB162\fP of file \fBunique_lock\&.h\fP\&. .SS "template<\fBtypename\fP \fB_Mutex\fP > \fBvoid\fP \fBstd::unique_lock\fP< \fB_Mutex\fP >::unlock ()\fC [inline]\fP" .PP Definition at line \fB191\fP of file \fBunique_lock\&.h\fP\&. .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.