Amebis/WinStd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
WinStd/classwinstd_1_1mutex__locker.html

187 lines
9.9 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: winstd::mutex_locker Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">WinStd
</div>
<div id="projectbrief">Windows Win32 API using Standard C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>winstd</b></li><li class="navelem"><a class="el" href="classwinstd_1_1mutex__locker.html">mutex_locker</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classwinstd_1_1mutex__locker-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">winstd::mutex_locker Class Reference<div class="ingroups"><a class="el" href="group___win_std_win_a_p_i.html">Windows API</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Locks given mutex in constructor and releases it in destructor.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_win_8h_source.html">WinStd/Win.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:addccf4e857fce57147b8a3751b732b11" id="r_addccf4e857fce57147b8a3751b732b11"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#addccf4e857fce57147b8a3751b732b11">mutex_locker</a> (<a class="el" href="classwinstd_1_1ref__unique__ptr.html">HANDLE</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">hMutex</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">DWORD</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">dwMilliseconds</a>=<a class="el" href="classwinstd_1_1ref__unique__ptr.html">INFINITE</a>)</td></tr>
<tr class="memdesc:addccf4e857fce57147b8a3751b732b11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits until the specified mutex is in the signaled state or the time-out interval elapses. <br /></td></tr>
<tr class="separator:addccf4e857fce57147b8a3751b732b11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a268ea63b38ec01c65c138f1136df4758" id="r_a268ea63b38ec01c65c138f1136df4758"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">virtual</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a268ea63b38ec01c65c138f1136df4758">~mutex_locker</a> ()</td></tr>
<tr class="memdesc:a268ea63b38ec01c65c138f1136df4758"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases ownership of the mutex object. <br /></td></tr>
<tr class="separator:a268ea63b38ec01c65c138f1136df4758"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a9cbaf4ee522436faade77d68c3a1640d" id="r_a9cbaf4ee522436faade77d68c3a1640d"><td class="memItemLeft" align="right" valign="top"><a id="a9cbaf4ee522436faade77d68c3a1640d" name="a9cbaf4ee522436faade77d68c3a1640d"></a>
<a class="el" href="classwinstd_1_1ref__unique__ptr.html">HANDLE</a>&#160;</td><td class="memItemRight" valign="bottom"><b>m_h</b></td></tr>
<tr class="separator:a9cbaf4ee522436faade77d68c3a1640d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Locks given mutex in constructor and releases it in destructor. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="addccf4e857fce57147b8a3751b732b11" name="addccf4e857fce57147b8a3751b732b11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addccf4e857fce57147b8a3751b732b11">&#9670;&#160;</a></span>mutex_locker()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">winstd::mutex_locker::mutex_locker </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">HANDLE</a></td> <td class="paramname"><span class="paramname"><em>hMutex</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">DWORD</a></td> <td class="paramname"><span class="paramname"><em>dwMilliseconds</em><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">INFINITE</a></span></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Waits until the specified mutex is in the signaled state or the time-out interval elapses. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">hMutex</td><td>Mutex </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dwMilliseconds</td><td>The time-out interval, in milliseconds. If a nonzero value is specified, the function waits until the object is signaled or the interval elapses. If dwMilliseconds is zero, the function does not enter a wait state if the object is not signaled; it always returns immediately. If dwMilliseconds is INFINITE, the function will return only when the object is signaled.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a href="https://learn.microsoft.com/en-us/windows/win32/api/synchapi/nf-synchapi-waitforsingleobject">WaitForSingleObject function</a> </dd></dl>
</div>
</div>
<a id="a268ea63b38ec01c65c138f1136df4758" name="a268ea63b38ec01c65c138f1136df4758"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a268ea63b38ec01c65c138f1136df4758">&#9670;&#160;</a></span>~mutex_locker()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">virtual</a> winstd::mutex_locker::~mutex_locker </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases ownership of the mutex object. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://learn.microsoft.com/en-us/windows/win32/api/synchapi/nf-synchapi-releasemutex">ReleaseMutex function</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/WinStd/<a class="el" href="_win_8h_source.html">Win.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 9 2024 21:02:06 for WinStd by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink