Panda3D
Public Member Functions | List of all members
LightMutexDirect Class Reference

This class implements a lightweight Mutex by making direct calls to the underlying implementation layer. More...

#include "lightMutexDirect.h"

Inheritance diagram for LightMutexDirect:
LightMutex

Public Member Functions

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

Detailed Description

This class implements a lightweight Mutex by making direct calls to the underlying implementation layer.

It doesn't perform any debugging operations.

Definition at line 33 of file lightMutexDirect.h.

Member Function Documentation

◆ acquire()

void LightMutexDirect::acquire ( ) const
inline

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.

References release().

Referenced by GeomVertexData::copy_row_from(), LightMutexHolder::LightMutexHolder(), and GeomMunger::munge_geom().

◆ clear_name()

void LightMutexDirect::clear_name ( )
inline

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

Definition at line 123 of file lightMutexDirect.I.

References has_name().

Referenced by set_name().

◆ debug_is_locked()

bool LightMutexDirect::debug_is_locked ( ) const
inline

Returns true if the current thread has locked the LightMutex, false otherwise.

This method is only intended for use in debugging, hence the method name; in the LightMutexDirect case, it always returns true, since there's not a reliable way to determine this otherwise.

Definition at line 102 of file lightMutexDirect.I.

References set_name().

Referenced by PandaNode::get_parents(), and release().

◆ get_name()

string LightMutexDirect::get_name ( ) const
inline

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

Definition at line 144 of file lightMutexDirect.I.

Referenced by has_name().

◆ has_name()

bool LightMutexDirect::has_name ( ) const
inline

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

Definition at line 133 of file lightMutexDirect.I.

References get_name().

Referenced by clear_name().

◆ output()

void LightMutexDirect::output ( ostream &  out) const

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

Definition at line 26 of file lightMutexDirect.cxx.

◆ release()

void LightMutexDirect::release ( ) const
inline

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.

References debug_is_locked().

Referenced by acquire(), GeomVertexData::copy_row_from(), and GeomMunger::munge_geom().

◆ set_name()

void LightMutexDirect::set_name ( const string &  name)
inline

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

Definition at line 113 of file lightMutexDirect.I.

References clear_name().

Referenced by debug_is_locked().


The documentation for this class was generated from the following files: