A mutex is mutual exclusion: a blocking lock. More...

#include <Mutex.h>

Inherits atscppapi::noncopyable.

Collaboration diagram for atscppapi::Mutex:

Public Types
enum	Type { TYPE_NORMAL = 0, TYPE_RECURSIVE, TYPE_ERROR_CHECK }
	The available types of Mutexes. More...
Public Member Functions
	Mutex (Type type=TYPE_NORMAL)
	Create a mutex.
	~Mutex ()
bool	tryLock ()
	Try to take the lock, this call will NOT block if the mutex cannot be taken.
void	lock ()
	Block until the lock is taken, when this call returns the thread will be holding the lock.
void	unlock ()
	Unlock the lock, this call is nonblocking.

Detailed Description

A mutex is mutual exclusion: a blocking lock.

The Mutex class uses pthreads for its implmentation.

See also:: ScopedMutexLock; ScopedMutexTryLock; ScopedSharedMutexLock; ScopedSharedMutexTryLock

Definition at line 44 of file Mutex.h.

Member Enumeration Documentation

The available types of Mutexes.

Enumerator:

TYPE_NORMAL	This type of Mutex will deadlock if locked by a thread already holding the lock.
TYPE_RECURSIVE	This type of Mutex will allow a thread holding the lock to lock it again; however, it must be unlocked the same number of times.
TYPE_ERROR_CHECK	This type of Mutex will return errno = EDEADLCK if a thread would deadlock by taking the lock after it already holds it.