summaryrefslogtreecommitdiff
path: root/boost/thread/null_mutex.hpp
blob: f439f9ffb27f3f52965b343db9650bf47f52aa8a (plain)
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
//////////////////////////////////////////////////////////////////////////////
//
// (C) Copyright Vicente J. Botet Escriba 2008-2009,2012. Distributed under the Boost
// Software License, Version 1.0. (See accompanying file
// LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//
// See http://www.boost.org/libs/thread for documentation.
//
//////////////////////////////////////////////////////////////////////////////

#ifndef BOOST_THREAD_NULL_MUTEX_HPP
#define BOOST_THREAD_NULL_MUTEX_HPP

#include <boost/thread/detail/config.hpp>
#include <boost/thread/detail/delete.hpp>
#include <boost/chrono/chrono.hpp>

/// \file
/// Describes null_mutex class

namespace boost
{

  /// Implements a mutex that simulates a mutex without doing any operation and
  /// simulates a successful operation.
  class null_mutex
  {
  public:

    BOOST_THREAD_NO_COPYABLE( null_mutex) /*< no copyable >*/

    null_mutex() {}

    /// Simulates a mutex lock() operation. Empty function.
    void lock()
    {
    }

    /// Simulates a mutex try_lock() operation.
    /// Equivalent to "return true;"
    bool try_lock()
    {
      return true;
    }

    /// Simulates a mutex unlock() operation.
    /// Empty function.
    void unlock()
    {
    }

#ifdef BOOST_THREAD_USES_CHRONO
    /// Simulates a mutex try_lock_until() operation.
    /// Equivalent to "return true;"
    template <typename Clock, typename Duration>
    bool try_lock_until(chrono::time_point<Clock, Duration> const &)
    {
      return true;
    }

    /// Simulates a mutex try_lock_for() operation.
    /// Equivalent to "return true;"
    template <typename Rep, typename Period>
    bool try_lock_for(chrono::duration<Rep, Period> const &)
    {
      return true;
    }
#endif

    /// Simulates a mutex lock_shared() operation.
    /// Empty function.
    void lock_shared()
    {
    }

    /// Simulates a mutex try_lock_shared() operation.
    /// Equivalent to "return true;"
    bool try_lock_shared()
    {
      return true;
    }

    /// Simulates a mutex unlock_shared() operation.
    /// Empty function.
    void unlock_shared()
    {
    }

    /// Simulates a mutex try_lock_shared_until() operation.
    /// Equivalent to "return true;"
    template <typename Clock, typename Duration>
    bool try_lock_shared_until(chrono::time_point<Clock, Duration> const &)
    {
      return true;
    }
    /// Simulates a mutex try_lock_shared_for() operation.
    /// Equivalent to "return true;"
    template <typename Rep, typename Period>
    bool try_lock_shared_for(chrono::duration<Rep, Period> const &)
    {
      return true;
    }

    /// Simulates a mutex lock_upgrade() operation.
    /// Empty function.
    void lock_upgrade()
    {
    }

    /// Simulates a mutex try_lock_upgrade() operation.
    /// Equivalent to "return true;"
    bool try_lock_upgrade()
    {
      return true;
    }

    /// Simulates a mutex unlock_upgrade() operation.
    /// Empty function.
    void unlock_upgrade()
    {
    }

    /// Simulates a mutex try_lock_upgrade_until() operation.
    /// Equivalent to "return true;"
    template <typename Clock, typename Duration>
    bool try_lock_upgrade_until(chrono::time_point<Clock, Duration> const &)
    {
      return true;
    }

    /// Simulates a mutex try_lock_upgrade_for() operation.
    /// Equivalent to "return true;"
    template <typename Rep, typename Period>
    bool try_lock_upgrade_for(chrono::duration<Rep, Period> const &)
    {
      return true;
    }

    /// Simulates a mutex try_unlock_shared_and_lock() operation.
    /// Equivalent to "return true;"
    bool try_unlock_shared_and_lock()
    {
      return true;
    }

#ifdef BOOST_THREAD_USES_CHRONO
    /// Simulates a mutex try_unlock_shared_and_lock_until() operation.
    /// Equivalent to "return true;"
    template <typename Clock, typename Duration>
    bool try_unlock_shared_and_lock_until(chrono::time_point<Clock, Duration> const &)
    {
      return true;
    }

    /// Simulates a mutex try_unlock_shared_and_lock_for() operation.
    /// Equivalent to "return true;"
    template <typename Rep, typename Period>
    bool try_unlock_shared_and_lock_for(chrono::duration<Rep, Period> const &)
    {
      return true;
    }
#endif

    /// Simulates unlock_and_lock_shared().
    /// Empty function.
    void unlock_and_lock_shared()
    {
    }

    /// Simulates a mutex try_unlock_shared_and_lock_upgrade() operation.
    /// Equivalent to "return true;"
    bool try_unlock_shared_and_lock_upgrade()
    {
      return true;
    }

#ifdef BOOST_THREAD_USES_CHRONO
    /// Simulates a mutex try_unlock_shared_and_lock_upgrade_until() operation.
    /// Equivalent to "return true;"
    template <typename Clock, typename Duration>
    bool try_unlock_shared_and_lock_upgrade_until(chrono::time_point<Clock, Duration> const &)
    {
      return true;
    }

    /// Simulates a mutex try_unlock_shared_and_lock_upgrade_for() operation.
    /// Equivalent to "return true;"
    template <typename Rep, typename Period>
    bool try_unlock_shared_and_lock_upgrade_for(chrono::duration<Rep, Period> const &)
    {
      return true;
    }
#endif

    /// Simulates unlock_and_lock_upgrade().
    /// Empty function.
    void unlock_and_lock_upgrade()
    {
    }

    /// Simulates unlock_upgrade_and_lock().
    /// Empty function.
    void unlock_upgrade_and_lock()
    {
    }

    /// Simulates a mutex try_unlock_upgrade_and_lock() operation.
    /// Equivalent to "return true;"
    bool try_unlock_upgrade_and_lock()
    {
      return true;
    }

#ifdef BOOST_THREAD_USES_CHRONO
    /// Simulates a mutex try_unlock_upgrade_and_lock_until() operation.
    /// Equivalent to "return true;"
    template <typename Clock, typename Duration>
    bool try_unlock_upgrade_and_lock_until(chrono::time_point<Clock, Duration> const &)
    {
      return true;
    }

    /// Simulates a mutex try_unlock_upgrade_and_lock_for() operation.
    /// Equivalent to "return true;"
    template <typename Rep, typename Period>
    bool try_unlock_upgrade_and_lock_for(chrono::duration<Rep, Period> const &)
    {
      return true;
    }
#endif

    /// Simulates unlock_upgrade_and_lock_shared().
    /// Empty function.
    void unlock_upgrade_and_lock_shared()
    {
    }

  };

} //namespace boost {


#endif