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

56 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 conditionVar.h
* @author drose
* @date 2002-08-09
*/
#ifndef CONDITIONVAR_H
#define CONDITIONVAR_H
#include "pandabase.h"
#include "conditionVarDebug.h"
#include "conditionVarDirect.h"
/**
* 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.
*
* This class inherits its implementation either from ConditionVarDebug or
* ConditionVarDirect, depending on the definition of DEBUG_THREADS.
*/
#ifdef DEBUG_THREADS
class EXPCL_PANDA_PIPELINE ConditionVar : public ConditionVarDebug
#else
class EXPCL_PANDA_PIPELINE ConditionVar : public ConditionVarDirect
#endif // DEBUG_THREADS
{
PUBLISHED:
INLINE explicit ConditionVar(Mutex &mutex);
ConditionVar(const ConditionVar &copy) = delete;
~ConditionVar() = default;
ConditionVar &operator = (const ConditionVar &copy) = delete;
// These methods are inherited from the base class.
//INLINE void wait();
//INLINE void notify();
//INLINE void notify_all();
INLINE Mutex &get_mutex() const;
};
#include "conditionVar.I"
#endif