Abstract base class for platform specific 'Mutex' implementations. More...
#include <MutexImpl.h>
Inheritance diagram for PLCore::MutexImpl:
Protected Member Functions | |
| MutexImpl () | |
| Constructor. | |
| virtual | ~MutexImpl () |
| Destructor. | |
| virtual bool | Lock ()=0 |
| Locks the mutex. | |
| virtual bool | TryLock (uint64 nTimeout)=0 |
| Locks the mutex, but only wait until timeout. | |
| virtual bool | Unlock ()=0 |
| Unlocks the mutex. | |
Detailed Description
Abstract base class for platform specific 'Mutex' implementations.
- Note:
- Implementation of the bridge design pattern, this class is the implementor of the 'Mutex' abstraction
Constructor & Destructor Documentation
| PLCore::MutexImpl::MutexImpl | ( | ) | [protected] |
| virtual PLCore::MutexImpl::~MutexImpl | ( | ) | [protected, virtual] |
Destructor.
Member Function Documentation
| virtual bool PLCore::MutexImpl::Lock | ( | ) | [protected, pure virtual] |
Locks the mutex.
- Returns:
- 'true' if successful, 'false' on error
| virtual bool PLCore::MutexImpl::TryLock | ( | uint64 | nTimeout | ) | [protected, pure virtual] |
Locks the mutex, but only wait until timeout.
- Parameters:
-
[in] nTimeout Timeout in milliseconds
- Returns:
- 'true' if successful, 'false' on error
- Note:
- nTimeout = 0 means no timeout at all
| virtual bool PLCore::MutexImpl::Unlock | ( | ) | [protected, pure virtual] |
Unlocks the mutex.
- Returns:
- 'true' if successful, 'false' on error
The documentation for this class was generated from the following file:
