Panda3D
Public Member Functions

LightMutex Class Reference

This is a standard, non-reentrant mutex, similar to the Mutex class. More...

#include "lightMutex.h"

Inheritance diagram for LightMutex:
LightMutexDirect

List of all members.

Public Member Functions

 LightMutex (const char *name)
 LightMutex (const string &name)
void acquire () const
 Grabs the lightMutex if it is available.
void clear_name ()
 The lightMutex name is only defined when compiling in DEBUG_THREADS mode.
bool debug_is_locked () const
 Returns true if the current thread has locked the LightMutex, false otherwise.
string get_name () const
 The lightMutex name is only defined when compiling in DEBUG_THREADS mode.
bool has_name () const
 The lightMutex name is only defined when compiling in DEBUG_THREADS mode.
void output (ostream &out) const
 This method is declared virtual in LightMutexDebug, but non-virtual in LightMutexDirect.
void release () const
 Releases the lightMutex.
void set_name (const string &name)
 The lightMutex name is only defined when compiling in DEBUG_THREADS mode.

Detailed Description

This is a standard, non-reentrant mutex, similar to the Mutex class.

It is different from Mutex in the case of SIMPLE_THREADS: in this case, the LightMutex class compiles to nothing; it performs no locking whatsoever. It is therefore useful only to protect very small sections of code, during which you are confident there will be no thread yields.

In the normal, system-threaded implementation, this class is exactly the same as Mutex.

ConditionVars cannot be used with LightMutex; they work only with Mutex.

This class inherits its implementation either from MutexDebug or LightMutexDirect, depending on the definition of DEBUG_THREADS.

Definition at line 45 of file lightMutex.h.


Member Function Documentation

void LightMutexDirect::acquire ( ) const [inline, inherited]

Grabs the lightMutex if it is available.

If it is not available, blocks until it becomes available, then grabs it. In either case, the function does not return until the lightMutex is held; you should then call unlock().

This method is considered const so that you can lock and unlock const lightMutexes, mainly to allow thread-safe access to otherwise const data.

Also see LightMutexHolder.

Definition at line 70 of file lightMutexDirect.I.

Referenced by AdaptiveLru::do_evict_to(), LightMutexHolder::LightMutexHolder(), and GeomMunger::munge_geom().

void LightMutexDirect::clear_name ( ) [inline, inherited]

The lightMutex name is only defined when compiling in DEBUG_THREADS mode.

Definition at line 123 of file lightMutexDirect.I.

bool LightMutexDirect::debug_is_locked ( ) const [inline, inherited]
string LightMutexDirect::get_name ( ) const [inline, inherited]

The lightMutex name is only defined when compiling in DEBUG_THREADS mode.

Definition at line 144 of file lightMutexDirect.I.

bool LightMutexDirect::has_name ( ) const [inline, inherited]

The lightMutex name is only defined when compiling in DEBUG_THREADS mode.

Definition at line 133 of file lightMutexDirect.I.

void LightMutexDirect::output ( ostream &  out) const [inherited]

This method is declared virtual in LightMutexDebug, but non-virtual in LightMutexDirect.

Definition at line 26 of file lightMutexDirect.cxx.

void LightMutexDirect::release ( ) const [inline, inherited]

Releases the lightMutex.

It is an error to call this if the lightMutex was not already locked.

This method is considered const so that you can lock and unlock const lightMutexes, mainly to allow thread-safe access to otherwise const data.

Definition at line 86 of file lightMutexDirect.I.

Referenced by AdaptiveLru::do_evict_to(), and GeomMunger::munge_geom().

void LightMutexDirect::set_name ( const string &  name) [inline, inherited]

The lightMutex name is only defined when compiling in DEBUG_THREADS mode.

Definition at line 113 of file lightMutexDirect.I.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations