Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Protected Attributes

SbThreadAutoLock Class Reference

Simple convenience class for locking access to a function.This class provides a simple convenience mechanism for automatically locking access to a function that is not re-entrant. More...

#include <Inventor/threads/SbThreadAutoLock.h>

List of all members.

Public Member Functions

 SbThreadAutoLock (SbMutex *mutexptr)
 ~SbThreadAutoLock ()

Protected Attributes

SbMutexmutex

Detailed Description

Simple convenience class for locking access to a function.

This class provides a simple convenience mechanism for automatically locking access to a function that is not re-entrant.

Usage example:

  void
  myfunction(void)
  {
    SbThreadAutoLock lock(aMutexPtr);

    // [other code]
  }

In the class constructor, SbMutex::lock() is called on the mutex, and when the function exits (this is the convenience part) the destructor will automatically be invoked, calling SbMutex::unlock() on the same mutex.


Constructor & Destructor Documentation

SbThreadAutoLock::SbThreadAutoLock ( SbMutex mutex) [inline]

The constructor calls SbMutex::lock() on mutex.

The constructor calls SbThreadMutex::lock() on mutex.

References SbMutex::lock().

SbThreadAutoLock::~SbThreadAutoLock ( ) [inline]

The destructor calls unlock() on the mutex passed in as a parameter to the constructor.

References SbMutex::unlock().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:01 for Coin by Doxygen. 1.7.3