diff options
Diffstat (limited to 'classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html')
-rw-r--r-- | classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html | 174 |
1 files changed, 174 insertions, 0 deletions
diff --git a/classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html b/classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html new file mode 100644 index 00000000..afe9c832 --- /dev/null +++ b/classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html @@ -0,0 +1,174 @@ +<!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::lockable_io_handle::extent_guard 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_1lockable__io__handle_1_1extent__guard.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="#pro-methods">Protected Member Functions</a> | +<a href="#friends">Friends</a> | +<a href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">llfio_v2_xxx::lockable_io_handle::extent_guard Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>EXTENSION: RAII holder a locked extent of bytes in a file. + <a href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.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:a243bbb198c4837fba06620578b5a8cdb"><td class="memItemLeft" align="right" valign="top"><a id="a243bbb198c4837fba06620578b5a8cdb"></a> + </td><td class="memItemRight" valign="bottom"><b>extent_guard</b> (const <a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html">extent_guard</a> &)=delete</td></tr> +<tr class="separator:a243bbb198c4837fba06620578b5a8cdb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a11eb347744e5548b52a170cb76a32ce8"><td class="memItemLeft" align="right" valign="top"><a id="a11eb347744e5548b52a170cb76a32ce8"></a> +<a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html">extent_guard</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html">extent_guard</a> &)=delete</td></tr> +<tr class="separator:a11eb347744e5548b52a170cb76a32ce8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a73f10ce38d7c7980db6ddf50d7ed4ac7"><td class="memItemLeft" align="right" valign="top"><a id="a73f10ce38d7c7980db6ddf50d7ed4ac7"></a> +constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html#a73f10ce38d7c7980db6ddf50d7ed4ac7">extent_guard</a> ()</td></tr> +<tr class="memdesc:a73f10ce38d7c7980db6ddf50d7ed4ac7"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr> +<tr class="separator:a73f10ce38d7c7980db6ddf50d7ed4ac7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af48bf68f88261bbf36354d4572d2c69e"><td class="memItemLeft" align="right" valign="top"><a id="af48bf68f88261bbf36354d4572d2c69e"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html#af48bf68f88261bbf36354d4572d2c69e">extent_guard</a> (<a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html">extent_guard</a> &&o) noexcept</td></tr> +<tr class="memdesc:af48bf68f88261bbf36354d4572d2c69e"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr> +<tr class="separator:af48bf68f88261bbf36354d4572d2c69e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a71adc218ded5e0f89461e437de9b52e3"><td class="memItemLeft" align="right" valign="top"><a id="a71adc218ded5e0f89461e437de9b52e3"></a> +<a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html">extent_guard</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html#a71adc218ded5e0f89461e437de9b52e3">operator=</a> (<a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html">extent_guard</a> &&o) noexcept</td></tr> +<tr class="memdesc:a71adc218ded5e0f89461e437de9b52e3"><td class="mdescLeft"> </td><td class="mdescRight">Move assign. <br /></td></tr> +<tr class="separator:a71adc218ded5e0f89461e437de9b52e3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae22ca4d4bb1824c86a2eca46498ab03f"><td class="memItemLeft" align="right" valign="top"><a id="ae22ca4d4bb1824c86a2eca46498ab03f"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html#ae22ca4d4bb1824c86a2eca46498ab03f">operator bool</a> () const noexcept</td></tr> +<tr class="memdesc:ae22ca4d4bb1824c86a2eca46498ab03f"><td class="mdescLeft"> </td><td class="mdescRight">True if extent guard is valid. <br /></td></tr> +<tr class="separator:ae22ca4d4bb1824c86a2eca46498ab03f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1c0a4b841e0f37ffdcb008ad0caa17f4"><td class="memItemLeft" align="right" valign="top"><a id="a1c0a4b841e0f37ffdcb008ad0caa17f4"></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_1lockable__io__handle_1_1extent__guard.html#a1c0a4b841e0f37ffdcb008ad0caa17f4">handle</a> () const noexcept</td></tr> +<tr class="memdesc:a1c0a4b841e0f37ffdcb008ad0caa17f4"><td class="mdescLeft"> </td><td class="mdescRight">The <code>lockable_io_handle</code> to be unlocked. <br /></td></tr> +<tr class="separator:a1c0a4b841e0f37ffdcb008ad0caa17f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a994ce55f3ec1d97d275cce11beccfd04"><td class="memItemLeft" align="right" valign="top"><a id="a994ce55f3ec1d97d275cce11beccfd04"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html#a994ce55f3ec1d97d275cce11beccfd04">set_handle</a> (<a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle.html">lockable_io_handle</a> *h) noexcept</td></tr> +<tr class="memdesc:a994ce55f3ec1d97d275cce11beccfd04"><td class="mdescLeft"> </td><td class="mdescRight">Sets the <code>lockable_io_handle</code> to be unlocked. <br /></td></tr> +<tr class="separator:a994ce55f3ec1d97d275cce11beccfd04"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4402da52891bbf8ada0bb7a2efc4f51e"><td class="memItemLeft" align="right" valign="top"><a id="a4402da52891bbf8ada0bb7a2efc4f51e"></a> +std::tuple< <a class="el" href="classllfio__v2__xxx_1_1handle.html#a4ee58f1b6a24af5e64d850d1e3eed07f">extent_type</a>, <a class="el" href="classllfio__v2__xxx_1_1handle.html#a4ee58f1b6a24af5e64d850d1e3eed07f">extent_type</a>, <a class="el" href="namespacellfio__v2__xxx.html#ae79486289ff1386b26d1ce60bb797d33">lock_kind</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html#a4402da52891bbf8ada0bb7a2efc4f51e">extent</a> () const noexcept</td></tr> +<tr class="memdesc:a4402da52891bbf8ada0bb7a2efc4f51e"><td class="mdescLeft"> </td><td class="mdescRight">The extent to be unlocked. <br /></td></tr> +<tr class="separator:a4402da52891bbf8ada0bb7a2efc4f51e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aeac893321a6eb8f191259b51e1a9a7eb"><td class="memItemLeft" align="right" valign="top"><a id="aeac893321a6eb8f191259b51e1a9a7eb"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html#aeac893321a6eb8f191259b51e1a9a7eb">unlock</a> () noexcept</td></tr> +<tr class="memdesc:aeac893321a6eb8f191259b51e1a9a7eb"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the locked extent immediately. <br /></td></tr> +<tr class="separator:aeac893321a6eb8f191259b51e1a9a7eb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab0d4a9c50de6b8da12bb5f5b9aebb981"><td class="memItemLeft" align="right" valign="top"><a id="ab0d4a9c50de6b8da12bb5f5b9aebb981"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html#ab0d4a9c50de6b8da12bb5f5b9aebb981">release</a> () noexcept</td></tr> +<tr class="memdesc:ab0d4a9c50de6b8da12bb5f5b9aebb981"><td class="mdescLeft"> </td><td class="mdescRight">Detach this RAII unlocker from the locked state. <br /></td></tr> +<tr class="separator:ab0d4a9c50de6b8da12bb5f5b9aebb981"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> +Protected Member Functions</h2></td></tr> +<tr class="memitem:a835d207be335fb4f449d1b68d8c0260a"><td class="memItemLeft" align="right" valign="top"><a id="a835d207be335fb4f449d1b68d8c0260a"></a> +constexpr </td><td class="memItemRight" valign="bottom"><b>extent_guard</b> (<a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle.html">lockable_io_handle</a> *h, <a class="el" href="classllfio__v2__xxx_1_1handle.html#a4ee58f1b6a24af5e64d850d1e3eed07f">extent_type</a> offset, <a class="el" href="classllfio__v2__xxx_1_1handle.html#a4ee58f1b6a24af5e64d850d1e3eed07f">extent_type</a> <a class="el" href="namespacellfio__v2__xxx.html#aa3676f0dd69f4b54cf7e14e3f86d32b9">length</a>, <a class="el" href="namespacellfio__v2__xxx.html#ae79486289ff1386b26d1ce60bb797d33">lock_kind</a> kind)</td></tr> +<tr class="separator:a835d207be335fb4f449d1b68d8c0260a"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> +Friends</h2></td></tr> +<tr class="memitem:adf16f67f49931b3442ad14f65e3625a5"><td class="memItemLeft" align="right" valign="top"><a id="adf16f67f49931b3442ad14f65e3625a5"></a> +class </td><td class="memItemRight" valign="bottom"><b>lockable_io_handle</b></td></tr> +<tr class="separator:adf16f67f49931b3442ad14f65e3625a5"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>EXTENSION: RAII holder a locked extent of bytes in a file. </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_1lockable__io__handle.html">lockable_io_handle</a></li><li class="navelem"><a class="el" href="classllfio__v2__xxx_1_1lockable__io__handle_1_1extent__guard.html">extent_guard</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> |