Falcon::Mutex Class Reference

Generic mutex class. More...

#include <mt_posix.h>

List of all members.

Public Member Functions
void	lock ()
	Locks the mutex.
void	lock ()
	Locks the mutex.
	Mutex ()
	Creates the mutex.
	Mutex ()
	Creates the mutex.
bool	trylock ()
	Tries to lock the mutex.
bool	trylock ()
	Tries to lock the mutex.
void	unlock ()
	Unlocks the mutex.
void	unlock ()
	Unlocks the mutex.
	~Mutex ()
	Destroys the mutex.
	~Mutex ()
	Destroys the mutex.

---

Detailed Description

Generic mutex class.

Directly mapping to the underlying type via inline functions.

The mutex must be considered as non-reentrant.

---

Constructor & Destructor Documentation

Falcon::Mutex::Mutex

(

)

[inline]

Creates the mutex.

Will assert on failure.

References fassert.

Falcon::Mutex::~Mutex

(

)

[inline]

Destroys the mutex.

Will assert on failure.

References fassert.

Falcon::Mutex::Mutex

(

)

[inline]

Creates the mutex.

Will assert on failure.

Falcon::Mutex::~Mutex

(

)

[inline]

Destroys the mutex.

Will assert on failure.

---

Member Function Documentation

void Falcon::Mutex::lock

(

)

[inline]

Locks the mutex.

Will assert on failure -- but only in debug

void Falcon::Mutex::lock

(

)

[inline]

Locks the mutex.

Will assert on failure -- but only in debug

References fassert.

bool Falcon::Mutex::trylock

(

)

[inline]

Tries to lock the mutex.

Will assert on failure.

bool Falcon::Mutex::trylock

(

)

[inline]

Tries to lock the mutex.

Will assert on failure.

References fassert.

void Falcon::Mutex::unlock

(

)

[inline]

Unlocks the mutex.

Will assert on failure -- but only in debug

void Falcon::Mutex::unlock

(

)

[inline]

Unlocks the mutex.

Will assert on failure -- but only in debug

References fassert.

---

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

• /home/gian/Progetti/falcon/core/include/falcon/mt_posix.h
• /home/gian/Progetti/falcon/core/include/falcon/mt_win.h