File: mutex

package info (click to toggle)
cppreference-doc 20170409-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 259,872 kB
  • sloc: xml: 570,184; python: 1,923; php: 520; makefile: 168; sh: 25; cpp: 9; ansic: 9
file content (183 lines) | stat: -rw-r--r-- 5,034 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/*  Copyright (C) 2015  Povilas Kanapickas <povilas@radix.lt>

    This file is part of cppreference-doc

    This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
    Unported License. To view a copy of this license, visit
    http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
    Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.

    Permission is granted to copy, distribute and/or modify this document
    under the terms of the GNU Free Documentation License, Version 1.3 or
    any later version published by the Free Software Foundation; with no
    Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
*/

#ifndef CPPREFERENCE_MUTEX_H
#define CPPREFERENCE_MUTEX_H

#if CPPREFERENCE_STDVER>= 2011

namespace std {

struct defer_lock_t { };
struct try_to_lock_t { };
struct adopt_lock_t { };

constexpr std::defer_lock_t defer_lock;
constexpr std::try_to_lock_t try_to_lock;
constexpr std::adopt_lock_t adopt_lock;

class mutex {
public:
    typedef void* native_handle_type; // actually impl-defined

    constexpr mutex();
    mutex(const mutex&) = delete;
    mutex& operator=(const mutex&) = delete;

    ~mutex();

    void lock();
    bool try_lock();
    void unlock();
    native_handle_type native_handle();
};

class recursive_mutex {
public:
    typedef void* native_handle_type; // actually impl-defined

    recursive_mutex();
    recursive_mutex(const recursive_mutex&) = delete;
    recursive_mutex& operator=(const recursive_mutex&) = delete;

    ~recursive_mutex();

    void lock();
    bool try_lock();
    void unlock();
    native_handle_type native_handle();
};

class timed_mutex {
public:
    typedef void* native_handle_type; // actually impl-defined

    timed_mutex();
    timed_mutex(const timed_mutex&) = delete;
    timed_mutex& operator=(const timed_mutex&) = delete;

    ~timed_mutex();

    void lock();
    bool try_lock();

    template<class Rep, class Period>
    bool try_lock_for(const std::chrono::duration<Rep, Period>& timeout_duration);

    template<class Clock, class Duration>
    bool try_lock_until(const std::chrono::time_point<Clock, Duration>& timeout_time);

    void unlock();
    native_handle_type native_handle();
};

class recursive_timed_mutex {
public:
    typedef void* native_handle_type; // actually impl-defined

    recursive_timed_mutex();
    recursive_timed_mutex(const recursive_timed_mutex&) = delete;
    recursive_timed_mutex& operator=(const recursive_timed_mutex&) = delete;

    ~recursive_timed_mutex();

    void lock();
    bool try_lock();

    template<class Rep, class Period>
    bool try_lock_for(const std::chrono::duration<Rep, Period>& timeout_duration);

    template<class Clock, class Duration>
    bool try_lock_until(const std::chrono::time_point<Clock, Duration>& timeout_time);

    void unlock();
    native_handle_type native_handle();
};


template<class Mutex>
class lock_guard {
public:
    typedef Mutex mutex_type;

    explicit lock_guard(mutex_type& m);
    lock_guard(mutex_type& m, std::adopt_lock_t t);
    lock_guard(const lock_guard&) = delete;
    lock_guard& operator=(const lock_guard&) = delete;
    ~lock_guard();
};

template<class Mutex>
class unique_lock {
public:
    typedef Mutex mutex_type;

    unique_lock();
    unique_lock(unique_lock&& other);
    explicit unique_lock(mutex_type& m);
    unique_lock(mutex_type& m, std::defer_lock_t t);
    unique_lock(mutex_type& m, std::try_to_lock_t t);
    unique_lock(mutex_type& m, std::adopt_lock_t t);

    template<class Rep, class Period>
    unique_lock(mutex_type& m,
                const std::chrono::duration<Rep, Period>& timeout_duration);

    template<class Clock, class Duration>
    unique_lock(mutex_type& m,
                const std::chrono::time_point<Clock, Duration>& timeout_time);

    ~unique_lock();
    unique_lock& operator=(unique_lock&& other);

    void lock();
    bool try_lock();
    template<class Rep, class Period>
    bool try_lock_for(const std::chrono::duration<Rep, Period>& timeout_duration);
    template<class Clock, class Duration>
    bool try_lock_until(const std::chrono::time_point<Clock, Duration>& timeout_time);
    void unlock();

    void swap(unique_lock<Mutex>& other);

    mutex_type* release();
    mutex_type* mutex() const;
    bool owns_lock() const;
    explicit operator bool() const;
};

template<class Mutex>
void swap(unique_lock<Mutex>& lhs,
          unique_lock<Mutex>& rhs);

class once_flag {
public:
    constexpr once_flag();
};

template<class Lockable1, class Lockable2, class... LockableN>
int try_lock(Lockable1& lock1, Lockable2& lock2, LockableN& ... lockn);

template<class Lockable1, class Lockable2, class... LockableN>
void lock(Lockable1& lock1, Lockable2& lock2, LockableN& ... lockn);

template<class Callable, class... Args>
void call_once(std::once_flag& flag, Callable&& f, Args&& ... args);

} // namespace std

#endif // CPPREFERENCE_STDVER>= 2011

#endif // CPPREFERENCE_MUTEX_H