diff options
Diffstat (limited to 'namespacellfio__v2__xxx_1_1path__discovery.html')
| -rw-r--r-- | namespacellfio__v2__xxx_1_1path__discovery.html | 74 |
1 files changed, 54 insertions, 20 deletions
diff --git a/namespacellfio__v2__xxx_1_1path__discovery.html b/namespacellfio__v2__xxx_1_1path__discovery.html index 088fd69e..d76be2a0 100644 --- a/namespacellfio__v2__xxx_1_1path__discovery.html +++ b/namespacellfio__v2__xxx_1_1path__discovery.html @@ -1,9 +1,9 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="generator" content="Doxygen 1.8.17"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>LLFIO: llfio_v2_xxx::path_discovery Namespace Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -13,9 +13,6 @@ <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> @@ -29,7 +26,7 @@ <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">LLFIO -  <span id="projectnumber">v2.00 late alpha</span> +  <span id="projectnumber">v2.00 late beta</span> </div> </td> </tr> @@ -37,18 +34,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.13 --> +<!-- Generated by Doxygen 1.8.17 --> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -</script> +/* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> @@ -62,7 +62,9 @@ $(function() { </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('namespacellfio__v2__xxx_1_1path__discovery.html','');}); +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('namespacellfio__v2__xxx_1_1path__discovery.html',''); initResizable(); }); +/* @license-end */ </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -89,7 +91,7 @@ $(document).ready(function(){initNavTree('namespacellfio__v2__xxx_1_1path__disco <div class="contents"> <p>Contains functions used to discover suitable paths for things. -<a href="#details">More...</a></p> +<a href="namespacellfio__v2__xxx_1_1path__discovery.html#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> @@ -103,17 +105,20 @@ Functions</h2></td></tr> std::ostream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (std::ostream &s, const <a class="el" href="structllfio__v2__xxx_1_1path__discovery_1_1discovered__path.html#ae02f172851c050f6a7f5929410428c7d">discovered_path::source_type</a> &v)</td></tr> <tr class="separator:a876db6e58143e730afd0706226f39d6c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ada0466e529e851d2d58ce87e0e28f4f2"><td class="memItemLeft" align="right" valign="top">span< <a class="el" href="structllfio__v2__xxx_1_1path__discovery_1_1discovered__path.html">discovered_path</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1path__discovery.html#ada0466e529e851d2d58ce87e0e28f4f2">all_temporary_directories</a> (bool refresh=false) noexcept</td></tr> -<tr class="memdesc:ada0466e529e851d2d58ce87e0e28f4f2"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of potential directories which might be usuable for temporary files. <a href="#ada0466e529e851d2d58ce87e0e28f4f2">More...</a><br /></td></tr> +<tr class="memdesc:ada0466e529e851d2d58ce87e0e28f4f2"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of potential directories which might be usuable for temporary files. <a href="namespacellfio__v2__xxx_1_1path__discovery.html#ada0466e529e851d2d58ce87e0e28f4f2">More...</a><br /></td></tr> <tr class="separator:ada0466e529e851d2d58ce87e0e28f4f2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab3c4aaa0c413e4989461ab6551058583"><td class="memItemLeft" align="right" valign="top">span< <a class="el" href="structllfio__v2__xxx_1_1path__discovery_1_1discovered__path.html">discovered_path</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1path__discovery.html#ab3c4aaa0c413e4989461ab6551058583">verified_temporary_directories</a> () noexcept</td></tr> -<tr class="memdesc:ab3c4aaa0c413e4989461ab6551058583"><td class="mdescLeft"> </td><td class="mdescRight">Returns a subset of <code>all_temporary_directories()</code> each of which has been tested to be writable by the current process. No testing is done of available writable space. <a href="#ab3c4aaa0c413e4989461ab6551058583">More...</a><br /></td></tr> +<tr class="memdesc:ab3c4aaa0c413e4989461ab6551058583"><td class="mdescLeft"> </td><td class="mdescRight">Returns a subset of <code>all_temporary_directories()</code> each of which has been tested to be writable by the current process. No testing is done of available writable space. <a href="namespacellfio__v2__xxx_1_1path__discovery.html#ab3c4aaa0c413e4989461ab6551058583">More...</a><br /></td></tr> <tr class="separator:ab3c4aaa0c413e4989461ab6551058583"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2dd74ea752f3f511d58ccccdcac7f4fd"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classllfio__v2__xxx_1_1path__handle.html">path_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1path__discovery.html#a2dd74ea752f3f511d58ccccdcac7f4fd">storage_backed_temporary_files_directory</a> () noexcept</td></tr> -<tr class="memdesc:a2dd74ea752f3f511d58ccccdcac7f4fd"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to an open handle to a verified temporary directory where files created are stored in a filesystem directory, usually under the current user's quota. <a href="#a2dd74ea752f3f511d58ccccdcac7f4fd">More...</a><br /></td></tr> +<tr class="memdesc:a2dd74ea752f3f511d58ccccdcac7f4fd"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to an open handle to a verified temporary directory where files created are stored in a filesystem directory, usually under the current user's quota. <a href="namespacellfio__v2__xxx_1_1path__discovery.html#a2dd74ea752f3f511d58ccccdcac7f4fd">More...</a><br /></td></tr> <tr class="separator:a2dd74ea752f3f511d58ccccdcac7f4fd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ade18f14d3ef37488e8967c87faa04d29"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classllfio__v2__xxx_1_1path__handle.html">path_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1path__discovery.html#ade18f14d3ef37488e8967c87faa04d29">memory_backed_temporary_files_directory</a> () noexcept</td></tr> -<tr class="memdesc:ade18f14d3ef37488e8967c87faa04d29"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to an open handle to a verified temporary directory where files created are stored in memory/paging file, and thus access may be a lot quicker, but stronger limits on capacity may apply. <a href="#ade18f14d3ef37488e8967c87faa04d29">More...</a><br /></td></tr> +<tr class="memdesc:ade18f14d3ef37488e8967c87faa04d29"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to an open handle to a verified temporary directory where files created are stored in memory/paging file, and thus access may be a lot quicker, but stronger limits on capacity may apply. <a href="namespacellfio__v2__xxx_1_1path__discovery.html#ade18f14d3ef37488e8967c87faa04d29">More...</a><br /></td></tr> <tr class="separator:ade18f14d3ef37488e8967c87faa04d29"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2d3e2ea602c3195433c7898c41744188"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classllfio__v2__xxx_1_1path__handle.html">path_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacellfio__v2__xxx_1_1path__discovery.html#a2d3e2ea602c3195433c7898c41744188">temporary_named_pipes_directory</a> () noexcept</td></tr> +<tr class="memdesc:a2d3e2ea602c3195433c7898c41744188"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to an open handle to a verified temporary directory where named pipes may be created and found. <a href="namespacellfio__v2__xxx_1_1path__discovery.html#a2d3e2ea602c3195433c7898c41744188">More...</a><br /></td></tr> +<tr class="separator:a2d3e2ea602c3195433c7898c41744188"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Contains functions used to discover suitable paths for things. </p> @@ -144,8 +149,8 @@ std::ostream & </td><td class="memItemRight" valign="bottom"><b>operato <p>Returns a list of potential directories which might be usuable for temporary files. </p> <p>This is a fairly lightweight call which builds a master list of all potential temporary file directories given the environment block of this process (unless SUID or SGID or Privilege Elevation are in effect) and the user running this process. It does not verify if any of them exist, or are writable, or anything else about them. An internal mutex is held for the duration of this call.</p> -<dl class="section user"><dt>Memory Allocations</dt><dd>Allocates the master list of discovered temporary directories exactly once per process, unless <code>refresh</code> is true in which case the list will be refreshed. The system calls to retrieve paths may allocate additional memory for paths returned. </dd></dl> -<dl class="section user"><dt>Errors returnable</dt><dd>This call never fails, except to return an empty span. </dd></dl> +<dl class="section user"><dt>Memory Allocations\n Allocates the master list of discovered temporary directories exactly once per process,</dt><dd>unless <code>refresh</code> is true in which case the list will be refreshed. The system calls to retrieve paths may allocate additional memory for paths returned. </dd></dl> +<dl class="section user"><dt>Errors returnable\n This call never fails, except to return an empty span.</dt><dd></dd></dl> </div> </div> @@ -205,11 +210,40 @@ std::ostream & </td><td class="memItemRight" valign="bottom"><b>operato <p>Returns a reference to an open handle to a verified temporary directory where files created are stored in a filesystem directory, usually under the current user's quota. </p> <p>This is implemented by iterating all of the paths returned by <code>verified_temporary_directories()</code> and checking what file system is in use. The following regex is used:</p> -<p><code>btrfs|cifs|exfat|ext(2|3|4)|f2fs|hfs|jfs|lxfs|nfs|nilf2|ufs|vfat|xfs|zfs|msdosfs|newnfs|ntfs|smbfs|unionfs|fat|fat32</code></p> +<p><code>btrfs|cifs|exfat|ext(2|3|4)|f2fs|hfs|apfs|jfs|lxfs|nfs|nilf2|ufs|vfat|xfs|zfs|msdosfs|newnfs|ntfs|smbfs|unionfs|fat|fat32</code></p> <p>The handle is created during <code>verified_temporary_directories()</code> and is statically cached thereafter. </p> </div> </div> +<a id="a2d3e2ea602c3195433c7898c41744188"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2d3e2ea602c3195433c7898c41744188">◆ </a></span>temporary_named_pipes_directory()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="classllfio__v2__xxx_1_1path__handle.html">path_handle</a>& llfio_v2_xxx::path_discovery::temporary_named_pipes_directory </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Returns a reference to an open handle to a verified temporary directory where named pipes may be created and found. </p> +<p>On Microsoft Windows, this is <code>\Device\NamedPipe</code> within the NT kernel namespace.</p> +<p>On POSIX, this is <code>storage_backed_temporary_files_directory()</code>. </p> + +</div> +</div> <a id="ab3c4aaa0c413e4989461ab6551058583"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab3c4aaa0c413e4989461ab6551058583">◆ </a></span>verified_temporary_directories()</h2> @@ -234,8 +268,8 @@ std::ostream & </td><td class="memItemRight" valign="bottom"><b>operato </div><div class="memdoc"> <p>Returns a subset of <code>all_temporary_directories()</code> each of which has been tested to be writable by the current process. No testing is done of available writable space. </p> -<p>After this call returns, the successfully probed entries returned by <code>all_temporary_directories()</code> will have their stat structure set. As the probing involves creating a non-zero sized file in each possible temporary directory to verify its validity, this is not a fast call. It is however cached statically, so the cost occurs exactly once per process, unless someone calls <code>all_temporary_directories(true)</code> to wipe and refresh the master list. An internal mutex is held for the duration of this call. </p><dl class="section user"><dt>Memory Allocations</dt><dd>None. </dd></dl> -<dl class="section user"><dt>Errors returnable</dt><dd>This call never fails, though if it fails to find any writable temporary directory, it will terminate the process. </dd></dl> +<p>After this call returns, the successfully probed entries returned by <code>all_temporary_directories()</code> will have their stat structure set. As the probing involves creating a non-zero sized file in each possible temporary directory to verify its validity, this is not a fast call. It is however cached statically, so the cost occurs exactly once per process, unless someone calls <code>all_temporary_directories(true)</code> to wipe and refresh the master list. An internal mutex is held for the duration of this call. </p><dl class="section user"><dt>Memory Allocations\n None.</dt><dd></dd></dl> +<dl class="section user"><dt>Errors returnable\n This call never fails, though if it fails to find any writable temporary directory, it will</dt><dd>terminate the process. </dd></dl> </div> </div> @@ -247,7 +281,7 @@ std::ostream & </td><td class="memItemRight" valign="bottom"><b>operato <li class="navelem"><a class="el" href="namespacellfio__v2__xxx.html">llfio_v2_xxx</a></li><li class="navelem"><a class="el" href="namespacellfio__v2__xxx_1_1path__discovery.html">path_discovery</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> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> </ul> </div> </body> |