OW_NAMESPACE::MutexImpl Namespace Reference

The MutexImpl namespace represents the functionality needed by the OpenWbem Mutex class (Mutex). More...

Functions
int	createMutex (Mutex_t &handle)
	Create a platform specific mutext handle.
int	destroyMutex (Mutex_t &handle)
	Destroy a mutex previously created with createMutex.
int	acquireMutex (Mutex_t &handle)
	Acquire the mutex specified by a given mutex handle.
int	releaseMutex (Mutex_t &handle)
	Release a mutex that was previously acquired with the acquireMutex method.

---

Detailed Description

The MutexImpl namespace represents the functionality needed by the OpenWbem Mutex class (Mutex).

The implementation for these functions must be provided on all platforms that OpenWbem runs on. It is essentially an abstraction layer over another mutex implementation.

---

Function Documentation

int OW_NAMESPACE::MutexImpl::acquireMutex (  Mutex_t &  handle  )

Acquire the mutex specified by a given mutex handle. This method should block until the desired mutex can be acquired. The error return value is used to indicate critical errors. Parameters: handle  The mutex to acquire. Returns: 0 on success. -1 indicates a critical error. Definition at line 152 of file OW_MutexImpl.cpp. References OW_NAMESPACE::Mutex_t::mutex. Referenced by OW_NAMESPACE::NonRecursiveMutex::acquire(), and OW_NAMESPACE::Mutex::acquire().

int OW_NAMESPACE::MutexImpl::createMutex (  Mutex_t &  handle  )

Create a platform specific mutext handle. Parameters: handle  The mutex handle that should be initialized by this method Returns: 0 on success. Otherwise -1. Definition at line 53 of file OW_MutexImpl.cpp. References OW_NAMESPACE::Mutex_t::mutex. Referenced by OW_NAMESPACE::Mutex::Mutex().

int OW_NAMESPACE::MutexImpl::destroyMutex (  Mutex_t &  handle  )

Destroy a mutex previously created with createMutex. Parameters: handle  The handle to the mutex that will be destroyed. Returns: The following error codes: 0: success -1: Could not be acquired for destruction because it is currently locked. -2: All other error conditions Definition at line 112 of file OW_MutexImpl.cpp. References OW_NAMESPACE::Mutex_t::mutex. Referenced by OW_NAMESPACE::Mutex::~Mutex(), and OW_NAMESPACE::NonRecursiveMutex::~NonRecursiveMutex().

int OW_NAMESPACE::MutexImpl::releaseMutex (  Mutex_t &  handle  )

Release a mutex that was previously acquired with the acquireMutex method. Parameters: handle  The handle to the mutex that is being released. Returns: 0 on success. -1 indicates a critical error. Definition at line 195 of file OW_MutexImpl.cpp. References OW_NAMESPACE::Mutex_t::mutex. Referenced by OW_NAMESPACE::NonRecursiveMutex::release(), OW_NAMESPACE::Mutex::release(), OW_NAMESPACE::Mutex::~Mutex(), and OW_NAMESPACE::NonRecursiveMutex::~NonRecursiveMutex().

---