-// Event.h: interface for the CEvent class.
-//
-//////////////////////////////////////////////////////////////////////
-
-#if !defined(AFX_EVENT_H__724ADE14_0F5C_4836_B995_08FFAA97D6B9__INCLUDED_)
-#define AFX_EVENT_H__724ADE14_0F5C_4836_B995_08FFAA97D6B9__INCLUDED_
+/*
+ * Copyright (C) 2005-2013 Team XBMC
+ * http://xbmc.org
+ *
+ * This Program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This Program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with XBMC; see the file COPYING. If not, see
+ * <http://www.gnu.org/licenses/>.
+ *
+ */
-#if _MSC_VER > 1000
#pragma once
-#endif // _MSC_VER > 1000
+#include <vector>
-/*
-* XBMC Media Center
-* Copyright (c) 2002 Frodo
-* Portions Copyright (c) by the authors of ffmpeg and xvid
-*
-* This program is free software; you can redistribute it and/or modify
-* it under the terms of the GNU General Public License as published by
-* the Free Software Foundation; either version 2 of the License, or
-* (at your option) any later version.
-*
-* This program 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 General Public License for more details.
-*
-* You should have received a copy of the GNU General Public License
-* along with this program; if not, write to the Free Software
-* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-*/
-
-#if defined(_WIN32)
-#include <windows.h>
-#else
-#include "PlatformInclude.h"
-#endif
-
-class CEvent
+#include "threads/Condition.h"
+#include "threads/SingleLock.h"
+
+// forward declare the CEventGroup
+namespace XbmcThreads
+{
+ class CEventGroup;
+}
+
+
+/**
+ * This is an Event class built from a ConditionVariable. The Event adds the state
+ * that the condition is gating as well as the mutex/lock.
+ *
+ * This Event can be 'interruptible' (even though there is only a single place
+ * in the code that uses this behavior).
+ *
+ * This class manages 'spurious returns' from the condition variable.
+ */
+class CEvent : public XbmcThreads::NonCopyable
{
+ bool manualReset;
+ volatile bool signaled;
+ unsigned int numWaits;
+
+ CCriticalSection groupListMutex; // lock for the groups list
+ std::vector<XbmcThreads::CEventGroup*> * groups;
+
+ /**
+ * To satisfy the TightConditionVariable requirements and allow the
+ * predicate being monitored to include both the signaled and interrupted
+ * states.
+ */
+ XbmcThreads::ConditionVariable actualCv;
+ XbmcThreads::TightConditionVariable<volatile bool&> condVar;
+ CCriticalSection mutex;
+
+ friend class XbmcThreads::CEventGroup;
+
+ void addGroup(XbmcThreads::CEventGroup* group);
+ void removeGroup(XbmcThreads::CEventGroup* group);
+
+ // helper for the two wait methods
+ inline bool prepReturn() { bool ret = signaled; if (!manualReset && numWaits == 0) signaled = false; return ret; }
+
public:
- bool WaitMSec(unsigned int milliSeconds);
- HANDLE GetHandle();
- void Reset();
+ inline CEvent(bool manual = false, bool signaled_ = false) :
+ manualReset(manual), signaled(signaled_), numWaits(0), groups(NULL), condVar(actualCv,signaled) {}
+
+ inline void Reset() { CSingleLock lock(mutex); signaled = false; }
void Set();
- void Wait();
- CEvent(bool manual = false);
- CEvent(const CEvent& event);
- CEvent& operator=(const CEvent& src);
- virtual ~CEvent();
+ /**
+ * This will wait up to 'milliSeconds' milliseconds for the Event
+ * to be triggered. The method will return 'true' if the Event
+ * was triggered. Otherwise it will return false.
+ */
+ inline bool WaitMSec(unsigned int milliSeconds)
+ { CSingleLock lock(mutex); numWaits++; condVar.wait(mutex,milliSeconds); numWaits--; return prepReturn(); }
+
+ /**
+ * This will wait for the Event to be triggered. The method will return
+ * 'true' if the Event was triggered. If it was either interrupted
+ * it will return false. Otherwise it will return false.
+ */
+ inline bool Wait()
+ { CSingleLock lock(mutex); numWaits++; condVar.wait(mutex); numWaits--; return prepReturn(); }
+
+ /**
+ * This is mostly for testing. It allows a thread to make sure there are
+ * the right amount of other threads waiting.
+ */
+ inline int getNumWaits() { CSingleLock lock(mutex); return numWaits; }
-protected:
- HANDLE m_hEvent;
};
-#endif // !defined(AFX_EVENT_H__724ADE14_0F5C_4836_B995_08FFAA97D6B9__INCLUDED_)
+namespace XbmcThreads
+{
+ /**
+ * CEventGroup is a means of grouping CEvents to wait on them together.
+ * It is equivalent to WaitOnMultipleObject that returns when "any" Event
+ * in the group signaled.
+ */
+ class CEventGroup : public NonCopyable
+ {
+ std::vector<CEvent*> events;
+ CEvent* signaled;
+ XbmcThreads::ConditionVariable actualCv;
+ XbmcThreads::TightConditionVariable<CEvent*&> condVar;
+ CCriticalSection mutex;
+
+ unsigned int numWaits;
+
+ // This is ONLY called from CEvent::Set.
+ inline void Set(CEvent* child) { CSingleLock l(mutex); signaled = child; condVar.notifyAll(); }
+
+ friend class ::CEvent;
+
+ public:
+
+ /**
+ * Create a CEventGroup from a number of CEvents. num is the number
+ * of Events that follow. E.g.:
+ *
+ * CEventGroup g(3, event1, event2, event3);
+ */
+ CEventGroup(int num, CEvent* v1, ...);
+
+ /**
+ * Create a CEventGroup from a number of CEvents. The parameters
+ * should form a NULL terminated list of CEvent*'s
+ *
+ * CEventGroup g(event1, event2, event3, NULL);
+ */
+ CEventGroup(CEvent* v1, ...);
+ ~CEventGroup();
+
+ /**
+ * This will block until any one of the CEvents in the group are
+ * signaled at which point a pointer to that CEvents will be
+ * returned.
+ */
+ CEvent* wait();
+
+ /**
+ * This will block until any one of the CEvents in the group are
+ * signaled or the timeout is reachec. If an event is signaled then
+ * it will return a pointer to that CEvent, otherwise it will return
+ * NULL.
+ */
+ CEvent* wait(unsigned int milliseconds);
+
+ /**
+ * This is mostly for testing. It allows a thread to make sure there are
+ * the right amount of other threads waiting.
+ */
+ inline int getNumWaits() { CSingleLock lock(mutex); return numWaits; }
+
+ };
+}
projects / vuplus_xbmc / blobdiff