logog
logger optimized for games
Mutex Class Reference

[Mutex] More...

#include <mutex.hpp>

+ Inheritance diagram for Mutex:

Public Member Functions

 Mutex ()
 
 ~Mutex ()
 
void MutexLock ()
 
void MutexUnlock ()
 
- Public Member Functions inherited from Object
 Object ()
 
virtual ~Object ()
 
void * operator new (size_t nSize)
 
void * operator new[] (size_t nSize)
 
void operator delete (void *ptr)
 
void operator delete[] (void *ptr)
 

Protected Member Functions

 Mutex (const Mutex &)
 
Mutexoperator= (const Mutex &)
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static void * Allocate (size_t nSize)
 
static void Deallocate (void *ptr)
 

Detailed Description

[Mutex]

[Mutex] An object that can only be locked by one thread at a time. Implement the LOGOG_MUTEX_* functions for your platform to support the Mutex object. A mutex is intended to be used with the ScopedLock object to implement critical sections within logog.

See also
ScopedLock

Constructor & Destructor Documentation

Mutex ( )
~Mutex ( )
Mutex ( const Mutex )
protected

Member Function Documentation

void MutexLock ( )

Acquires a lock on the mutex. Only one thread is permitted to lock the mutex at one time.

void MutexUnlock ( )

Releases the lock on the mutex.

Mutex& operator= ( const Mutex )
protected

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