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...

Inheritance diagram for LightMutexDirect:
LightMutex

Public Member Functions

 acquire ()
 Grabs the lightMutex if it is available. More...
 
 clearName ()
 The lightMutex name is only defined when compiling in DEBUG_THREADS mode. More...
 
bool debugIsLocked ()
 Returns true if the current thread has locked the LightMutex, false otherwise. More...
 
str getName ()
 The lightMutex name is only defined when compiling in DEBUG_THREADS mode. More...
 
bool hasName ()
 The lightMutex name is only defined when compiling in DEBUG_THREADS mode. More...
 
 output (Ostream out)
 This method is declared virtual in LightMutexDebug, but non-virtual in LightMutexDirect. More...
 
 release ()
 Releases the lightMutex. More...
 
 setName (str 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.

Member Function Documentation

◆ acquire()

acquire ( )

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.

◆ clearName()

clearName ( )

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

◆ debugIsLocked()

bool debugIsLocked ( )

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.

◆ getName()

str getName ( )

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

◆ hasName()

bool hasName ( )

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

◆ output()

output ( Ostream  out)

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

◆ release()

release ( )

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.

◆ setName()

setName ( str  name)

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