ucommon::Mutex Class Reference
Generic non-recursive exclusive lock class.
More...
#include <thread.h>
Data Structures |
class | guard |
| Guard class to apply scope based mutex locking to objects. More...
|
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 void | protect (const void *pointer) |
| Specify pointer/object/resource to guard protect.
|
static void | 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@gnutelephony.org>
Definition at line 919 of file thread.h.
Member Function Documentation
static void ucommon::Mutex::acquire |
( |
pthread_mutex_t * |
lock |
) |
[inline, static] |
Convenience function to acquire os native mutex lock directly.
- Parameters:
-
Definition at line 1018 of file thread.h.
void ucommon::Mutex::acquire |
( |
void |
|
) |
[inline] |
Acquire mutex lock.
This is a blocking operation.
Definition at line 993 of file thread.h.
static 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. |
void ucommon::Mutex::lock |
( |
void |
|
) |
[inline] |
Acquire mutex lock.
This is a blocking operation.
Definition at line 999 of file thread.h.
static void ucommon::Mutex::protect |
( |
const void * |
pointer |
) |
[static] |
Specify pointer/object/resource to guard protect.
This uses a dynamically managed mutex.
- Parameters:
-
static void ucommon::Mutex::release |
( |
const void * |
pointer |
) |
[static] |
Specify a pointer/object/resource to release.
- Parameters:
-
static void ucommon::Mutex::release |
( |
pthread_mutex_t * |
lock |
) |
[inline, static] |
Convenience function to release os native mutex lock directly.
- Parameters:
-
Definition at line 1025 of file thread.h.
The documentation for this class was generated from the following file: