This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::ScopedLock Class

Header: #include <UnigineThread.h>

This class implements a writer lock operating on a simple mutex.

Scoped locks work by locking a mutex when they are constructed, and unlocking it when they are destructed. The C++ rules guarantee that when the control flow leaves a scope (even via an exception), objects local to the scope being exited are destructed correctly. This means using a scoped lock instead of manually calling lock() and unlock() makes it impossible to accidentally not unlock the mutex, e.g. when an exception is thrown in the middle of the code between lock() and unlock().

Usage Example#

Here is a small code-snippet illustrating the scoped lock usage:

Source code (C++)
// declaring a mutex
Mutex shared_mutex_obj;

// ...

void do_something()
{
	// at this point in the ScopedLock constructor the mutex is locked, 
	// and a reference to it is kept in the 'lock' object for future use
	ScopedLock lock(shared_mutex_obj);

	//here goes the critical section code
	// ...

}//<-- at this point the 'lock' object goes out of scope
 // which means that the destructor of ScopedLock will run.
 // inside the destructor, the mutex is unlocked.

ScopedLock Class

Members


static ScopedLockPtr create ( Mutex & m ) #

Constructs a scoped lock for the specified synchronization object (simple mutex).

Arguments

Last update: 2022-03-10
Build: ()