.. index:: pair: class; EE::System::Lock
.. _doxid-class_e_e_1_1_system_1_1_lock:

class EE::System::Lock
======================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Automatic wrapper for locking and unlocking mutexes. :ref:`More...<details-class_e_e_1_1_system_1_1_lock>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <lock.hpp>
	
	class Lock: private :ref:`EE::NonCopyable<doxid-class_e_e_1_1_non_copyable>` {
	public:
		// construction
	
		:ref:`Lock<doxid-class_e_e_1_1_system_1_1_lock_1a2d8c920a0f2270118ca26b3638046a6c>`(:ref:`Mutex<doxid-class_e_e_1_1_system_1_1_mutex>`& mutex);
		:ref:`~Lock<doxid-class_e_e_1_1_system_1_1_lock_1aff61a409c21282e368c0ee868ac174f2>`();
	};
.. _details-class_e_e_1_1_system_1_1_lock:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Automatic wrapper for locking and unlocking mutexes.

Construction
------------

.. index:: pair: function; Lock
.. _doxid-class_e_e_1_1_system_1_1_lock_1a2d8c920a0f2270118ca26b3638046a6c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	Lock(:ref:`Mutex<doxid-class_e_e_1_1_system_1_1_mutex>`& mutex)

Construct the lock with a target mutex The mutex passed to :ref:`Lock <doxid-class_e_e_1_1_system_1_1_lock>` is automatically locked.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- mutex

		- :ref:`Mutex <doxid-class_e_e_1_1_system_1_1_mutex>` to lock

.. _doxid-class_e_e_1_1_system_1_1_lock_1aff61a409c21282e368c0ee868ac174f2:
.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	~Lock()

Destructor The destructor of :ref:`Lock <doxid-class_e_e_1_1_system_1_1_lock>` automatically unlocks its mutex.