ucommon::Mutex Class Reference

Generic non-recursive exclusive lock class. More...

#include <thread.h>

Inheritance diagram for ucommon::Mutex:

Collaboration diagram for ucommon::Mutex:

Public Types
typedef autoexclusive< Mutex >	autolock

Public Member Functions
void	acquire (void)
	Acquire mutex lock.
void	lock (void)
	Acquire mutex lock.
	Mutex ()
	Create a mutex lock.
void	release (void)
	Release acquired lock.
void	unlock (void)
	Release acquired lock.
	~Mutex ()
	Destroy mutex lock, release waiting threads.

Static Public Member Functions
static void	acquire (pthread_mutex_t *lock)
	Convenience function to acquire os native mutex lock directly.
static void	indexing (unsigned size)
	Specify hash table size for guard protection.
static bool	protect (const void *pointer)
	Specify pointer/object/resource to guard protect.
static bool	release (const void *pointer)
	Specify a pointer/object/resource to release.
static void	release (pthread_mutex_t *lock)
	Convenience function to release os native mutex lock directly.

Protected Member Functions
virtual void	_lock (void)
virtual void	_unlock (void)

Protected Attributes
pthread_mutex_t	mlock

Detailed Description

Generic non-recursive exclusive lock class.

This class also impliments the exclusive_lock protocol. In addition, an interface is offered to support dynamically managed mutexes which are internally pooled. These can be used to protect and serialize arbitrary access to memory and objects on demand. This offers an advantage over embedding mutexes to serialize access to individual objects since the maximum number of mutexes will never be greater than the number of actually running threads rather than the number of objects being potentially protected. The ability to hash the pointer address into an indexed table further optimizes access by reducing the chance for collisions on the primary index mutex.

Author

David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 459 of file thread.h.

Member Typedef Documentation

autolock

typedef autoexclusive<Mutex> ucommon::Mutex::autolock

Definition at line 471 of file thread.h.

Member Function Documentation

_lock()

virtual void ucommon::Mutex::_lock ( void )

protectedvirtual

Implements ucommon::ExclusiveProtocol.

_unlock()

virtual void ucommon::Mutex::_unlock ( void )

protectedvirtual

Implements ucommon::ExclusiveProtocol.

acquire() [1/2]

void ucommon::Mutex::acquire ( pthread_mutex_t * lock )

inlinestatic

Convenience function to acquire os native mutex lock directly.

Parameters

lock	to acquire.

Definition at line 515 of file thread.h.

Here is the call graph for this function:

acquire() [2/2]

void ucommon::Mutex::acquire ( void )

inline

Acquire mutex lock.

This is a blocking operation.

Definition at line 486 of file thread.h.

indexing()

void ucommon::Mutex::indexing ( unsigned size )

static

Specify hash table size for guard protection.

The default is 1. This should be called at initialization time from the main thread of the application before any other threads are created.

Parameters

size	of hash table used for guarding.

lock()

void ucommon::Mutex::lock ( void )

inline

Acquire mutex lock.

This is a blocking operation.

Definition at line 493 of file thread.h.

protect()

bool ucommon::Mutex::protect ( const void * pointer )

static

Specify pointer/object/resource to guard protect.

This uses a dynamically managed mutex.

Parameters

pointer

to protect.

release() [1/3]

bool ucommon::Mutex::release ( const void * pointer )

static

Specify a pointer/object/resource to release.

Parameters

pointer

to release.

release() [2/3]

void ucommon::Mutex::release ( pthread_mutex_t * lock )

inlinestatic

Convenience function to release os native mutex lock directly.

Parameters

lock	to release.

Definition at line 523 of file thread.h.

Here is the call graph for this function:

release() [3/3]

void ucommon::Mutex::release ( void )

inline

Release acquired lock.

Definition at line 507 of file thread.h.

unlock()

void ucommon::Mutex::unlock ( void )

inline

Release acquired lock.

Definition at line 500 of file thread.h.

Field Documentation

mlock

pthread_mutex_t ucommon::Mutex::mlock

mutableprotected

Definition at line 465 of file thread.h.

---

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

• /builddir/build/BUILD/ucommon-7.0.0-build/ucommon-7.0.0/inc/ucommon/thread.h