class MMutexLock

Jump to documentation

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

public members:

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

Documentation

Methods for managing locks on threads created with MThreadPool and MThreadAsync. (OpenMaya)
Description

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

Functions

MMutexLock:: MMutexLock ()
Description

Create new mutex object. The object is created unlocked.

MMutexLock:: ~MMutexLock ()

Description

Destructor.

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

void MMutexLock:: lock ()

Description

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 ()

Description

Release the current lock on a mutex.

bool MMutexLock:: tryLock ()

Description

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

Return Value

  • true lock was obtained
  • false lock was not obtained

This class has no child classes.


Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright