Namespaces
Variants
Views
Actions

std::defer_lock_t, std::try_to_lock_t, std::adopt_lock_t

From cppreference.com
< cpp‎ | thread
Revision as of 20:40, 2 November 2012 by P12bot (Talk | contribs)

 
 
Thread support library
Threads
(C++11)
this_thread namespace
(C++11)
(C++11)
(C++11)
Mutual exclusion
(C++11)
Generic lock management
(C++11)
defer_lock_ttry_to_lock_tadopt_lock_t
(C++11)(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Condition variables
(C++11)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
 

Template:ddcl list begin <tr class="t-dcl ">

<td >
struct defer_lock_t { };
</td>

<td class="t-dcl-nopad"> </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

<td >
struct try_to_lock_t { };
</td>

<td class="t-dcl-nopad"> </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

<td >
struct adopt_lock_t { };
</td>

<td class="t-dcl-nopad"> </td> <td > (since C++11) </td> </tr> Template:ddcl list end

std::defer_lock_t, std::try_to_lock_t and std::adopt_lock_t are empty struct tag types used to specify locking strategy for std::lock_guard and std::unique_lock.


Type Effect(s)
defer_lock_t do not acquire ownership of the mutex
try_to_lock_t try to acquire ownership of the mutex without blocking
adopt_lock_t assume the calling thread already has ownership of the mutex

Example

#include <mutex>
#include <thread>
 
struct bank_account {
    explicit bank_account(int balance) : balance(balance) {}
    int balance;
    std::mutex m;
};
 
void transfer(bank_account &from, bank_account &to, int amount)
{
    // attempt to lock both mutexes without deadlock
    std::lock(from.m, to.m);
 
    // make sure both already-locked mutexes are unlocked when 
    // we're done; if we just used the lock_guard without std::lock
    // and std::adopt_lock, we might deadlock with other calls to transfer
    std::lock_guard<std::mutex> lock1(from.m, std::adopt_lock);
    std::lock_guard<std::mutex> lock2(to.m, std::adopt_lock);
 
    from.balance -= amount;
    to.balance += amount;
}
 
int main()
{
    bank_account my_account(100);
    bank_account your_account(50);
 
    std::thread t1(transfer, std::ref(my_account), std::ref(your_account), 10);
    std::thread t2(transfer, std::ref(your_account), std::ref(my_account), 5);
 
    t1.join();
    t2.join();
}


See also

Template:cpp/thread/dcl list lock tagTemplate:cpp/thread/lock guard/dcl list constructor
constructs a unique_lock, optionally locking the supplied mutex
(public member function of std::unique_lock) [edit]