diff options
Diffstat (limited to 'classboost_1_1afio_1_1v2__xxx_1_1handle.html')
-rw-r--r-- | classboost_1_1afio_1_1v2__xxx_1_1handle.html | 523 |
1 files changed, 523 insertions, 0 deletions
diff --git a/classboost_1_1afio_1_1v2__xxx_1_1handle.html b/classboost_1_1afio_1_1v2__xxx_1_1handle.html new file mode 100644 index 00000000..ba1d08c1 --- /dev/null +++ b/classboost_1_1afio_1_1v2__xxx_1_1handle.html @@ -0,0 +1,523 @@ +<!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.3.1"/> +<title>Boost.AFIO: boost::afio::v2_xxx::handle 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="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 style="padding-left: 0.5em;"> + <div id="projectname">Boost.AFIO +  <span id="projectnumber">v2.00 early alpha</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.3.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </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('classboost_1_1afio_1_1v2__xxx_1_1handle.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)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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="#nested-classes">Classes</a> | +<a href="#pub-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="#friends">Friends</a> | +<a href="classboost_1_1afio_1_1v2__xxx_1_1handle-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">boost::afio::v2_xxx::handle Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>A <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1native__handle__type.html" title="A native handle type used for wrapping file descriptors, process ids or HANDLEs. Unmanaged, wrap in a handle object to manage.">native_handle_type</a> which is managed by the lifetime of this object instance. + <a href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="handle_8hpp_source.html">handle.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for boost::afio::v2_xxx::handle:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classboost_1_1afio_1_1v2__xxx_1_1handle.png" usemap="#boost::afio::v2_xxx::handle_map" alt=""/> + <map id="boost::afio::v2_xxx::handle_map" name="boost::afio::v2_xxx::handle_map"> +<area href="classboost_1_1afio_1_1v2__xxx_1_1io__handle.html" title="A handle to something capable of scatter-gather i/o." alt="boost::afio::v2_xxx::io_handle" shape="rect" coords="0,56,223,80"/> +<area href="classboost_1_1afio_1_1v2__xxx_1_1file__handle.html" title="A handle to a regular file or device, kept data layout compatible with async_file_handle." alt="boost::afio::v2_xxx::file_handle" shape="rect" coords="0,112,223,136"/> +<area href="classboost_1_1afio_1_1v2__xxx_1_1async__file__handle.html" title="A handle to an open something." alt="boost::afio::v2_xxx::async_file_handle" shape="rect" coords="0,168,223,192"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1handle_1_1flag__base.html">flag_base</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Bitwise flags which can be specified. <a href="structboost_1_1afio_1_1v2__xxx_1_1handle_1_1flag__base.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1handle_1_1really__copy.html">really_copy</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Tag type to enable copy constructor. <a href="structboost_1_1afio_1_1v2__xxx_1_1handle_1_1really__copy.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:acd7f0c039e94c7ad40937fe32a2cabad"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabad">mode</a> : unsigned char { <br/> +  <b>unchanged</b> = 0, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabada334c4a4c42fdb79d7ebc3e73b517e6f8">none</a> = 2, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabadaa4daf6d1e8da35af49c33bbe9ee91d79">attr_read</a> = 4, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabada9f56aff64cb748e078ab221474132d19">attr_write</a> = 5, +<br/> +  <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabadaecae13117d6f0584c25a9da6c8f8415e">read</a> = 6, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabadaefb2a684e4afb7d55e6147fbe5a332ee">write</a> = 7, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabada9516dfb15f51c7ee19a4d46b8c0dbe1d">append</a> = 9 +<br/> + }</td></tr> +<tr class="memdesc:acd7f0c039e94c7ad40937fe32a2cabad"><td class="mdescLeft"> </td><td class="mdescRight">The behaviour of the handle: does it read, read and write, or atomic append? <a href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabad">More...</a><br/></td></tr> +<tr class="separator:acd7f0c039e94c7ad40937fe32a2cabad"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab7acaf4e9155f8ad4023813354de5357"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#ab7acaf4e9155f8ad4023813354de5357">creation</a> : unsigned char { <b>open_existing</b> = 0, +<b>only_if_not_exist</b>, +<b>if_needed</b>, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#ab7acaf4e9155f8ad4023813354de5357a244f58cf07c35fd48d7524b289551e5c">truncate</a> + }</td></tr> +<tr class="memdesc:ab7acaf4e9155f8ad4023813354de5357"><td class="mdescLeft"> </td><td class="mdescRight">On opening, do we also create a new file or truncate an existing one? <a href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#ab7acaf4e9155f8ad4023813354de5357">More...</a><br/></td></tr> +<tr class="separator:ab7acaf4e9155f8ad4023813354de5357"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a81c7de194feaa88684ca9851d0d527ca"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527ca">caching</a> : unsigned char { <br/> +  <b>unchanged</b> = 0, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caa334c4a4c42fdb79d7ebc3e73b517e6f8">none</a> = 1, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caab8a61dd00ce6fc5888706bda8fab2e98">only_metadata</a> = 2, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caa0fb9cf5f04f61bb6f1151da57ceb1ca1">reads</a> = 3, +<br/> +  <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caadec4ecca8ae1593f84eea4656599a693">reads_and_metadata</a> = 5, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caaa181a603769c1f98ad927e7367c7aa51">all</a> = 4, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caadfa4d35596e04e042a53c64b25c22db3">safety_fsyncs</a> = 7, +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caad5197d93c063a2b1e22d1630a39b7aef">temporary</a> = 6 +<br/> + }</td></tr> +<tr class="memdesc:a81c7de194feaa88684ca9851d0d527ca"><td class="mdescLeft"> </td><td class="mdescRight">What i/o on the handle will complete immediately due to kernel caching. <a href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527ca">More...</a><br/></td></tr> +<tr class="separator:a81c7de194feaa88684ca9851d0d527ca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa28b35a32f1292b6126a82bba20a2c90"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa28b35a32f1292b6126a82bba20a2c90"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#aa28b35a32f1292b6126a82bba20a2c90">path_type</a> = fixme_path</td></tr> +<tr class="memdesc:aa28b35a32f1292b6126a82bba20a2c90"><td class="mdescLeft"> </td><td class="mdescRight">The path type used by this handle. <br/></td></tr> +<tr class="separator:aa28b35a32f1292b6126a82bba20a2c90"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a617ab627aa596b325d7bfef5210a43f3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a617ab627aa596b325d7bfef5210a43f3"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a617ab627aa596b325d7bfef5210a43f3">extent_type</a> = unsigned long long</td></tr> +<tr class="memdesc:a617ab627aa596b325d7bfef5210a43f3"><td class="mdescLeft"> </td><td class="mdescRight">The file extent type used by this handle. <br/></td></tr> +<tr class="separator:a617ab627aa596b325d7bfef5210a43f3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aee8d98d7f979e312f5e18dfcebfc6870"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee8d98d7f979e312f5e18dfcebfc6870"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#aee8d98d7f979e312f5e18dfcebfc6870">size_type</a> = size_t</td></tr> +<tr class="memdesc:aee8d98d7f979e312f5e18dfcebfc6870"><td class="mdescLeft"> </td><td class="mdescRight">The memory extent type used by this handle. <br/></td></tr> +<tr class="separator:aee8d98d7f979e312f5e18dfcebfc6870"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab37b26dc8780f56324c52cb26e002d8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab37b26dc8780f56324c52cb26e002d8e"></a> +using </td><td class="memItemRight" valign="bottom"><b>flag</b> = <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1bitfield.html">bitfield</a>< <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1handle_1_1flag__base.html">flag_base</a> ></td></tr> +<tr class="separator:ab37b26dc8780f56324c52cb26e002d8e"><td class="memSeparator" colspan="2"> </td></tr> +</table><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:aa845780704a8508c658c2b878f574ba7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa845780704a8508c658c2b878f574ba7"></a> +constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#aa845780704a8508c658c2b878f574ba7">handle</a> ()</td></tr> +<tr class="memdesc:aa845780704a8508c658c2b878f574ba7"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr> +<tr class="separator:aa845780704a8508c658c2b878f574ba7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afeb3459e9b79236dbd664a816cd94079"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afeb3459e9b79236dbd664a816cd94079"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#afeb3459e9b79236dbd664a816cd94079">handle</a> (<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1native__handle__type.html">native_handle_type</a> h, <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527ca">caching</a> <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527ca">caching</a>=caching::none, <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1bitfield.html">flag</a> <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#add27fa17cd6356b49a26a8b6dafb6a6d">flags</a>=flag::none)</td></tr> +<tr class="memdesc:afeb3459e9b79236dbd664a816cd94079"><td class="mdescLeft"> </td><td class="mdescRight">Construct a handle from a supplied native handle. <br/></td></tr> +<tr class="separator:afeb3459e9b79236dbd664a816cd94079"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0dbf908498e5cbf54ee0fff752c0c490"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0dbf908498e5cbf54ee0fff752c0c490"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a0dbf908498e5cbf54ee0fff752c0c490">handle</a> (<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html">handle</a> &&o) noexcept</td></tr> +<tr class="memdesc:a0dbf908498e5cbf54ee0fff752c0c490"><td class="mdescLeft"> </td><td class="mdescRight">Move the handle. Explicit because this will lose information in any derived source. <br/></td></tr> +<tr class="separator:a0dbf908498e5cbf54ee0fff752c0c490"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2c20412387db2551d9b26824412d4986"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c20412387db2551d9b26824412d4986"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a2c20412387db2551d9b26824412d4986">handle</a> (const <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html">handle</a> &o, <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1handle_1_1really__copy.html">really_copy</a>)</td></tr> +<tr class="memdesc:a2c20412387db2551d9b26824412d4986"><td class="mdescLeft"> </td><td class="mdescRight">Copy the handle. Tag enabled because copying handles is expensive (fd duplication). <br/></td></tr> +<tr class="separator:a2c20412387db2551d9b26824412d4986"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aae278681887f4cb68b0b57c5ef6c8d4e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae278681887f4cb68b0b57c5ef6c8d4e"></a> +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html">handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#aae278681887f4cb68b0b57c5ef6c8d4e">operator=</a> (<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html">handle</a> &&o)=delete</td></tr> +<tr class="memdesc:aae278681887f4cb68b0b57c5ef6c8d4e"><td class="mdescLeft"> </td><td class="mdescRight">No move assignment. <br/></td></tr> +<tr class="separator:aae278681887f4cb68b0b57c5ef6c8d4e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acda0caaacf4404bffc57508930ba52be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acda0caaacf4404bffc57508930ba52be"></a> +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html">handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acda0caaacf4404bffc57508930ba52be">operator=</a> (const <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html">handle</a> &o)=delete</td></tr> +<tr class="memdesc:acda0caaacf4404bffc57508930ba52be"><td class="mdescLeft"> </td><td class="mdescRight">No copy assignment. <br/></td></tr> +<tr class="separator:acda0caaacf4404bffc57508930ba52be"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a461355ae526806b338fd2eaadc564a43"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a461355ae526806b338fd2eaadc564a43"></a> +virtual <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#aa28b35a32f1292b6126a82bba20a2c90">path_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a461355ae526806b338fd2eaadc564a43">path</a> () const noexcept</td></tr> +<tr class="memdesc:a461355ae526806b338fd2eaadc564a43"><td class="mdescLeft"> </td><td class="mdescRight">The path this handle refers to, if any. <br/></td></tr> +<tr class="separator:a461355ae526806b338fd2eaadc564a43"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a651ff10099e7522df784507aca8b8f0f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a651ff10099e7522df784507aca8b8f0f"></a> +virtual <a class="el" href="namespaceboost_1_1afio_1_1v2__xxx.html#ac8d06ecaa9660e7251c1251d88c1305c">result</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a651ff10099e7522df784507aca8b8f0f">close</a> () noexcept</td></tr> +<tr class="memdesc:a651ff10099e7522df784507aca8b8f0f"><td class="mdescLeft"> </td><td class="mdescRight">Immediately close the native handle type managed by this handle. <br/></td></tr> +<tr class="separator:a651ff10099e7522df784507aca8b8f0f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a59c9bc1338196095a028b2870dcfb61d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59c9bc1338196095a028b2870dcfb61d"></a> +virtual <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1native__handle__type.html">native_handle_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a59c9bc1338196095a028b2870dcfb61d">release</a> () noexcept</td></tr> +<tr class="memdesc:a59c9bc1338196095a028b2870dcfb61d"><td class="mdescLeft"> </td><td class="mdescRight">Release the native handle type managed by this handle. <br/></td></tr> +<tr class="separator:a59c9bc1338196095a028b2870dcfb61d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af2d9387a79e320e2902880fee38b392a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2d9387a79e320e2902880fee38b392a"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#af2d9387a79e320e2902880fee38b392a">is_readable</a> () const noexcept</td></tr> +<tr class="memdesc:af2d9387a79e320e2902880fee38b392a"><td class="mdescLeft"> </td><td class="mdescRight">True if the handle is readable. <br/></td></tr> +<tr class="separator:af2d9387a79e320e2902880fee38b392a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac847865f7370c00ca1e7d0b2ac8ee4e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac847865f7370c00ca1e7d0b2ac8ee4e7"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#ac847865f7370c00ca1e7d0b2ac8ee4e7">is_writable</a> () const noexcept</td></tr> +<tr class="memdesc:ac847865f7370c00ca1e7d0b2ac8ee4e7"><td class="mdescLeft"> </td><td class="mdescRight">True if the handle is writable. <br/></td></tr> +<tr class="separator:ac847865f7370c00ca1e7d0b2ac8ee4e7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abef3375ff35a72bd780cbee0b600b26d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abef3375ff35a72bd780cbee0b600b26d"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#abef3375ff35a72bd780cbee0b600b26d">is_append_only</a> () const noexcept</td></tr> +<tr class="memdesc:abef3375ff35a72bd780cbee0b600b26d"><td class="mdescLeft"> </td><td class="mdescRight">True if the handle is append only. <br/></td></tr> +<tr class="separator:abef3375ff35a72bd780cbee0b600b26d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adf964e787e0666fc5b7d94c2715ee6f5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceboost_1_1afio_1_1v2__xxx.html#ac8d06ecaa9660e7251c1251d88c1305c">result</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#adf964e787e0666fc5b7d94c2715ee6f5">set_append_only</a> (bool enable) noexcept</td></tr> +<tr class="separator:adf964e787e0666fc5b7d94c2715ee6f5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8d4b2f3b095a80e651c18143246ee4e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d4b2f3b095a80e651c18143246ee4e9"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a8d4b2f3b095a80e651c18143246ee4e9">is_overlapped</a> () const noexcept</td></tr> +<tr class="memdesc:a8d4b2f3b095a80e651c18143246ee4e9"><td class="mdescLeft"> </td><td class="mdescRight">True if overlapped. <br/></td></tr> +<tr class="separator:a8d4b2f3b095a80e651c18143246ee4e9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3c14ec910a3eac02b44688807c9b7511"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c14ec910a3eac02b44688807c9b7511"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a3c14ec910a3eac02b44688807c9b7511">is_seekable</a> () const noexcept</td></tr> +<tr class="memdesc:a3c14ec910a3eac02b44688807c9b7511"><td class="mdescLeft"> </td><td class="mdescRight">True if seekable. <br/></td></tr> +<tr class="separator:a3c14ec910a3eac02b44688807c9b7511"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7d1fa70986dc1edea222e17fbabc6425"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d1fa70986dc1edea222e17fbabc6425"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a7d1fa70986dc1edea222e17fbabc6425">requires_aligned_io</a> () const noexcept</td></tr> +<tr class="memdesc:a7d1fa70986dc1edea222e17fbabc6425"><td class="mdescLeft"> </td><td class="mdescRight">True if requires aligned i/o. <br/></td></tr> +<tr class="separator:a7d1fa70986dc1edea222e17fbabc6425"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a81b36f2dcb205e049f3c3781c7973b6e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81b36f2dcb205e049f3c3781c7973b6e"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81b36f2dcb205e049f3c3781c7973b6e">is_regular</a> () const noexcept</td></tr> +<tr class="memdesc:a81b36f2dcb205e049f3c3781c7973b6e"><td class="mdescLeft"> </td><td class="mdescRight">True if a regular file or device. <br/></td></tr> +<tr class="separator:a81b36f2dcb205e049f3c3781c7973b6e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a75d78e5591cafbc68e8ba4e2b2deffa9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75d78e5591cafbc68e8ba4e2b2deffa9"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a75d78e5591cafbc68e8ba4e2b2deffa9">is_directory</a> () const noexcept</td></tr> +<tr class="memdesc:a75d78e5591cafbc68e8ba4e2b2deffa9"><td class="mdescLeft"> </td><td class="mdescRight">True if a directory. <br/></td></tr> +<tr class="separator:a75d78e5591cafbc68e8ba4e2b2deffa9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6aa861f1403424bf5768d6dd25da402f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6aa861f1403424bf5768d6dd25da402f"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a6aa861f1403424bf5768d6dd25da402f">is_symlink</a> () const noexcept</td></tr> +<tr class="memdesc:a6aa861f1403424bf5768d6dd25da402f"><td class="mdescLeft"> </td><td class="mdescRight">True if a symlink. <br/></td></tr> +<tr class="separator:a6aa861f1403424bf5768d6dd25da402f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad6cbdfbe64d09ec03829144a137bc865"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6cbdfbe64d09ec03829144a137bc865"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#ad6cbdfbe64d09ec03829144a137bc865">is_multiplexer</a> () const noexcept</td></tr> +<tr class="memdesc:ad6cbdfbe64d09ec03829144a137bc865"><td class="mdescLeft"> </td><td class="mdescRight">True if a multiplexer like BSD kqueues, Linux epoll or Windows IOCP. <br/></td></tr> +<tr class="separator:ad6cbdfbe64d09ec03829144a137bc865"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3460c3419d165c7d9e8aaee8db3c7f2c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3460c3419d165c7d9e8aaee8db3c7f2c"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a3460c3419d165c7d9e8aaee8db3c7f2c">is_process</a> () const noexcept</td></tr> +<tr class="memdesc:a3460c3419d165c7d9e8aaee8db3c7f2c"><td class="mdescLeft"> </td><td class="mdescRight">True if a process. <br/></td></tr> +<tr class="separator:a3460c3419d165c7d9e8aaee8db3c7f2c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad4ee22cfec00551e1f71ff23962280be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4ee22cfec00551e1f71ff23962280be"></a> +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527ca">caching</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#ad4ee22cfec00551e1f71ff23962280be">kernel_caching</a> () const noexcept</td></tr> +<tr class="memdesc:ad4ee22cfec00551e1f71ff23962280be"><td class="mdescLeft"> </td><td class="mdescRight">Kernel cache strategy used by this handle. <br/></td></tr> +<tr class="separator:ad4ee22cfec00551e1f71ff23962280be"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a70998344e2234961c5ad64491d042ff8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70998344e2234961c5ad64491d042ff8"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a70998344e2234961c5ad64491d042ff8">are_reads_from_cache</a> () const noexcept</td></tr> +<tr class="memdesc:a70998344e2234961c5ad64491d042ff8"><td class="mdescLeft"> </td><td class="mdescRight">True if the handle uses the kernel page cache for reads. <br/></td></tr> +<tr class="separator:a70998344e2234961c5ad64491d042ff8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae446e9a32283991f58f8f27dbed083d1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae446e9a32283991f58f8f27dbed083d1"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#ae446e9a32283991f58f8f27dbed083d1">are_writes_durable</a> () const noexcept</td></tr> +<tr class="memdesc:ae446e9a32283991f58f8f27dbed083d1"><td class="mdescLeft"> </td><td class="mdescRight">True if writes are safely on storage on completion. <br/></td></tr> +<tr class="separator:ae446e9a32283991f58f8f27dbed083d1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3e08545dd29f09a40ff8439ac774ae1e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e08545dd29f09a40ff8439ac774ae1e"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a3e08545dd29f09a40ff8439ac774ae1e">are_safety_fsyncs_issued</a> () const noexcept</td></tr> +<tr class="memdesc:a3e08545dd29f09a40ff8439ac774ae1e"><td class="mdescLeft"> </td><td class="mdescRight">True if issuing safety fsyncs is on. <br/></td></tr> +<tr class="separator:a3e08545dd29f09a40ff8439ac774ae1e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa8de6675205db68de70bf9075a6c649f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceboost_1_1afio_1_1v2__xxx.html#ac8d06ecaa9660e7251c1251d88c1305c">result</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#aa8de6675205db68de70bf9075a6c649f">set_kernel_caching</a> (<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527ca">caching</a> <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527ca">caching</a>) noexcept</td></tr> +<tr class="separator:aa8de6675205db68de70bf9075a6c649f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:add27fa17cd6356b49a26a8b6dafb6a6d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add27fa17cd6356b49a26a8b6dafb6a6d"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1bitfield.html">flag</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#add27fa17cd6356b49a26a8b6dafb6a6d">flags</a> () const noexcept</td></tr> +<tr class="memdesc:add27fa17cd6356b49a26a8b6dafb6a6d"><td class="mdescLeft"> </td><td class="mdescRight">The flags this handle was opened with. <br/></td></tr> +<tr class="separator:add27fa17cd6356b49a26a8b6dafb6a6d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae600069dc662d837c36f42802791c7f4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae600069dc662d837c36f42802791c7f4"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1native__handle__type.html">native_handle_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#ae600069dc662d837c36f42802791c7f4">native_handle</a> () const noexcept</td></tr> +<tr class="memdesc:ae600069dc662d837c36f42802791c7f4"><td class="mdescLeft"> </td><td class="mdescRight">The native handle used by this handle. <br/></td></tr> +<tr class="separator:ae600069dc662d837c36f42802791c7f4"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr class="memitem:ae19418f14d1dd86e75214eda7644d42f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae19418f14d1dd86e75214eda7644d42f"></a> +<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527ca">caching</a> </td><td class="memItemRight" valign="bottom"><b>_caching</b></td></tr> +<tr class="separator:ae19418f14d1dd86e75214eda7644d42f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5037b058e4f8ef02a776d870b10d379a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5037b058e4f8ef02a776d870b10d379a"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1bitfield.html">flag</a> </td><td class="memItemRight" valign="bottom"><b>_flags</b></td></tr> +<tr class="separator:a5037b058e4f8ef02a776d870b10d379a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8d3193d192d5de93d3ea781b93ea398b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d3193d192d5de93d3ea781b93ea398b"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1native__handle__type.html">native_handle_type</a> </td><td class="memItemRight" valign="bottom"><b>_v</b></td></tr> +<tr class="separator:a8d3193d192d5de93d3ea781b93ea398b"><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:a5c7d33dcd1f366fa378607e1dd087744"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c7d33dcd1f366fa378607e1dd087744"></a> +std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &s, const <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html">handle</a> &v)</td></tr> +<tr class="separator:a5c7d33dcd1f366fa378607e1dd087744"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>A <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1native__handle__type.html" title="A native handle type used for wrapping file descriptors, process ids or HANDLEs. Unmanaged, wrap in a handle object to manage.">native_handle_type</a> which is managed by the lifetime of this object instance. </p> +</div><h2 class="groupheader">Member Enumeration Documentation</h2> +<a class="anchor" id="a81c7de194feaa88684ca9851d0d527ca"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527ca">boost::afio::v2_xxx::handle::caching</a> : unsigned char</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>What i/o on the handle will complete immediately due to kernel caching. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a81c7de194feaa88684ca9851d0d527caa334c4a4c42fdb79d7ebc3e73b517e6f8"></a>none</em> </td><td class="fielddoc"> +<p>No caching whatsoever, all reads and writes come from storage (i.e. <code>O_DIRECT|O_SYNC</code>). Align all i/o to 4Kb boundaries for this to work. <code>flag_disable_safety_fsyncs</code> can be used here. </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a81c7de194feaa88684ca9851d0d527caab8a61dd00ce6fc5888706bda8fab2e98"></a>only_metadata</em> </td><td class="fielddoc"> +<p>Cache reads and writes of metadata but avoid caching data (<code>O_DIRECT</code>), thus i/o here does not affect other cached data for other handles. Align all i/o to 4Kb boundaries for this to work. </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a81c7de194feaa88684ca9851d0d527caa0fb9cf5f04f61bb6f1151da57ceb1ca1"></a>reads</em> </td><td class="fielddoc"> +<p>Cache reads only. Writes of data and metadata do not complete until reaching storage (<code>O_SYNC</code>). <code>flag_disable_safety_fsyncs</code> can be used here. </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a81c7de194feaa88684ca9851d0d527caadec4ecca8ae1593f84eea4656599a693"></a>reads_and_metadata</em> </td><td class="fielddoc"> +<p>Cache reads and writes of metadata, but writes of data do not complete until reaching storage (<code>O_DSYNC</code>). <code>flag_disable_safety_fsyncs</code> can be used here. </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a81c7de194feaa88684ca9851d0d527caaa181a603769c1f98ad927e7367c7aa51"></a>all</em> </td><td class="fielddoc"> +<p>Cache reads and writes of data and metadata so they complete immediately, sending writes to storage at some point when the kernel decides (this is the default file system caching on a system). </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a81c7de194feaa88684ca9851d0d527caadfa4d35596e04e042a53c64b25c22db3"></a>safety_fsyncs</em> </td><td class="fielddoc"> +<p>Cache reads and writes of data and metadata so they complete immediately, but issue safety fsyncs at certain points. See documentation for <code>flag_disable_safety_fsyncs</code>. </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a81c7de194feaa88684ca9851d0d527caad5197d93c063a2b1e22d1630a39b7aef"></a>temporary</em> </td><td class="fielddoc"> +<p>Cache reads and writes of data and metadata so they complete immediately, only sending any updates to storage on last handle close in the system or if memory becomes tight as this file is expected to be temporary (Windows only). </p> +</td></tr> +</table> +<div class="fragment"><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  : <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="comment">// bit 0 set means safety fsyncs enabled</span></div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  unchanged = 0,</div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabada334c4a4c42fdb79d7ebc3e73b517e6f8" title="No ability to read or write anything, but can synchronise (SYNCHRONIZE or 0)">none</a> = 1, </div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caab8a61dd00ce6fc5888706bda8fab2e98" title="Cache reads and writes of metadata but avoid caching data (O_DIRECT), thus i/o here does not affect o...">only_metadata</a> = 2, </div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caa0fb9cf5f04f61bb6f1151da57ceb1ca1" title="Cache reads only. Writes of data and metadata do not complete until reaching storage (O_SYNC)...">reads</a> = 3, </div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caadec4ecca8ae1593f84eea4656599a693" title="Cache reads and writes of metadata, but writes of data do not complete until reaching storage (O_DSYN...">reads_and_metadata</a> = 5, </div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caaa181a603769c1f98ad927e7367c7aa51" title="Cache reads and writes of data and metadata so they complete immediately, sending writes to storage a...">all</a> = 4, </div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caadfa4d35596e04e042a53c64b25c22db3" title="Cache reads and writes of data and metadata so they complete immediately, but issue safety fsyncs at ...">safety_fsyncs</a> = 7, </div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527caad5197d93c063a2b1e22d1630a39b7aef" title="Cache reads and writes of data and metadata so they complete immediately, only sending any updates to...">temporary</a> = 6 </div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment">// NOTE: IF UPDATING THIS UPDATE THE std::ostream PRINTER BELOW!!!</span></div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  };</div> +</div><!-- fragment --> +</div> +</div> +<a class="anchor" id="ab7acaf4e9155f8ad4023813354de5357"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#ab7acaf4e9155f8ad4023813354de5357">boost::afio::v2_xxx::handle::creation</a> : unsigned char</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>On opening, do we also create a new file or truncate an existing one? </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ab7acaf4e9155f8ad4023813354de5357a244f58cf07c35fd48d7524b289551e5c"></a>truncate</em> </td><td class="fielddoc"> +<p>Atomically truncate on open, leaving creation date unmodified. </p> +</td></tr> +</table> +<div class="fragment"><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  : <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span></div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  {</div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  open_existing = 0,</div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  only_if_not_exist,</div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  if_needed,</div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#ab7acaf4e9155f8ad4023813354de5357a244f58cf07c35fd48d7524b289551e5c" title="Atomically truncate on open, leaving creation date unmodified.">truncate</a> </div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// NOTE: IF UPDATING THIS UPDATE THE std::ostream PRINTER BELOW!!!</span></div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  };</div> +</div><!-- fragment --> +</div> +</div> +<a class="anchor" id="acd7f0c039e94c7ad40937fe32a2cabad"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabad">boost::afio::v2_xxx::handle::mode</a> : unsigned char</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The behaviour of the handle: does it read, read and write, or atomic append? </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="acd7f0c039e94c7ad40937fe32a2cabada334c4a4c42fdb79d7ebc3e73b517e6f8"></a>none</em> </td><td class="fielddoc"> +<p>No ability to read or write anything, but can synchronise (SYNCHRONIZE or 0) </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="acd7f0c039e94c7ad40937fe32a2cabadaa4daf6d1e8da35af49c33bbe9ee91d79"></a>attr_read</em> </td><td class="fielddoc"> +<p>Ability to read attributes (FILE_READ_ATTRIBUTES|SYNCHRONIZE or O_RDONLY) </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="acd7f0c039e94c7ad40937fe32a2cabada9f56aff64cb748e078ab221474132d19"></a>attr_write</em> </td><td class="fielddoc"> +<p>Ability to read and write attributes (FILE_READ_ATTRIBUTES|FILE_WRITE_ATTRIBUTES|SYNCHRONIZE or O_RDONLY) </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="acd7f0c039e94c7ad40937fe32a2cabadaecae13117d6f0584c25a9da6c8f8415e"></a>read</em> </td><td class="fielddoc"> +<p>Ability to read (READ_CONTROL|FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA|SYNCHRONISE or O_RDONLY) </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="acd7f0c039e94c7ad40937fe32a2cabadaefb2a684e4afb7d55e6147fbe5a332ee"></a>write</em> </td><td class="fielddoc"> +<p>Ability to read and write (READ_CONTROL|FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONISE or O_RDWR) </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="acd7f0c039e94c7ad40937fe32a2cabada9516dfb15f51c7ee19a4d46b8c0dbe1d"></a>append</em> </td><td class="fielddoc"> +<p>All mainstream OSs and CIFS guarantee this is atomic with respect to all other appenders (FILE_APPEND_DATA|SYNCHRONISE or O_APPEND) </p> +</td></tr> +</table> +<div class="fragment"><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  : <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="comment">// bit 0 set means writable</span></div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  {</div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  unchanged = 0,</div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabada334c4a4c42fdb79d7ebc3e73b517e6f8" title="No ability to read or write anything, but can synchronise (SYNCHRONIZE or 0)">none</a> = 2, </div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabadaa4daf6d1e8da35af49c33bbe9ee91d79" title="Ability to read attributes (FILE_READ_ATTRIBUTES|SYNCHRONIZE or O_RDONLY)">attr_read</a> = 4, </div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabada9f56aff64cb748e078ab221474132d19" title="Ability to read and write attributes (FILE_READ_ATTRIBUTES|FILE_WRITE_ATTRIBUTES|SYNCHRONIZE or O_RDO...">attr_write</a> = 5, </div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabadaecae13117d6f0584c25a9da6c8f8415e" title="Ability to read (READ_CONTROL|FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA|SYNCHRONISE or O_RDONL...">read</a> = 6, </div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabadaefb2a684e4afb7d55e6147fbe5a332ee" title="Ability to read and write (READ_CONTROL|FILE_READ_DATA|FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_WRITE_D...">write</a> = 7, </div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#acd7f0c039e94c7ad40937fe32a2cabada9516dfb15f51c7ee19a4d46b8c0dbe1d" title="All mainstream OSs and CIFS guarantee this is atomic with respect to all other appenders (FILE_APPEND...">append</a> = 9 </div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// NOTE: IF UPDATING THIS UPDATE THE std::ostream PRINTER BELOW!!!</span></div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  };</div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="adf964e787e0666fc5b7d94c2715ee6f5"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceboost_1_1afio_1_1v2__xxx.html#ac8d06ecaa9660e7251c1251d88c1305c">result</a><void> boost::afio::v2_xxx::handle::set_append_only </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"><em>enable</em></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 class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Changes whether this handle is append only or not.</p> +<dl class="section warning"><dt>Warning</dt><dd>On Windows this is implemented as a bit of a hack to make it fast like on POSIX, so make sure you open the handle for read/write originally. Note unlike on POSIX the append_only disposition will be the only one toggled, seekable and readable will remain turned on.</dd></dl> +<dl class="section user"><dt>Errors returnable</dt><dd>Whatever POSIX fcntl() returns. On Windows nothing is changed on the handle. </dd></dl> +<dl class="section user"><dt>Memory Allocations</dt><dd>No memory allocation. </dd></dl> + +</div> +</div> +<a class="anchor" id="aa8de6675205db68de70bf9075a6c649f"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceboost_1_1afio_1_1v2__xxx.html#ac8d06ecaa9660e7251c1251d88c1305c">result</a><void> boost::afio::v2_xxx::handle::set_kernel_caching </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html#a81c7de194feaa88684ca9851d0d527ca">caching</a> </td> + <td class="paramname"><em>caching</em></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 class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Changes the kernel cache strategy used by this handle. Note most OSs impose severe restrictions on what can be changed and will error out, it may be easier to simply create a new handle.</p> +<dl class="section warning"><dt>Warning</dt><dd>On Windows this reopens the file, it is no slower than opening the file fresh but equally it is vastly slower than on POSIX.</dd></dl> +<dl class="section user"><dt>Errors returnable</dt><dd>Whatever POSIX fcntl() or ReOpenFile() returns. </dd></dl> +<dl class="section user"><dt>Memory Allocations</dt><dd>No memory allocation. </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/boost/afio/v2.0/<a class="el" href="handle_8hpp_source.html">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="namespaceboost.html">boost</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1afio.html">afio</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1afio_1_1v2__xxx.html">v2_xxx</a></li><li class="navelem"><a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html">handle</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.3.1 </li> + </ul> +</div> +</body> +</html> |