summaryrefslogtreecommitdiff
path: root/include/mts/MTS_Lock.h
blob: c35b13174c7578a4fc43e2149cef7743e1647585 (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
/*
 * Copyright (C) 2015 by Multi-Tech Systems
 *
 * This file is part of libmts.
 *
 * libmts is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * libmts is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libmts.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

/*! \file   MTS_Lock.h
 \brief  A mutex lock
 \date   15JUN11
 \author Sean Godinez

 A platform independent mutex lock.
 */

#ifndef _MTS_LOCK_H_
#define _MTS_LOCK_H_

#include <mts/MTS_NonCopyable.h>
#include <mts/MTS_Condition.h>
#include <mts/MTS_AutoPtr.h>

#ifdef WIN32
#include <windows.h>
#else
#include <pthread.h>
#endif

namespace MTS {

    //! A mutex lock
    /*!
     A platform independent mutex lock

     \sa Condition
     */

    class Lock: private NonCopyable {

        public:
            Lock();                                     //!< Constructs the Lock
            ~Lock();                                    //!< Destructs the Lock

            void lock();                                //!< Locks the mutex
            void unlock();                              //!< Unlocks the mutex

            bool isLocked() const;                      //!< Returns true if locked

            Condition* createCondition();               //!< Creates a Condition object associated with *this Lock

        private:
            friend class Condition;
            volatile bool m_bLocked;                    //!< Locks the mutex
#ifdef WIN32
            AutoPtr<HANDLE> m_apMutex;                  //!< WIN32 Mutex Handle
#else
            AutoPtr<pthread_mutex_t> m_apMutex;         //!< PTHREAD Mutex Handle
            AutoPtr<pthread_mutexattr_t> m_apMutexAttr; //!< PTHREAD Mutex Attributes
#endif
    };
}

#endif