diff options
author | Jenkins nedprod CI <foo@nowhere> | 2019-11-18 14:36:37 +0300 |
---|---|---|
committer | Jenkins nedprod CI <foo@nowhere> | 2019-11-18 14:36:37 +0300 |
commit | 8c45d7272c429a2c1992cced73ce3356fd7520b9 (patch) | |
tree | 0e57763c3a8073969bfa98a3b8156fa8320b044b /classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html | |
parent | 480204f2653c2468b40f5048fe8b8db74847d047 (diff) |
Travis CI updates documentation
Diffstat (limited to 'classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html')
-rw-r--r-- | classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html | 172 |
1 files changed, 172 insertions, 0 deletions
diff --git a/classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html b/classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html new file mode 100644 index 00000000..a9e5ebc1 --- /dev/null +++ b/classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html @@ -0,0 +1,172 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>LLFIO: llfio_v2_xxx::file_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> +<script type="text/javascript"> + $(document).ready(initResizable); +</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 alpha</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</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"> +$(document).ready(function(){initNavTree('classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html','');}); +</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_1file__handle_1_1extent__guard-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">llfio_v2_xxx::file_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_1file__handle_1_1extent__guard.html#details">More...</a></p> + +<p><code>#include "file_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:a18694fe27c43df1083145cfb6d90bab7"><td class="memItemLeft" align="right" valign="top"><a id="a18694fe27c43df1083145cfb6d90bab7"></a> + </td><td class="memItemRight" valign="bottom"><b>extent_guard</b> (const <a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html">extent_guard</a> &)=delete</td></tr> +<tr class="separator:a18694fe27c43df1083145cfb6d90bab7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0b65170080b655042f5bf7ff69e378cf"><td class="memItemLeft" align="right" valign="top"><a id="a0b65170080b655042f5bf7ff69e378cf"></a> +<a class="el" href="classllfio__v2__xxx_1_1file__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_1file__handle_1_1extent__guard.html">extent_guard</a> &)=delete</td></tr> +<tr class="separator:a0b65170080b655042f5bf7ff69e378cf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adefa54a7016ff90df967f04b665bf16d"><td class="memItemLeft" align="right" valign="top"><a id="adefa54a7016ff90df967f04b665bf16d"></a> +constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html#adefa54a7016ff90df967f04b665bf16d">extent_guard</a> ()</td></tr> +<tr class="memdesc:adefa54a7016ff90df967f04b665bf16d"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr> +<tr class="separator:adefa54a7016ff90df967f04b665bf16d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aee5f29089f79e2fcec275168650b35f4"><td class="memItemLeft" align="right" valign="top"><a id="aee5f29089f79e2fcec275168650b35f4"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html#aee5f29089f79e2fcec275168650b35f4">extent_guard</a> (<a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html">extent_guard</a> &&o) noexcept</td></tr> +<tr class="memdesc:aee5f29089f79e2fcec275168650b35f4"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr> +<tr class="separator:aee5f29089f79e2fcec275168650b35f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a55acba6917b8ad067c55c6008b1b2422"><td class="memItemLeft" align="right" valign="top"><a id="a55acba6917b8ad067c55c6008b1b2422"></a> +<a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html">extent_guard</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html#a55acba6917b8ad067c55c6008b1b2422">operator=</a> (<a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html">extent_guard</a> &&o) noexcept</td></tr> +<tr class="memdesc:a55acba6917b8ad067c55c6008b1b2422"><td class="mdescLeft"> </td><td class="mdescRight">Move assign. <br /></td></tr> +<tr class="separator:a55acba6917b8ad067c55c6008b1b2422"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a542975791603454af85f9877a32f6ee9"><td class="memItemLeft" align="right" valign="top"><a id="a542975791603454af85f9877a32f6ee9"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html#a542975791603454af85f9877a32f6ee9">operator bool</a> () const noexcept</td></tr> +<tr class="memdesc:a542975791603454af85f9877a32f6ee9"><td class="mdescLeft"> </td><td class="mdescRight">True if extent guard is valid. <br /></td></tr> +<tr class="separator:a542975791603454af85f9877a32f6ee9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaf9625db67bae417deb305824c99add3"><td class="memItemLeft" align="right" valign="top"><a id="aaf9625db67bae417deb305824c99add3"></a> +<a class="el" href="classllfio__v2__xxx_1_1file__handle.html">file_handle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html#aaf9625db67bae417deb305824c99add3">handle</a> () const noexcept</td></tr> +<tr class="memdesc:aaf9625db67bae417deb305824c99add3"><td class="mdescLeft"> </td><td class="mdescRight">The <code>file_handle</code> to be unlocked. <br /></td></tr> +<tr class="separator:aaf9625db67bae417deb305824c99add3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a911d0cf556b0d234a33235f84c85dfc2"><td class="memItemLeft" align="right" valign="top"><a id="a911d0cf556b0d234a33235f84c85dfc2"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html#a911d0cf556b0d234a33235f84c85dfc2">set_handle</a> (<a class="el" href="classllfio__v2__xxx_1_1file__handle.html">file_handle</a> *h) noexcept</td></tr> +<tr class="memdesc:a911d0cf556b0d234a33235f84c85dfc2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the <code>file_handle</code> to be unlocked. <br /></td></tr> +<tr class="separator:a911d0cf556b0d234a33235f84c85dfc2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6d28de635fdfadeb275524cab262ebab"><td class="memItemLeft" align="right" valign="top"><a id="a6d28de635fdfadeb275524cab262ebab"></a> +std::tuple< extent_type, extent_type, <a class="el" href="classllfio__v2__xxx_1_1file__handle.html#aa25e3ab298152166fc387d8fcfb19a63">lock_kind</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html#a6d28de635fdfadeb275524cab262ebab">extent</a> () const noexcept</td></tr> +<tr class="memdesc:a6d28de635fdfadeb275524cab262ebab"><td class="mdescLeft"> </td><td class="mdescRight">The extent to be unlocked. <br /></td></tr> +<tr class="separator:a6d28de635fdfadeb275524cab262ebab"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad6d6b683aeebc6d6da7880073507935c"><td class="memItemLeft" align="right" valign="top"><a id="ad6d6b683aeebc6d6da7880073507935c"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html#ad6d6b683aeebc6d6da7880073507935c">unlock</a> () noexcept</td></tr> +<tr class="memdesc:ad6d6b683aeebc6d6da7880073507935c"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the locked extent immediately. <br /></td></tr> +<tr class="separator:ad6d6b683aeebc6d6da7880073507935c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5258babf2495492f55a1a72f5564bae2"><td class="memItemLeft" align="right" valign="top"><a id="a5258babf2495492f55a1a72f5564bae2"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1file__handle_1_1extent__guard.html#a5258babf2495492f55a1a72f5564bae2">release</a> () noexcept</td></tr> +<tr class="memdesc:a5258babf2495492f55a1a72f5564bae2"><td class="mdescLeft"> </td><td class="mdescRight">Detach this RAII unlocker from the locked state. <br /></td></tr> +<tr class="separator:a5258babf2495492f55a1a72f5564bae2"><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:a8f7fedeaae0a414a3ab84c3b4ad5b45b"><td class="memItemLeft" align="right" valign="top"><a id="a8f7fedeaae0a414a3ab84c3b4ad5b45b"></a> +constexpr </td><td class="memItemRight" valign="bottom"><b>extent_guard</b> (<a class="el" href="classllfio__v2__xxx_1_1file__handle.html">file_handle</a> *h, extent_type offset, extent_type <a class="el" href="namespacellfio__v2__xxx.html#aa3676f0dd69f4b54cf7e14e3f86d32b9">length</a>, <a class="el" href="classllfio__v2__xxx_1_1file__handle.html#aa25e3ab298152166fc387d8fcfb19a63">lock_kind</a> kind)</td></tr> +<tr class="separator:a8f7fedeaae0a414a3ab84c3b4ad5b45b"><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:af04ab947e00adb1d01726aa376c42cf1"><td class="memItemLeft" align="right" valign="top"><a id="af04ab947e00adb1d01726aa376c42cf1"></a> +class </td><td class="memItemRight" valign="bottom"><b>file_handle</b></td></tr> +<tr class="separator:af04ab947e00adb1d01726aa376c42cf1"><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="file__handle_8hpp.html">file_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_1file__handle.html">file_handle</a></li><li class="navelem"><a class="el" href="classllfio__v2__xxx_1_1file__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.13 </li> + </ul> +</div> +</body> +</html> |