diff options
| author | Jenkins nedprod CI <foo@nowhere> | 2016-08-10 10:08:44 +0300 |
|---|---|---|
| committer | Jenkins nedprod CI <foo@nowhere> | 2016-08-10 10:08:44 +0300 |
| commit | 44cf44629f2704ffb2b6c536be1eac566237d203 (patch) | |
| tree | ece52a36222c94ddbee0f557f3a93783f58b51b4 /structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html | |
| parent | cc293d14a48bf1ee3fb78743c3ad5cf61d63f3ff (diff) | |
Travis CI updates documentation
Diffstat (limited to 'structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html')
| -rw-r--r-- | structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html | 313 |
1 files changed, 313 insertions, 0 deletions
diff --git a/structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html b/structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html new file mode 100644 index 00000000..dacf9fd3 --- /dev/null +++ b/structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html @@ -0,0 +1,313 @@ +<!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::storage_profile::storage_profile Struct 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('structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.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="#pub-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">boost::afio::v2_xxx::storage_profile::storage_profile Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>A (possibly incomplet) profile of storage. + <a href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="storage__profile_8hpp_source.html">storage_profile.hpp</a>></code></p> +<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:ae7204279ec0767a7f636b2ace2ffc60d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7204279ec0767a7f636b2ace2ffc60d"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#ae7204279ec0767a7f636b2ace2ffc60d">size_type</a> = size_t</td></tr> +<tr class="memdesc:ae7204279ec0767a7f636b2ace2ffc60d"><td class="mdescLeft"> </td><td class="mdescRight">The size type. <br/></td></tr> +<tr class="separator:ae7204279ec0767a7f636b2ace2ffc60d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a10d6cab54ce1b2bc1e7236d39b9dc361"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10d6cab54ce1b2bc1e7236d39b9dc361"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a10d6cab54ce1b2bc1e7236d39b9dc361">value_type</a> = <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item__erased.html">item_erased</a> &</td></tr> +<tr class="memdesc:a10d6cab54ce1b2bc1e7236d39b9dc361"><td class="mdescLeft"> </td><td class="mdescRight">Value type. <br/></td></tr> +<tr class="separator:a10d6cab54ce1b2bc1e7236d39b9dc361"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2e1ee29ad902c5ae50d4a6762beeeaa5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e1ee29ad902c5ae50d4a6762beeeaa5"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a2e1ee29ad902c5ae50d4a6762beeeaa5">reference</a> = <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item__erased.html">item_erased</a> &</td></tr> +<tr class="memdesc:a2e1ee29ad902c5ae50d4a6762beeeaa5"><td class="mdescLeft"> </td><td class="mdescRight">Reference type. <br/></td></tr> +<tr class="separator:a2e1ee29ad902c5ae50d4a6762beeeaa5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3fc67e942968135ca8c4df7e635ed006"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3fc67e942968135ca8c4df7e635ed006"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a3fc67e942968135ca8c4df7e635ed006">const_reference</a> = const <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item__erased.html">item_erased</a> &</td></tr> +<tr class="memdesc:a3fc67e942968135ca8c4df7e635ed006"><td class="mdescLeft"> </td><td class="mdescRight">Const reference type. <br/></td></tr> +<tr class="separator:a3fc67e942968135ca8c4df7e635ed006"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6a6f0028df4d6c41ebdec023fd16f7db"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a6f0028df4d6c41ebdec023fd16f7db"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a6a6f0028df4d6c41ebdec023fd16f7db">iterator</a> = <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item__erased.html">item_erased</a> *</td></tr> +<tr class="memdesc:a6a6f0028df4d6c41ebdec023fd16f7db"><td class="mdescLeft"> </td><td class="mdescRight">Iterator type. <br/></td></tr> +<tr class="separator:a6a6f0028df4d6c41ebdec023fd16f7db"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac5c9432c3948de37def481c2166b05f6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5c9432c3948de37def481c2166b05f6"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#ac5c9432c3948de37def481c2166b05f6">const_iterator</a> = const <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item__erased.html">item_erased</a> *</td></tr> +<tr class="memdesc:ac5c9432c3948de37def481c2166b05f6"><td class="mdescLeft"> </td><td class="mdescRight">Const iterator type. <br/></td></tr> +<tr class="separator:ac5c9432c3948de37def481c2166b05f6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a902cdf343a238d8bc4773968ae6f294a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a902cdf343a238d8bc4773968ae6f294a"></a> +using </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a902cdf343a238d8bc4773968ae6f294a">handle_type</a> = <a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item__base.html#ac50981eecd188191dc343943031998d4">item_base::handle_type</a></td></tr> +<tr class="memdesc:a902cdf343a238d8bc4773968ae6f294a"><td class="mdescLeft"> </td><td class="mdescRight">The type of handle used for testing. <br/></td></tr> +<tr class="separator:a902cdf343a238d8bc4773968ae6f294a"><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:a43ac0d85d157bf049680fe649378fb8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43ac0d85d157bf049680fe649378fb8e"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a43ac0d85d157bf049680fe649378fb8e">empty</a> () const noexcept</td></tr> +<tr class="memdesc:a43ac0d85d157bf049680fe649378fb8e"><td class="mdescLeft"> </td><td class="mdescRight">True if this storage profile is empty. <br/></td></tr> +<tr class="separator:a43ac0d85d157bf049680fe649378fb8e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a08e117ddec1c0b1cb2a601dc4e34a323"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08e117ddec1c0b1cb2a601dc4e34a323"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#ae7204279ec0767a7f636b2ace2ffc60d">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a08e117ddec1c0b1cb2a601dc4e34a323">size</a> () const noexcept</td></tr> +<tr class="memdesc:a08e117ddec1c0b1cb2a601dc4e34a323"><td class="mdescLeft"> </td><td class="mdescRight">Items in this storage profile. <br/></td></tr> +<tr class="separator:a08e117ddec1c0b1cb2a601dc4e34a323"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7cfd0a293329c63b919c74c63ca7cb6e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cfd0a293329c63b919c74c63ca7cb6e"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#ae7204279ec0767a7f636b2ace2ffc60d">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a7cfd0a293329c63b919c74c63ca7cb6e">max_size</a> () const noexcept</td></tr> +<tr class="memdesc:a7cfd0a293329c63b919c74c63ca7cb6e"><td class="mdescLeft"> </td><td class="mdescRight">Potential items in this storage profile. <br/></td></tr> +<tr class="separator:a7cfd0a293329c63b919c74c63ca7cb6e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aff13684e4ab8c811e63808b66901209c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff13684e4ab8c811e63808b66901209c"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a6a6f0028df4d6c41ebdec023fd16f7db">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#aff13684e4ab8c811e63808b66901209c">begin</a> () noexcept</td></tr> +<tr class="memdesc:aff13684e4ab8c811e63808b66901209c"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the first item. <br/></td></tr> +<tr class="separator:aff13684e4ab8c811e63808b66901209c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a74d51da11db5f95ae0914b2135b73608"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74d51da11db5f95ae0914b2135b73608"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a6a6f0028df4d6c41ebdec023fd16f7db">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a74d51da11db5f95ae0914b2135b73608">end</a> () noexcept</td></tr> +<tr class="memdesc:a74d51da11db5f95ae0914b2135b73608"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the last item. <br/></td></tr> +<tr class="separator:a74d51da11db5f95ae0914b2135b73608"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a41eaa3d97abd88484db04b0fed1d7cd3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41eaa3d97abd88484db04b0fed1d7cd3"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#ac5c9432c3948de37def481c2166b05f6">const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a41eaa3d97abd88484db04b0fed1d7cd3">begin</a> () const noexcept</td></tr> +<tr class="memdesc:a41eaa3d97abd88484db04b0fed1d7cd3"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the first item. <br/></td></tr> +<tr class="separator:a41eaa3d97abd88484db04b0fed1d7cd3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa6dafcd221084212079d14d67522e26c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6dafcd221084212079d14d67522e26c"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#ac5c9432c3948de37def481c2166b05f6">const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#aa6dafcd221084212079d14d67522e26c">end</a> () const noexcept</td></tr> +<tr class="memdesc:aa6dafcd221084212079d14d67522e26c"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the last item. <br/></td></tr> +<tr class="separator:aa6dafcd221084212079d14d67522e26c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afc56522cf4f6d90bd825f7f50bff7432"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc56522cf4f6d90bd825f7f50bff7432"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#afc56522cf4f6d90bd825f7f50bff7432">read</a> (std::istream &in, std::regex which=std::regex(".*"))</td></tr> +<tr class="memdesc:afc56522cf4f6d90bd825f7f50bff7432"><td class="mdescLeft"> </td><td class="mdescRight">Read the matching items in the storage profile from in as YAML. <br/></td></tr> +<tr class="separator:afc56522cf4f6d90bd825f7f50bff7432"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a927515610146e07b149cfe8cb4ccc52f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a927515610146e07b149cfe8cb4ccc52f"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html#a927515610146e07b149cfe8cb4ccc52f">write</a> (std::ostream &out, std::regex which=std::regex(".*"), size_t _indent=0, bool invert_which=false) const </td></tr> +<tr class="memdesc:a927515610146e07b149cfe8cb4ccc52f"><td class="mdescLeft"> </td><td class="mdescRight">Write the matching items from storage profile as YAML to out with the given indentation. <br/></td></tr> +<tr class="separator:a927515610146e07b149cfe8cb4ccc52f"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:a0a870aa7cede1bd98ac357bb368b1086"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a870aa7cede1bd98ac357bb368b1086"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< std::string > </td><td class="memItemRight" valign="bottom"><b>os_name</b> = {"system:os:name", &system::os}</td></tr> +<tr class="separator:a0a870aa7cede1bd98ac357bb368b1086"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a35922038b4654a966b90bfa5e253bbbb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35922038b4654a966b90bfa5e253bbbb"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< std::string > </td><td class="memItemRight" valign="bottom"><b>os_ver</b> = {"system:os:ver", &system::os}</td></tr> +<tr class="separator:a35922038b4654a966b90bfa5e253bbbb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:add8c0d834b194f3b2720f0a863908aa1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add8c0d834b194f3b2720f0a863908aa1"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< std::string > </td><td class="memItemRight" valign="bottom"><b>cpu_name</b> = {"system:cpu:name", &system::cpu}</td></tr> +<tr class="separator:add8c0d834b194f3b2720f0a863908aa1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a19b3d6259b76cc4279e08f1fd1ab57a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a19b3d6259b76cc4279e08f1fd1ab57a3"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< std::string > </td><td class="memItemRight" valign="bottom"><b>cpu_architecture</b> = {"system:cpu:architecture", &system::cpu}</td></tr> +<tr class="separator:a19b3d6259b76cc4279e08f1fd1ab57a3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8c11a52c1c4e5a7d40f9deb4b83c71b4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c11a52c1c4e5a7d40f9deb4b83c71b4"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< unsigned > </td><td class="memItemRight" valign="bottom"><b>cpu_physical_cores</b> = {"system:cpu:physical_cores", &system::cpu}</td></tr> +<tr class="separator:a8c11a52c1c4e5a7d40f9deb4b83c71b4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a262f64d490ccd052cd3f9c0f07170f46"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a262f64d490ccd052cd3f9c0f07170f46"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< unsigned long long > </td><td class="memItemRight" valign="bottom"><b>mem_max_bandwidth</b> = {"system:mem:max_bandwidth", system::mem, "Main memory bandwidth when accessed sequentially"}</td></tr> +<tr class="separator:a262f64d490ccd052cd3f9c0f07170f46"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a213877497fe8e3eae8ee24ae42e2b6d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a213877497fe8e3eae8ee24ae42e2b6d8"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< unsigned long long > </td><td class="memItemRight" valign="bottom"><b>mem_min_bandwidth</b> = {"system:mem:min_bandwidth", system::mem, "Main memory bandwidth when 4Kb pages are accessed randomly"}</td></tr> +<tr class="separator:a213877497fe8e3eae8ee24ae42e2b6d8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab70fa053a5c63c9afddc671df721f022"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab70fa053a5c63c9afddc671df721f022"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< unsigned long long > </td><td class="memItemRight" valign="bottom"><b>mem_quantity</b> = {"system:mem:quantity", &system::mem}</td></tr> +<tr class="separator:ab70fa053a5c63c9afddc671df721f022"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6488007ba52e2ac7d641ca48dc531c78"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6488007ba52e2ac7d641ca48dc531c78"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< float > </td><td class="memItemRight" valign="bottom"><b>mem_in_use</b> = {"system:mem:in_use", &system::mem}</td></tr> +<tr class="separator:a6488007ba52e2ac7d641ca48dc531c78"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a57e340e5306dd57ef8b30110b491d8cb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57e340e5306dd57ef8b30110b491d8cb"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< std::string > </td><td class="memItemRight" valign="bottom"><b>controller_type</b> = {"storage:controller:kind", &storage::device}</td></tr> +<tr class="separator:a57e340e5306dd57ef8b30110b491d8cb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a16582ee69c4ecd8ca6030f8fad3de639"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16582ee69c4ecd8ca6030f8fad3de639"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< unsigned > </td><td class="memItemRight" valign="bottom"><b>controller_max_transfer</b> = {"storage:controller:max_transfer", storage::device, "The maximum number of bytes the disk controller can transfer at once"}</td></tr> +<tr class="separator:a16582ee69c4ecd8ca6030f8fad3de639"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a90c793ad5f4c1064f01f4e7cc5ec1501"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a90c793ad5f4c1064f01f4e7cc5ec1501"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< unsigned > </td><td class="memItemRight" valign="bottom"><b>controller_max_buffers</b> = {"storage:controller:max_buffers", storage::device, "The maximum number of scatter-gather buffers the disk controller can <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1handle.html">handle</a>"}</td></tr> +<tr class="separator:a90c793ad5f4c1064f01f4e7cc5ec1501"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2fec39478a19524e5ea0a5b86ddd3849"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fec39478a19524e5ea0a5b86ddd3849"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< std::string > </td><td class="memItemRight" valign="bottom"><b>device_name</b> = {"storage:device:name", &storage::device}</td></tr> +<tr class="separator:a2fec39478a19524e5ea0a5b86ddd3849"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a83d2219a5baa4feedcdf5b043e3500cd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83d2219a5baa4feedcdf5b043e3500cd"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< unsigned > </td><td class="memItemRight" valign="bottom"><b>device_min_io_size</b> = {"storage:device:min_io_size", &storage::device}</td></tr> +<tr class="separator:a83d2219a5baa4feedcdf5b043e3500cd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a03efff9ee431c43b9288e2869bace13a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03efff9ee431c43b9288e2869bace13a"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1io__service.html#aa853170124634f2065cd5df672bf594d">io_service::extent_type</a> > </td><td class="memItemRight" valign="bottom"><b>device_size</b> = {"storage:device:size", &storage::device}</td></tr> +<tr class="separator:a03efff9ee431c43b9288e2869bace13a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a56ccc11af4a5dacd5759619ae89cb73e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56ccc11af4a5dacd5759619ae89cb73e"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< std::string > </td><td class="memItemRight" valign="bottom"><b>fs_name</b> = {"storage:fs:name", &storage::fs}</td></tr> +<tr class="separator:a56ccc11af4a5dacd5759619ae89cb73e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac2524342b9daa3acf94f9715df01d644"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2524342b9daa3acf94f9715df01d644"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< std::string > </td><td class="memItemRight" valign="bottom"><b>fs_config</b> = {"storage:fs:config", &storage::fs}</td></tr> +<tr class="separator:ac2524342b9daa3acf94f9715df01d644"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aeee5d4202ff17b559eec6089f0078451"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeee5d4202ff17b559eec6089f0078451"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1io__service.html#aa853170124634f2065cd5df672bf594d">io_service::extent_type</a> > </td><td class="memItemRight" valign="bottom"><b>fs_size</b> = {"storage:fs:size", &storage::fs}</td></tr> +<tr class="separator:aeee5d4202ff17b559eec6089f0078451"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab16398230b2a482e60dc74e3f2a037e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab16398230b2a482e60dc74e3f2a037e1"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< float > </td><td class="memItemRight" valign="bottom"><b>fs_in_use</b> = {"storage:fs:in_use", &storage::fs}</td></tr> +<tr class="separator:ab16398230b2a482e60dc74e3f2a037e1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa733752949bc932777f1c50e12f73760"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa733752949bc932777f1c50e12f73760"></a> +<a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1io__service.html#aa853170124634f2065cd5df672bf594d">io_service::extent_type</a> > </td><td class="memItemRight" valign="bottom"><b>atomic_rewrite_quantum</b> = {"concurrency:atomic_rewrite_quantum", concurrency::atomic_rewrite_quantum, "The i/o modify quantum guaranteed to be atomically visible to readers irrespective of rewrite quantity"}</td></tr> +<tr class="separator:aa733752949bc932777f1c50e12f73760"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a316870f1e488b0bcf3a2df627388e808"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1io__service.html#aa853170124634f2065cd5df672bf594d">io_service::extent_type</a> > </td><td class="memItemRight" valign="bottom"><b>max_aligned_atomic_rewrite</b></td></tr> +<tr class="separator:a316870f1e488b0bcf3a2df627388e808"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a73852f72c4c1a2306f64447d9eca6628"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a>< <a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1io__service.html#aa853170124634f2065cd5df672bf594d">io_service::extent_type</a> > </td><td class="memItemRight" valign="bottom"><b>atomic_rewrite_offset_boundary</b></td></tr> +<tr class="separator:a73852f72c4c1a2306f64447d9eca6628"><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 (possibly incomplet) profile of storage. </p> +</div><h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="a73852f72c4c1a2306f64447d9eca6628"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a><<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1io__service.html#aa853170124634f2065cd5df672bf594d">io_service::extent_type</a>> boost::afio::v2_xxx::storage_profile::storage_profile::atomic_rewrite_offset_boundary</td> + </tr> + </table> +</div><div class="memdoc"> +<b>Initial value:</b><div class="fragment"><div class="line">= {<span class="stringliteral">"concurrency:atomic_rewrite_offset_boundary"</span>, concurrency::atomic_rewrite_offset_boundary, <span class="stringliteral">"The multiple of offset in a file where update atomicity breaks, so if you wrote 4096 bytes at a 512 offset and "</span></div> +<div class="line"> <span class="stringliteral">"this value was 4096, your write would tear at 3584 because all writes would tear on a 4096 offset multiple. "</span></div> +<div class="line"> <span class="stringliteral">"Linux has a famously broken kernel i/o design which causes this value to be a page multiple, except on "</span></div> +<div class="line"> <span class="stringliteral">"filing systems which take special measures to work around it. Windows NT appears to lose all atomicity as soon as "</span></div> +<div class="line"> <span class="stringliteral">"an i/o straddles a 4096 file offset multiple and DMA suddenly goes into many 64 byte cache lines :(, so if "</span></div> +<div class="line"> <span class="stringliteral">"this value is less than max_aligned_atomic_rewrite and some multiple of the CPU cache line size then this is "</span></div> +<div class="line"> <span class="stringliteral">"what has happened."</span>}</div> +</div><!-- fragment --> +</div> +</div> +<a class="anchor" id="a316870f1e488b0bcf3a2df627388e808"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1item.html">item</a><<a class="el" href="classboost_1_1afio_1_1v2__xxx_1_1io__service.html#aa853170124634f2065cd5df672bf594d">io_service::extent_type</a>> boost::afio::v2_xxx::storage_profile::storage_profile::max_aligned_atomic_rewrite</td> + </tr> + </table> +</div><div class="memdoc"> +<b>Initial value:</b><div class="fragment"><div class="line">= {<span class="stringliteral">"concurrency:max_aligned_atomic_rewrite"</span>, concurrency::atomic_rewrite_quantum,</div> +<div class="line"> <span class="stringliteral">"The maximum single aligned i/o modify quantity atomically visible to readers (can be [potentially unreliably] much larger than atomic_rewrite_quantum). "</span></div> +<div class="line"> <span class="stringliteral">"A very common value on modern hardware with direct i/o thanks to PCIe DMA is 4096, don't trust values higher than this because of potentially discontiguous memory page mapping."</span>}</div> +</div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>include/boost/afio/v2.0/<a class="el" href="storage__profile_8hpp_source.html">storage_profile.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="namespaceboost_1_1afio_1_1v2__xxx_1_1storage__profile.html">storage_profile</a></li><li class="navelem"><a class="el" href="structboost_1_1afio_1_1v2__xxx_1_1storage__profile_1_1storage__profile.html">storage_profile</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> |