annotate DEPENDENCIES/generic/include/boost/interprocess/sync/posix/named_mutex.hpp @ 16:2665513ce2d3

Add boost headers
author Chris Cannam
date Tue, 05 Aug 2014 11:11:38 +0100
parents
children c530137014c0
rev   line source
Chris@16 1 //////////////////////////////////////////////////////////////////////////////
Chris@16 2 //
Chris@16 3 // (C) Copyright Ion Gaztanaga 2005-2012. Distributed under the Boost
Chris@16 4 // Software License, Version 1.0. (See accompanying file
Chris@16 5 // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16 6 //
Chris@16 7 // See http://www.boost.org/libs/interprocess for documentation.
Chris@16 8 //
Chris@16 9 //////////////////////////////////////////////////////////////////////////////
Chris@16 10
Chris@16 11 #ifndef BOOST_INTERPROCESS_POSIX_NAMED_MUTEX_HPP
Chris@16 12 #define BOOST_INTERPROCESS_POSIX_NAMED_MUTEX_HPP
Chris@16 13
Chris@16 14 #if (defined _MSC_VER) && (_MSC_VER >= 1200)
Chris@16 15 # pragma once
Chris@16 16 #endif
Chris@16 17
Chris@16 18 #include <boost/interprocess/detail/config_begin.hpp>
Chris@16 19 #include <boost/interprocess/detail/workaround.hpp>
Chris@16 20 #include <boost/interprocess/creation_tags.hpp>
Chris@16 21 #include <boost/interprocess/exceptions.hpp>
Chris@16 22 #include <boost/interprocess/detail/interprocess_tester.hpp>
Chris@16 23 #include <boost/interprocess/permissions.hpp>
Chris@16 24
Chris@16 25 #include <boost/interprocess/sync/posix/named_semaphore.hpp>
Chris@16 26
Chris@16 27 namespace boost {
Chris@16 28 namespace interprocess {
Chris@16 29 namespace ipcdetail {
Chris@16 30
Chris@16 31 class named_condition;
Chris@16 32
Chris@16 33 class posix_named_mutex
Chris@16 34 {
Chris@16 35 /// @cond
Chris@16 36
Chris@16 37 posix_named_mutex();
Chris@16 38 posix_named_mutex(const posix_named_mutex &);
Chris@16 39 posix_named_mutex &operator=(const posix_named_mutex &);
Chris@16 40 friend class named_condition;
Chris@16 41 /// @endcond
Chris@16 42
Chris@16 43 public:
Chris@16 44 posix_named_mutex(create_only_t create_only, const char *name, const permissions &perm = permissions());
Chris@16 45
Chris@16 46 posix_named_mutex(open_or_create_t open_or_create, const char *name, const permissions &perm = permissions());
Chris@16 47
Chris@16 48 posix_named_mutex(open_only_t open_only, const char *name);
Chris@16 49
Chris@16 50 ~posix_named_mutex();
Chris@16 51
Chris@16 52 void unlock();
Chris@16 53 void lock();
Chris@16 54 bool try_lock();
Chris@16 55 bool timed_lock(const boost::posix_time::ptime &abs_time);
Chris@16 56 static bool remove(const char *name);
Chris@16 57
Chris@16 58 /// @cond
Chris@16 59 private:
Chris@16 60 friend class interprocess_tester;
Chris@16 61 void dont_close_on_destruction();
Chris@16 62
Chris@16 63 posix_named_semaphore m_sem;
Chris@16 64 /// @endcond
Chris@16 65 };
Chris@16 66
Chris@16 67 /// @cond
Chris@16 68
Chris@16 69 inline posix_named_mutex::posix_named_mutex(create_only_t, const char *name, const permissions &perm)
Chris@16 70 : m_sem(create_only, name, 1, perm)
Chris@16 71 {}
Chris@16 72
Chris@16 73 inline posix_named_mutex::posix_named_mutex(open_or_create_t, const char *name, const permissions &perm)
Chris@16 74 : m_sem(open_or_create, name, 1, perm)
Chris@16 75 {}
Chris@16 76
Chris@16 77 inline posix_named_mutex::posix_named_mutex(open_only_t, const char *name)
Chris@16 78 : m_sem(open_only, name)
Chris@16 79 {}
Chris@16 80
Chris@16 81 inline void posix_named_mutex::dont_close_on_destruction()
Chris@16 82 { interprocess_tester::dont_close_on_destruction(m_sem); }
Chris@16 83
Chris@16 84 inline posix_named_mutex::~posix_named_mutex()
Chris@16 85 {}
Chris@16 86
Chris@16 87 inline void posix_named_mutex::lock()
Chris@16 88 { m_sem.wait(); }
Chris@16 89
Chris@16 90 inline void posix_named_mutex::unlock()
Chris@16 91 { m_sem.post(); }
Chris@16 92
Chris@16 93 inline bool posix_named_mutex::try_lock()
Chris@16 94 { return m_sem.try_wait(); }
Chris@16 95
Chris@16 96 inline bool posix_named_mutex::timed_lock(const boost::posix_time::ptime &abs_time)
Chris@16 97 {
Chris@16 98 if(abs_time == boost::posix_time::pos_infin){
Chris@16 99 this->lock();
Chris@16 100 return true;
Chris@16 101 }
Chris@16 102 return m_sem.timed_wait(abs_time);
Chris@16 103 }
Chris@16 104
Chris@16 105 inline bool posix_named_mutex::remove(const char *name)
Chris@16 106 { return posix_named_semaphore::remove(name); }
Chris@16 107
Chris@16 108 /// @endcond
Chris@16 109
Chris@16 110 } //namespace ipcdetail {
Chris@16 111 } //namespace interprocess {
Chris@16 112 } //namespace boost {
Chris@16 113
Chris@16 114 #include <boost/interprocess/detail/config_end.hpp>
Chris@16 115
Chris@16 116 #endif //BOOST_INTERPROCESS_POSIX_NAMED_MUTEX_HPP