Linux Certif

Toute la documentation sur la certification Linux LPI

SbThreadAutoLock.3sim

NAME

SbThreadAutoLock - 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.

SYNOPSIS

#include <Inventor/threads/SbThreadAutoLock.h>

Public Member Functions

SbThreadAutoLock (SbMutex *mutexptr)

~SbThreadAutoLock ()

Protected Attributes

SbMutex * mutex

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.

References SbMutex::lock().

SbThreadAutoLock::~SbThreadAutoLock () [inline]

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

References SbMutex::unlock().

Author

Generated automatically by Doxygen for Coin from the source code.