icl_core::thread::Mutex Class Reference

#include <Mutex.h>

Inheritance diagram for icl_core::thread::Mutex:

Public Member Functions
bool	lock ()
bool	lock (const ::icl_core::TimeStamp &timeout)
bool	lock (const ::icl_core::TimeSpan &timeout)
	Mutex ()
bool	tryLock ()
void	unlock ()
virtual	~Mutex ()

Private Attributes
MutexImpl *	m_impl

Additional Inherited Members
Protected Member Functions inherited from icl_core::Noncopyable
	Noncopyable ()
virtual	~Noncopyable ()

Detailed Description

Implements a platform independent mutex.

Definition at line 47 of file Mutex.h.

Constructor & Destructor Documentation

icl_core::thread::Mutex::Mutex

(

)

Creates a mutex.

Definition at line 53 of file Mutex.cpp.

icl_core::thread::Mutex::~Mutex ( )

virtual

Destroys a mutex.

Definition at line 85 of file Mutex.cpp.

Member Function Documentation

bool icl_core::thread::Mutex::lock

(

)

Locks a mutex. Blocks until the mutex can be locked or a severe error occurs. Returns true on success and false on failure.

Definition at line 92 of file Mutex.cpp.

bool icl_core::thread::Mutex::lock

(

const ::icl_core::TimeStamp &

timeout

)

Locks a mutex with an absolute timeout. The function may then return with false, if the absolute time passes without being able to lock the mutex.

Definition at line 100 of file Mutex.cpp.

bool icl_core::thread::Mutex::lock

(

const ::icl_core::TimeSpan &

timeout

)

Locks a mutex with a relative timeout. The function may then return with false, if the relative time passes without being able to lock the mutex.

Definition at line 108 of file Mutex.cpp.

bool icl_core::thread::Mutex::tryLock

(

)

Tries to lock a mutex without blocking. The mutex is locked if it is available.

Returns

true if the mutex has been locked, false otherwise.

Definition at line 116 of file Mutex.cpp.

void icl_core::thread::Mutex::unlock

(

)

Releases a mutex lock.

Definition at line 124 of file Mutex.cpp.

Member Data Documentation

MutexImpl* icl_core::thread::Mutex::m_impl

private

Definition at line 127 of file Mutex.h.

---

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

• Mutex.h
• Mutex.cpp