Eidolon
Classes | Public Member Functions | Private Attributes | List of all members
Mutex Class Reference

Simple mutex type allowing locking and attempted locking with timeout. More...

#include <RenderTypes.h>

Collaboration diagram for Mutex:
Collaboration graph

Classes

class  Locker
 

Public Member Functions

 Mutex ()
 
 ~Mutex ()
 
bool lock (real timeout=0.0)
 
void release ()
 Releases the mutex lock. More...
 

Private Attributes

MutexType _mutex
 

Detailed Description

Simple mutex type allowing locking and attempted locking with timeout.

Constructor & Destructor Documentation

◆ Mutex()

Mutex ( )
inline

◆ ~Mutex()

~Mutex ( )
inline

Member Function Documentation

◆ lock()

bool lock ( real  timeout = 0.0)
inline

Acquire the mutex lock. If `timeout' is >0 try for that length of time in seconds to acquire the lock. Returns true if `timeout'<=0 or the lock was acquired in the time given, false if the time elapsed without getting the lock.

Here is the caller graph for this function:

◆ release()

void release ( )
inline

Releases the mutex lock.

Here is the caller graph for this function:

Member Data Documentation

◆ _mutex

MutexType _mutex
private

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