summaryrefslogtreecommitdiff
path: root/include/mts/MTS_Lock.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/mts/MTS_Lock.h')
-rw-r--r--include/mts/MTS_Lock.h76
1 files changed, 76 insertions, 0 deletions
diff --git a/include/mts/MTS_Lock.h b/include/mts/MTS_Lock.h
new file mode 100644
index 0000000..c35b131
--- /dev/null
+++ b/include/mts/MTS_Lock.h
@@ -0,0 +1,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