--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.EricUtilities.EricMutexLocker.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,160 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.EricUtilities.EricMutexLocker</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</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></dt> +<dd> +type of an exception raised in the runtime context +</dd> +<dt><i>exc_value</i></dt> +<dd> +value of an exception raised in the runtime context +</dd> +<dt><i>traceback</i></dt> +<dd> +traceback of an exception raised in the runtime + context +</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> \ No newline at end of file