SbThreadAutoWriteLock Class Reference
[Threads]

VSG extension Provides reliable unlocking of a write-only mutex. More...

#include <Inventor/threads/SbThreadAutoLock.h>

List of all members.

Public Member Functions

 SbThreadAutoWriteLock (SbThreadRWMutex *mutex)
 SbThreadAutoWriteLock (SbThreadRWMutex &mutex)
int unlock ()
int relock ()

Detailed Description

VSG extension Provides reliable unlocking of a write-only mutex.

This class provides reliable unlocking of a write-only mutex.

An SbThreadRWMutex object must be created separately. The address of the mutex object is passed to the constructor, which locks the mutex and saves a reference to the mutex object. The autolock object should be created on the stack, so each thread will have its own autolock. The destructor automatically unlocks the mutex.

Because the autolock object is created on the stack, it avoids the need to explicitly unlock the mutex at every point of exit from the function (a common source of errors). The mutex will be unlocked when the autolock goes out of scope.

The unlock() and relock() methods are provided for complex cases where the lock needs to be temporarily released. If the autolock is explicitly unlocked, the destructor does nothing.

Example:

      // myClass contains an RWMutex object named m_mutex
      void myClass::someFunction()
      {
         // m_mutex is a ptr to an existing SbThreadRWMutex object
         SbThreadAutoWriteLock dummyName( m_mutex );
         ... other code ...
      } // mutex automatically unlocked

SEE ALSO

SbThread, SbThreadAutoLock, SbThreadAutoReadLock, SbThreadBarrier, SbThreadMutex, SbThreadRWMutex


Constructor & Destructor Documentation

SbThreadAutoWriteLock::SbThreadAutoWriteLock ( SbThreadRWMutex mutex  ) 

Creates a mutex "autolock" object and automatically calls the mutex writelock method.

The mutex will be automatically unlocked when the autolock object is destroyed.

SbThreadAutoWriteLock::SbThreadAutoWriteLock ( SbThreadRWMutex mutex  ) 

Member Function Documentation

int SbThreadAutoWriteLock::relock (  ) 

Explicitly relock the associated mutex.

Do not unlock or lock the mutex directly.

int SbThreadAutoWriteLock::unlock (  ) 

Explicitly unlock the associated mutex.

Do not unlock or lock the mutex directly.


The documentation for this class was generated from the following file:

Open Inventor Toolkit reference manual, generated on 12 Nov 2020
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/