UaMutex Class Reference [UA Base Library Classes]

The UaMutex class provides access serialization between threads. The purpose of a UaMutex is to protect an object, data structure or section of code so that only one thread can access it at a time (this is similar to the Java synchronized keyword). It is usually best to use a mutex with a UaMutexLocker since this makes it easy to ensure that locking and unlocking are performed consistently. It is not possible to create plane copies of this Class. More...

#include <uamutex.h>

Inheritance diagram for UaMutex:

List of all members.

Public Member Functions
	UaMutex ()
	~UaMutex ()
void	lock ()
void	unlock ()

---

Detailed Description

The UaMutex class provides access serialization between threads. The purpose of a UaMutex is to protect an object, data structure or section of code so that only one thread can access it at a time (this is similar to the Java synchronized keyword). It is usually best to use a mutex with a UaMutexLocker since this makes it easy to ensure that locking and unlocking are performed consistently. It is not possible to create plane copies of this Class.

---

Constructor & Destructor Documentation

UaMutex::UaMutex

(

)

construction Constructs a UaMutex object that allows threads to lock() the mutex to block access to a resource.

UaMutex::~UaMutex

(

)

destruction Destroys the UaMutex object.

Warning:

If you destroy a mutex that has accesses in use the resultant behavior is undefined.

---

Member Function Documentation

void UaMutex::lock

(

)

Attempts to lock the mutex. This function will block the current thread if the mutex is already locked.

See also:

unlock()

void UaMutex::unlock

(

)

Unlocks the mutex.

---

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

• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uamutex.h
• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uamutex.cpp