diff options
Diffstat (limited to 'classllfio__v2__xxx_1_1unique__file__lock.html')
| -rw-r--r-- | classllfio__v2__xxx_1_1unique__file__lock.html | 173 |
1 files changed, 173 insertions, 0 deletions
diff --git a/classllfio__v2__xxx_1_1unique__file__lock.html b/classllfio__v2__xxx_1_1unique__file__lock.html new file mode 100644 index 00000000..d57a2966 --- /dev/null +++ b/classllfio__v2__xxx_1_1unique__file__lock.html @@ -0,0 +1,173 @@ +<!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"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.17"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>LLFIO: llfio_v2_xxx::unique_file_lock 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> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.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 style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">LLFIO +  <span id="projectnumber">v2.00 late beta</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.17 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('classllfio__v2__xxx_1_1unique__file__lock.html',''); initResizable(); }); +/* @license-end */ +</script> +<div id="doc-content"> +<!-- 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"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classllfio__v2__xxx_1_1unique__file__lock-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">llfio_v2_xxx::unique_file_lock Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>RAII locker matching <code>std::unique_lock</code> for <code>lockable_io_handle</code>, but untemplated. + <a href="classllfio__v2__xxx_1_1unique__file__lock.html#details">More...</a></p> + +<p><code>#include "lockable_io_handle.hpp"</code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a4811cd80ae69eb2d72415bb02447a90d"><td class="memItemLeft" align="right" valign="top"><a id="a4811cd80ae69eb2d72415bb02447a90d"></a> + </td><td class="memItemRight" valign="bottom"><b>unique_file_lock</b> (<a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle.html">lockable_io_handle</a> &h, <a class="el" href="namespacellfio__v2__xxx.html#ae79486289ff1386b26d1ce60bb797d33">lock_kind</a> kind)</td></tr> +<tr class="separator:a4811cd80ae69eb2d72415bb02447a90d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a26d6f6539cc116675e40fe8aa4aedf6f"><td class="memItemLeft" align="right" valign="top"><a id="a26d6f6539cc116675e40fe8aa4aedf6f"></a> + </td><td class="memItemRight" valign="bottom"><b>unique_file_lock</b> (<a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html">unique_file_lock</a> &&o) noexcept</td></tr> +<tr class="separator:a26d6f6539cc116675e40fe8aa4aedf6f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af4cb3edf03da4755ac62086708d8d360"><td class="memItemLeft" align="right" valign="top"><a id="af4cb3edf03da4755ac62086708d8d360"></a> + </td><td class="memItemRight" valign="bottom"><b>unique_file_lock</b> (const <a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html">unique_file_lock</a> &)=delete</td></tr> +<tr class="separator:af4cb3edf03da4755ac62086708d8d360"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ace176060fd88ebd3ef26427d187855b8"><td class="memItemLeft" align="right" valign="top"><a id="ace176060fd88ebd3ef26427d187855b8"></a> +<a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html">unique_file_lock</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html">unique_file_lock</a> &&o) noexcept</td></tr> +<tr class="separator:ace176060fd88ebd3ef26427d187855b8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acbe0708675bc8e1020edaebac8ce88af"><td class="memItemLeft" align="right" valign="top"><a id="acbe0708675bc8e1020edaebac8ce88af"></a> +<a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html">unique_file_lock</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html">unique_file_lock</a> &)=delete</td></tr> +<tr class="separator:acbe0708675bc8e1020edaebac8ce88af"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac66e90389ea1568453ca7df71db96f16"><td class="memItemLeft" align="right" valign="top"><a id="ac66e90389ea1568453ca7df71db96f16"></a> +<a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle.html">lockable_io_handle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html#ac66e90389ea1568453ca7df71db96f16">mutex</a> () const noexcept</td></tr> +<tr class="memdesc:ac66e90389ea1568453ca7df71db96f16"><td class="mdescLeft"> </td><td class="mdescRight">Returns the associated mutex. <br /></td></tr> +<tr class="separator:ac66e90389ea1568453ca7df71db96f16"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab633b6cfaa5122af1ac74da719d6b106"><td class="memItemLeft" align="right" valign="top"><a id="ab633b6cfaa5122af1ac74da719d6b106"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html#ab633b6cfaa5122af1ac74da719d6b106">owns_lock</a> () const noexcept</td></tr> +<tr class="memdesc:ab633b6cfaa5122af1ac74da719d6b106"><td class="mdescLeft"> </td><td class="mdescRight">True if the associated mutex is owned by this lock. <br /></td></tr> +<tr class="separator:ab633b6cfaa5122af1ac74da719d6b106"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acfb1ff9fa6f5e5559516411654bbd60b"><td class="memItemLeft" align="right" valign="top"><a id="acfb1ff9fa6f5e5559516411654bbd60b"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html#acfb1ff9fa6f5e5559516411654bbd60b">operator bool</a> () const noexcept</td></tr> +<tr class="memdesc:acfb1ff9fa6f5e5559516411654bbd60b"><td class="mdescLeft"> </td><td class="mdescRight">True if the associated mutex is owned by this lock. <br /></td></tr> +<tr class="separator:acfb1ff9fa6f5e5559516411654bbd60b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a28cfecd8e9bae73c721f0e932be4acc1"><td class="memItemLeft" align="right" valign="top"><a id="a28cfecd8e9bae73c721f0e932be4acc1"></a> +<a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle.html">lockable_io_handle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html#a28cfecd8e9bae73c721f0e932be4acc1">release</a> () noexcept</td></tr> +<tr class="memdesc:a28cfecd8e9bae73c721f0e932be4acc1"><td class="mdescLeft"> </td><td class="mdescRight">Releases the mutex from management. <br /></td></tr> +<tr class="separator:a28cfecd8e9bae73c721f0e932be4acc1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0992bf3f3a85f0bc6355a743d37873e0"><td class="memItemLeft" align="right" valign="top"><a id="a0992bf3f3a85f0bc6355a743d37873e0"></a> +result< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html#a0992bf3f3a85f0bc6355a743d37873e0">lock</a> () noexcept</td></tr> +<tr class="memdesc:a0992bf3f3a85f0bc6355a743d37873e0"><td class="mdescLeft"> </td><td class="mdescRight">Lock the mutex for exclusive access. <br /></td></tr> +<tr class="separator:a0992bf3f3a85f0bc6355a743d37873e0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abf94a041e73bf0384d5dbfded6c85948"><td class="memItemLeft" align="right" valign="top"><a id="abf94a041e73bf0384d5dbfded6c85948"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html#abf94a041e73bf0384d5dbfded6c85948">try_lock</a> () noexcept</td></tr> +<tr class="memdesc:abf94a041e73bf0384d5dbfded6c85948"><td class="mdescLeft"> </td><td class="mdescRight">Try to lock the mutex for exclusive access. <br /></td></tr> +<tr class="separator:abf94a041e73bf0384d5dbfded6c85948"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae8af367ca1475f4a3c415fd7fff18694"><td class="memItemLeft" align="right" valign="top"><a id="ae8af367ca1475f4a3c415fd7fff18694"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html#ae8af367ca1475f4a3c415fd7fff18694">unlock</a> () noexcept</td></tr> +<tr class="memdesc:ae8af367ca1475f4a3c415fd7fff18694"><td class="mdescLeft"> </td><td class="mdescRight">Unlock the mutex from exclusive access. <br /></td></tr> +<tr class="separator:ae8af367ca1475f4a3c415fd7fff18694"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a07466cdd59da24bb249cbf46781eb9bb"><td class="memItemLeft" align="right" valign="top"><a id="a07466cdd59da24bb249cbf46781eb9bb"></a> +result< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html#a07466cdd59da24bb249cbf46781eb9bb">lock_shared</a> () noexcept</td></tr> +<tr class="memdesc:a07466cdd59da24bb249cbf46781eb9bb"><td class="mdescLeft"> </td><td class="mdescRight">Lock the mutex for shared access. <br /></td></tr> +<tr class="separator:a07466cdd59da24bb249cbf46781eb9bb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa1ab80cdfbb9bdb4e64ec8b61e4d3a83"><td class="memItemLeft" align="right" valign="top"><a id="aa1ab80cdfbb9bdb4e64ec8b61e4d3a83"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html#aa1ab80cdfbb9bdb4e64ec8b61e4d3a83">try_lock_shared</a> () noexcept</td></tr> +<tr class="memdesc:aa1ab80cdfbb9bdb4e64ec8b61e4d3a83"><td class="mdescLeft"> </td><td class="mdescRight">Try to lock the mutex for shared access. <br /></td></tr> +<tr class="separator:aa1ab80cdfbb9bdb4e64ec8b61e4d3a83"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a97a893fe4a3b5356ef26b6b9b80fdce2"><td class="memItemLeft" align="right" valign="top"><a id="a97a893fe4a3b5356ef26b6b9b80fdce2"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html#a97a893fe4a3b5356ef26b6b9b80fdce2">unlock_shared</a> () noexcept</td></tr> +<tr class="memdesc:a97a893fe4a3b5356ef26b6b9b80fdce2"><td class="mdescLeft"> </td><td class="mdescRight">Unlock the mutex from shared access. <br /></td></tr> +<tr class="separator:a97a893fe4a3b5356ef26b6b9b80fdce2"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>RAII locker matching <code>std::unique_lock</code> for <code>lockable_io_handle</code>, but untemplated. </p> +</div><hr/>The documentation for this class was generated from the following file:<ul> +<li>include/llfio/v2.0/<a class="el" href="lockable__io__handle_8hpp.html">lockable_io_handle.hpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespacellfio__v2__xxx.html">llfio_v2_xxx</a></li><li class="navelem"><a class="el" href="classllfio__v2__xxx_1_1unique__file__lock.html">unique_file_lock</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> + </ul> +</div> +</body> +</html> |