MMutexLock Class Reference
[OpenMaya - API module for common classes]

#include <MMutexLock.h>

List of all members.

Detailed Description

Methods for managing locks on threads created with MThreadPool and MThreadAsync.

Mutex lock class to be used with threads created by MThreadPool and MThreadAsync.


cvColorShader.cpp, and threadTestWithLocksCmd.cpp.

Public Member Functions

  MMutexLock ()
  ~MMutexLock ()
void  lock ()
void  unlock ()
bool  tryLock ()

Constructor & Destructor Documentation

MMutexLock::MMutexLock (  ) 

Create new mutex object. The object is created unlocked.

MMutexLock::~MMutexLock (  ) 

Calling the destructor on a locked mutex does not unlock the mutex. That must be done by calling unlock() before calling the destructor.

Member Function Documentation

void MMutexLock::lock (  ) 

Create a lock. If the mutex is available it is locked immediately. If it is already locked by another thread, this function waits until the other thread has unlocked it, then creates the lock.

void MMutexLock::unlock (  ) 

Release the current lock on a mutex.

bool MMutexLock::tryLock (  ) 

Attempt to lock the mutex. If the mutex is already locked by another thread, the function returns right away.

  • true lock was obtained
  • false lock was not obtained

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6