OW_NAMESPACE::NonRecursiveMutexImpl Namespace Reference

The NonRecursiveMutexImpl namespace represents the functionality needed by the OpenWbem non recursive Mutex class (NonRecursiveMutex). More...


Functions

int createMutex (NonRecursiveMutex_t &handle)
 Create a platform specific mutext handle.
int destroyMutex (NonRecursiveMutex_t &handle)
 Destroy a mutex previously created with createMutex.
int acquireMutex (NonRecursiveMutex_t &handle)
 Acquire the mutex specified by a given mutex handle.
int releaseMutex (NonRecursiveMutex_t &handle)
 Release a mutex that was previously acquired with the acquireMutex method.
int conditionPreWait (NonRecursiveMutex_t &handle, NonRecursiveMutexLockState &state)
int conditionPostWait (NonRecursiveMutex_t &handle, NonRecursiveMutexLockState &state)


Detailed Description

The NonRecursiveMutexImpl namespace represents the functionality needed by the OpenWbem non recursive Mutex class (NonRecursiveMutex).

The implementation for these function 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::NonRecursiveMutexImpl::acquireMutex NonRecursiveMutex_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 123 of file OW_NonRecursiveMutexImpl.cpp.

References OW_NAMESPACE::NonRecursiveMutex_t::mutex.

int OW_NAMESPACE::NonRecursiveMutexImpl::conditionPostWait NonRecursiveMutex_t &  handle,
NonRecursiveMutexLockState &  state
 

Definition at line 172 of file OW_NonRecursiveMutexImpl.cpp.

Referenced by OW_NAMESPACE::NonRecursiveMutex::conditionPostWait().

int OW_NAMESPACE::NonRecursiveMutexImpl::conditionPreWait NonRecursiveMutex_t &  handle,
NonRecursiveMutexLockState &  state
 

Definition at line 162 of file OW_NonRecursiveMutexImpl.cpp.

References OW_NAMESPACE::NonRecursiveMutex_t::mutex, and state.

Referenced by OW_NAMESPACE::NonRecursiveMutex::conditionPreWait().

int OW_NAMESPACE::NonRecursiveMutexImpl::createMutex NonRecursiveMutex_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_NonRecursiveMutexImpl.cpp.

References OW_NAMESPACE::NonRecursiveMutex_t::mutex.

Referenced by OW_NAMESPACE::NonRecursiveMutex::NonRecursiveMutex().

int OW_NAMESPACE::NonRecursiveMutexImpl::destroyMutex NonRecursiveMutex_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 93 of file OW_NonRecursiveMutexImpl.cpp.

References OW_NAMESPACE::NonRecursiveMutex_t::mutex.

Referenced by OW_NAMESPACE::NonRecursiveMutex::~NonRecursiveMutex().

int OW_NAMESPACE::NonRecursiveMutexImpl::releaseMutex NonRecursiveMutex_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 147 of file OW_NonRecursiveMutexImpl.cpp.

References OW_NAMESPACE::NonRecursiveMutex_t::mutex.


Generated on Thu Feb 9 09:18:00 2006 for openwbem by  doxygen 1.4.6