historical/toontown-classic.git/panda/include/conditionVarDebug.h
2024-01-16 11:20:27 -06:00

64 lines
1.6 KiB
C++

/**
* PANDA 3D SOFTWARE
* Copyright (c) Carnegie Mellon University. All rights reserved.
*
* All use of this software is subject to the terms of the revised BSD
* license. You should have received a copy of this license along
* with this source code in a file named "LICENSE."
*
* @file conditionVarDebug.h
* @author drose
* @date 2006-02-13
*/
#ifndef CONDITIONVARDEBUG_H
#define CONDITIONVARDEBUG_H
#include "pandabase.h"
#include "pmutex.h"
#include "conditionVarImpl.h"
#ifdef DEBUG_THREADS
/**
* A condition variable, usually used to communicate information about
* changing state to a thread that is waiting for something to happen. A
* condition variable can be used to "wake up" a thread when some arbitrary
* condition has changed.
*
* A condition variable is associated with a single mutex, and several
* condition variables may share the same mutex.
*/
class EXPCL_PANDA_PIPELINE ConditionVarDebug {
public:
explicit ConditionVarDebug(MutexDebug &mutex);
ConditionVarDebug(const ConditionVarDebug &copy) = delete;
virtual ~ConditionVarDebug();
ConditionVarDebug &operator = (const ConditionVarDebug &copy) = delete;
PUBLISHED:
INLINE MutexDebug &get_mutex() const;
BLOCKING void wait();
BLOCKING void wait(double timeout);
void notify();
void notify_all();
virtual void output(std::ostream &out) const;
private:
MutexDebug &_mutex;
ConditionVarImpl _impl;
};
INLINE std::ostream &
operator << (std::ostream &out, const ConditionVarDebug &cv) {
cv.output(out);
return out;
}
#include "conditionVarDebug.I"
#endif // DEBUG_THREADS
#endif