summaryrefslogtreecommitdiff
path: root/boost/thread/lockable_adapter.hpp
blob: 93d9ba5023cc6baa34d9cbee2e39c6f7a90a4141 (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
//////////////////////////////////////////////////////////////////////////////
//
// (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_LOCKABLE_ADAPTER_HPP
#define BOOST_THREAD_LOCKABLE_ADAPTER_HPP

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

namespace boost
{

  //[basic_lockable_adapter
  template <typename BasicLockable>
  class basic_lockable_adapter
  {
  public:
    typedef BasicLockable mutex_type;

  protected:
    mutex_type& lockable() const
    {
      return lockable_;
    }
    mutable mutex_type lockable_; /*< mutable so that it can be modified by const functions >*/
  public:

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

    basic_lockable_adapter()
    {}

    void lock() const
    {
      lockable().lock();
    }
    void unlock() const
    {
      lockable().unlock();
    }

  };
  //]

  //[lockable_adapter
  template <typename Lockable>
  class lockable_adapter : public basic_lockable_adapter<Lockable>
  {
  public:
    typedef Lockable mutex_type;

    bool try_lock() const
    {
      return this->lockable().try_lock();
    }
  };
  //]

  //[timed_lockable_adapter
  template <typename TimedLock>
  class timed_lockable_adapter: public lockable_adapter<TimedLock>
  {
  public:
    typedef TimedLock mutex_type;

    template <typename Clock, typename Duration>
    bool try_lock_until(chrono::time_point<Clock, Duration> const & abs_time) const
    {
      return this->lockable().try_lock_until(abs_time);
    }
    template <typename Rep, typename Period>
    bool try_lock_for(chrono::duration<Rep, Period> const & rel_time) const
    {
      return this->lockable().try_lock_for(rel_time);
    }

  };
  //]

  //[shared_lockable_adapter
  template <typename SharableLock>
  class shared_lockable_adapter: public timed_lockable_adapter<SharableLock>
  {
  public:
    typedef SharableLock mutex_type;

    void lock_shared() const
    {
      this->lockable().lock_shared();
    }
    bool try_lock_shared() const
    {
      return this->lockable().try_lock_shared();
    }
    void unlock_shared() const
    {
      this->lockable().unlock_shared();
    }

    template <typename Clock, typename Duration>
    bool try_lock_shared_until(chrono::time_point<Clock, Duration> const & abs_time) const
    {
      return this->lockable().try_lock_shared_until(abs_time);
    }
    template <typename Rep, typename Period>
    bool try_lock_shared_for(chrono::duration<Rep, Period> const & rel_time) const
    {
      return this->lockable().try_lock_shared_for(rel_time);
    }

  };

  //]

  //[upgrade_lockable_adapter
  template <typename UpgradableLock>
  class upgrade_lockable_adapter: public shared_lockable_adapter<UpgradableLock>
  {
  public:
    typedef UpgradableLock mutex_type;

    void lock_upgrade() const
    {
      this->lockable().lock_upgrade();
    }

    bool try_lock_upgrade() const
    {
      return this->lockable().try_lock_upgrade();
    }

    void unlock_upgrade() const
    {
      this->lockable().unlock_upgrade();
    }

    template <typename Clock, typename Duration>
    bool try_lock_upgrade_until(chrono::time_point<Clock, Duration> const & abs_time) const
    {
      return this->lockable().try_lock_upgrade_until(abs_time);
    }
    template <typename Rep, typename Period>
    bool try_lock_upgrade_for(chrono::duration<Rep, Period> const & rel_time) const
    {
      return this->lockable().try_lock_upgrade_for(rel_time);
    }

    bool try_unlock_shared_and_lock() const
    {
      return this->lockable().try_unlock_shared_and_lock();
    }

    template <typename Clock, typename Duration>
    bool try_unlock_shared_and_lock_until(chrono::time_point<Clock, Duration> const & abs_time) const
    {
      return this->lockable().try_unlock_shared_and_lock_until(abs_time);
    }
    template <typename Rep, typename Period>
    bool try_unlock_shared_and_lock_for(chrono::duration<Rep, Period> const & rel_time) const
    {
      return this->lockable().try_unlock_shared_and_lock_for(rel_time);
    }

    void unlock_and_lock_shared() const
    {
      this->lockable().unlock_and_lock_shared();
    }

    bool try_unlock_shared_and_lock_upgrade() const
    {
      return this->lockable().try_unlock_shared_and_lock_upgrade();
    }

    template <typename Clock, typename Duration>
    bool try_unlock_shared_and_lock_upgrade_until(chrono::time_point<Clock, Duration> const & abs_time) const
    {
      return this->lockable().try_unlock_shared_and_lock_upgrade_until(abs_time);
    }
    template <typename Rep, typename Period>
    bool try_unlock_shared_and_lock_upgrade_for(chrono::duration<Rep, Period> const & rel_time) const
    {
      return this->lockable().try_unlock_shared_and_lock_upgrade_for(rel_time);
    }

    void unlock_and_lock_upgrade() const
    {
      this->lockable().unlock_and_lock_upgrade();
    }

    void unlock_upgrade_and_lock() const
    {
      this->lockable().unlock_upgrade_and_lock();
    }

    bool try_unlock_upgrade_and_lock() const
    {
      return this->lockable().try_unlock_upgrade_and_lock();
    }
    template <typename Clock, typename Duration>
    bool try_unlock_upgrade_and_lock_until(chrono::time_point<Clock, Duration> const & abs_time) const
    {
      return this->lockable().try_unlock_upgrade_and_lock_until(abs_time);
    }
    template <typename Rep, typename Period>
    bool try_unlock_upgrade_and_lock_for(chrono::duration<Rep, Period> const & rel_time) const
    {
      return this->lockable().try_unlock_upgrade_and_lock_for(rel_time);
    }

    void unlock_upgrade_and_lock_shared() const
    {
      this->lockable().unlock_upgrade_and_lock_shared();
    }

  };
//]

}
#endif