Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/thread/unique lock"

From cppreference.com
< cpp‎ | thread
m (Text replace - "{{cpp|" to "{{c|")
m (Text replace - "{{tdcl list begin" to "{{dcl list begin")
Line 9: Line 9:
  
 
===Member types===
 
===Member types===
{{tdcl list begin}}
+
{{dcl list begin}}
 
{{tdcl list hitem | Type | Definition}}
 
{{tdcl list hitem | Type | Definition}}
 
{{tdcl list item | {{tt|mutex_type}} | {{c|Mutex}}}}
 
{{tdcl list item | {{tt|mutex_type}} | {{c|Mutex}}}}

Revision as of 01:23, 12 June 2012

Template:cpp/thread/unique lock/sidebar

Defined in header <mutex>
template< class Mutex >
class unique_lock;
(since C++11)

The class unique_lock implements general-purpose mutex ownership wrapper allowing deferred locking, timed locking, recursive locking, transfer of lock ownership, and use with condition variables. The class is non-copyable but movable.

Contents

Member types

Template:tdcl list hitemTemplate:tdcl list itemTemplate:tdcl list end

Member functions

constructs a unique_lock, optionally locking (i.e., taking ownership of) the supplied mutex
(public member function) [edit]
unlocks (i.e., releases ownership of) the associated mutex, if owned
(public member function) [edit]
unlocks (i.e., releases ownership of) the mutex, if owned, and acquires ownership of another
(public member function) [edit]
Locking
locks (i.e., takes ownership of) the associated mutex
(public member function) [edit]
tries to lock (i.e., takes ownership of) the associated mutex without blocking
(public member function) [edit]
attempts to lock (i.e., takes ownership of) the associated TimedLockable mutex, returns if the mutex has been unavailable for the specified time duration
(public member function) [edit]
tries to lock (i.e., takes ownership of) the associated TimedLockable mutex, returns if the mutex has been unavailable until specified time point has been reached
(public member function) [edit]
unlocks (i.e., releases ownership of) the associated mutex
(public member function) [edit]
Modifiers
swaps state with another std::unique_lock
(public member function) [edit]
disassociates the associated mutex without unlocking (i.e., releasing ownership of) it
(public member function) [edit]
Observers
returns a pointer to the associated mutex
(public member function) [edit]
tests whether the lock owns (i.e., has locked) its associated mutex
(public member function) [edit]
tests whether the lock owns (i.e., has locked) its associated mutex
(public member function) [edit]

Non-member functions

specializes the std::swap algorithm
(function template) [edit]