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:

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...
std::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	lock ()
	Alias for acquire() to match C++11 semantics. More...
void	output (std::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 std::string &name)
	The lightMutex name is only defined when compiling in DEBUG_THREADS mode. More...
bool	try_lock ()
	Alias for try_acquire() to match C++11 semantics. More...
void	unlock ()
	Alias for release() to match C++11 semantics. 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 31 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 56 of file lightMutexDirect.I.

Referenced by CPT(), and LightMutexHolder::LightMutexHolder().

clear_name()

void LightMutexDirect::clear_name ( )

inline

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

Definition at line 96 of file lightMutexDirect.I.

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 81 of file lightMutexDirect.I.

get_name()

std::string LightMutexDirect::get_name ( ) const

inline

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

Definition at line 111 of file lightMutexDirect.I.

has_name()

bool LightMutexDirect::has_name ( ) const

inline

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

Definition at line 103 of file lightMutexDirect.I.

lock()

void LightMutexDirect::lock ( )

inline

Alias for acquire() to match C++11 semantics.

See also

acquire()

Definition at line 19 of file lightMutexDirect.I.

output()

void LightMutexDirect::output

(

std::ostream &

out

)

const

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

Definition at line 23 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 69 of file lightMutexDirect.I.

Referenced by CPT().

set_name()

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

inline

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

Definition at line 89 of file lightMutexDirect.I.

try_lock()

bool LightMutexDirect::try_lock ( )

inline

Alias for try_acquire() to match C++11 semantics.

See also

try_acquire()

Definition at line 29 of file lightMutexDirect.I.

unlock()

void LightMutexDirect::unlock ( )

inline

Alias for release() to match C++11 semantics.

See also

release()

Definition at line 39 of file lightMutexDirect.I.

---

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

• panda/src/pipeline/lightMutexDirect.h
• panda/src/pipeline/lightMutexDirect.cxx
• panda/src/pipeline/lightMutexDirect.I