src/eric7/Documentation/Source/eric7.EricUtilities.EricMutexLocker.html

<!DOCTYPE html>
<html><head>
<title>eric7.EricUtilities.EricMutexLocker</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricUtilities.EricMutexLocker</h1>
<p>
Module implementing a context manager locking and unlocking a mutex.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#EricMutexLocker">EricMutexLocker</a></td>
<td>Class implementing a context manager locking and unlocking a mutex.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="EricMutexLocker" ID="EricMutexLocker"></a>
<h2>EricMutexLocker</h2>
<p>
    Class implementing a context manager locking and unlocking a mutex.
</p>

<h3>Derived from</h3>
contextlib.AbstractContextManager
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#EricMutexLocker.__init__">EricMutexLocker</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricMutexLocker.__enter__">__enter__</a></td>
<td>Special method called when entering the runtime ccontext.</td>
</tr>
<tr>
<td><a href="#EricMutexLocker.__exit__">__exit__</a></td>
<td>Special method called when exiting the runtime ccontext.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="EricMutexLocker.__init__" ID="EricMutexLocker.__init__"></a>
<h4>EricMutexLocker (Constructor)</h4>
<b>EricMutexLocker</b>(<i>mutex</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>mutex</i> (QMutex or QRecursiveMutex)</dt>
<dd>
reference to the mutex to be locked
</dd>
</dl>
<a NAME="EricMutexLocker.__enter__" ID="EricMutexLocker.__enter__"></a>
<h4>EricMutexLocker.__enter__</h4>
<b>__enter__</b>(<i></i>)
<p>
        Special method called when entering the runtime ccontext.
</p>

<dl>
<dt>Return:</dt>
<dd>
reference to the context manager object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
EricOverrideCursor
</dd>
</dl>
<a NAME="EricMutexLocker.__exit__" ID="EricMutexLocker.__exit__"></a>
<h4>EricMutexLocker.__exit__</h4>
<b>__exit__</b>(<i>_exc_type, _exc_value, _traceback</i>)
<p>
        Special method called when exiting the runtime ccontext.
</p>

<dl>

<dt><i>_exc_type</i> (Class)</dt>
<dd>
type of an exception raised in the runtime context (unused)
</dd>
<dt><i>_exc_value</i> (Exception)</dt>
<dd>
value of an exception raised in the runtime context (unused)
</dd>
<dt><i>_traceback</i> (Traceback)</dt>
<dd>
traceback of an exception raised in the runtime
            context (unused)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
always returns None to not suppress any exception
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
None
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>