summaryrefslogtreecommitdiff
path: root/include/mts/MTS_Condition.h
diff options
context:
space:
mode:
authorJesse Gilles <jgilles@multitech.com>2015-04-20 16:49:52 -0500
committerJesse Gilles <jgilles@multitech.com>2015-04-20 16:49:52 -0500
commit17b117e73df71925d73ee026b4f54aa1867ce0a5 (patch)
tree382610c8e598a77a961c5ceb32b9b614ed00e757 /include/mts/MTS_Condition.h
downloadlibmts-17b117e73df71925d73ee026b4f54aa1867ce0a5.tar.gz
libmts-17b117e73df71925d73ee026b4f54aa1867ce0a5.tar.bz2
libmts-17b117e73df71925d73ee026b4f54aa1867ce0a5.zip
initial commit
Diffstat (limited to 'include/mts/MTS_Condition.h')
-rw-r--r--include/mts/MTS_Condition.h75
1 files changed, 75 insertions, 0 deletions
diff --git a/include/mts/MTS_Condition.h b/include/mts/MTS_Condition.h
new file mode 100644
index 0000000..c15acd0
--- /dev/null
+++ b/include/mts/MTS_Condition.h
@@ -0,0 +1,75 @@
+/*
+ * 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_Condition.h
+ \brief A condition that can be waited on or signaled
+ \date 15JUN11
+ \author Sean Godinez
+
+ A platform independent condition that can be waited on or signaled.
+ */
+
+#ifndef _MTS_CONDITION_H_
+#define _MTS_CONDITION_H_
+
+#include <mts/MTS_Stdint.h>
+#include <mts/MTS_AutoPtr.h>
+#include <mts/MTS_NonCopyable.h>
+
+#ifdef WIN32
+#include <windows.h>
+#else
+#include <pthread.h>
+#endif
+
+namespace MTS {
+
+ class Lock;
+
+ //! A condition
+ /*!
+ A platform independent condition that can be waited on or signaled. Useful in building semaphores.
+
+ \sa Lock
+ */
+ class Condition: private NonCopyable {
+ friend class Lock;
+
+ public:
+ ~Condition(); //!< Destructs the Condition
+
+ void wait(); //!< Waits on *this Condition for signal
+ void wait(uint32_t millis); //!< Waits on *this Condition for signal or given amount of time
+ void signal(); //!< Signals *this Condition
+
+ private:
+
+ Lock* m_pLock; //!< Lock that created *this Condition
+#ifdef WIN32
+ AutoPtr<HANDLE> m_apCondition; //!< Handle to WIN32 Condition
+#else
+ AutoPtr<pthread_cond_t> m_apCondition; //!< Handle to PTHREAD Condition
+#endif
+
+ explicit Condition(Lock* lock); //!< Explicit Constructor! Must pass Lock as parent.
+ };
+}
+
+#endif