vpMutex::vpScopedLock Class Reference

#include <visp3/core/vpMutex.h>

Public Member Functions
	vpScopedLock (vpMutex &mutex)
	~vpScopedLock ()

Detailed Description

Class that allows protection by mutex.

The following example shows how to use this class to protect a portion of code from concurrent access. The scope of the mutex lock/unlock is determined by the constructor/destructor.

 #include <visp3/core/vpMutex.h>

int main()
{
  vpMutex mutex;

  {
    vpMutex::vpScopedLock lock(mutex);
    // shared var to protect
  }
}

Without using vpScopedLock, the previous example would become:

#include <visp3/core/vpMutex.h>

int main()
{
  vpMutex mutex;

  {
    mutex.lock();
    // shared var to protect
    mutex.unlock()
  }
}

More examples are provided in Tutorial: How to use multi-threading capabilities.

See also

vpMutex

Examples:

grabRealSense.cpp, testForceTorqueAti.cpp, tutorial-face-detector-live-threaded.cpp, tutorial-grabber-opencv-threaded.cpp, and tutorial-grabber-v4l2-threaded.cpp.

Definition at line 170 of file vpMutex.h.

Constructor & Destructor Documentation

vpScopedLock()

vpMutex::vpScopedLock::vpScopedLock ( vpMutex &  mutex )

inline

Constructor that locks the mutex.

Definition at line 185 of file vpMutex.h.

References vpMutex::lock().

~vpScopedLock()

vpMutex::vpScopedLock::~vpScopedLock ( )

inline

Destructor that unlocks the mutex.

Definition at line 187 of file vpMutex.h.

References vpMutex::unlock().