Drizzled Public API Documentation

locks.h
1 /* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3  *
4  * Copyright (C) 2010 Brian Aker
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #include <boost/thread/mutex.hpp>
22 #include <boost/thread/condition_variable.hpp>
23 #include <boost/unordered_map.hpp>
24 #include <boost/unordered/unordered_set.hpp>
25 
26 #include <plugin/user_locks/lock.h>
27 
28 #include <string>
29 
30 #include <drizzled/session.h>
31 
32 #pragma once
33 
34 namespace user_locks {
35 
36 namespace locks {
37  enum return_t {
38  SUCCESS,
39  NOT_FOUND,
40  NOT_OWNED_BY
41  };
42 } /* locks user_locks */
43 
44 const size_t LARGEST_LOCK_NAME= 64;
45 
46 class Locks
47 {
48 public:
49  typedef boost::unordered_map<user_locks::Key, user_locks::Lock::shared_ptr> LockMap;
50 
51  static Locks &getInstance(void)
52  {
53  static Locks instance;
54  return instance;
55  }
56 
57  void waitCreate(int64_t wait_for= 2); // Default is to wait 2 seconds before returning
58 
59  bool lock(drizzled::session_id_t id_arg, const user_locks::Key &arg, int64_t wait_for= 0);
60  bool lock(drizzled::session_id_t id_arg, const user_locks::Keys &arg);
61  locks::return_t release(const user_locks::Key &arg, drizzled::session_id_t &id_arg, bool and_wait= false);
62  bool isFree(const user_locks::Key &arg);
63  bool isUsed(const user_locks::Key &arg, drizzled::session_id_t &id_arg);
64  void Copy(LockMap &lock_map);
65 
66 private:
67  boost::mutex mutex;
68  boost::condition_variable create_cond; // Signal next
69  boost::condition_variable release_cond;
70  LockMap lock_map;
71 };
72 
73 
74 } /* namespace user_locks */
75