diff options
Diffstat (limited to 'async__file__handle_8hpp.html')
| -rw-r--r-- | async__file__handle_8hpp.html | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/async__file__handle_8hpp.html b/async__file__handle_8hpp.html index a6fb7110..a1c8b130 100644 --- a/async__file__handle_8hpp.html +++ b/async__file__handle_8hpp.html @@ -240,7 +240,7 @@ template<class CompletionRoutine > </div> </dl> <dl class="section user"><dt>Errors returnable</dt><dd>As for <code>barrier()</code>, plus <code>ENOMEM</code>. </dd></dl> <dl class="section user"><dt>Memory Allocations</dt><dd>If mem is not set, one calloc, one free. The allocation is unavoidable due to the need to store a type erased completion handler of unknown type and state per buffers input. </dd></dl> -<div class="fragment"><div class="line"><a name="l00712"></a><span class="lineno"> 712</span>  {}) noexcept</div><div class="line"><a name="l00713"></a><span class="lineno"> 713</span> {</div><div class="line"><a name="l00714"></a><span class="lineno"> 714</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.async_barrier(std::forward<decltype(reqs)>(reqs), std::forward<decltype(completion)>(completion), std::forward<decltype(wait_for_device)>(wait_for_device), std::forward<decltype(and_metadata)>(and_metadata), std::forward<decltype(mem)>(mem));</div><div class="line"><a name="l00715"></a><span class="lineno"> 715</span> }</div></div><!-- fragment --> +<div class="fragment"><div class="line"><a name="l00713"></a><span class="lineno"> 713</span>  {}) noexcept</div><div class="line"><a name="l00714"></a><span class="lineno"> 714</span> {</div><div class="line"><a name="l00715"></a><span class="lineno"> 715</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.async_barrier(std::forward<decltype(reqs)>(reqs), std::forward<decltype(completion)>(completion), std::forward<decltype(wait_for_device)>(wait_for_device), std::forward<decltype(and_metadata)>(and_metadata), std::forward<decltype(mem)>(mem));</div><div class="line"><a name="l00716"></a><span class="lineno"> 716</span> }</div></div><!-- fragment --> </div> </div> <a id="a2f1958f5d16f237b02599b7222c6d1ba"></a> @@ -319,7 +319,7 @@ template<class CompletionRoutine > </div> </dd> </dl> <dl class="section user"><dt>Errors returnable</dt><dd>Any of the values POSIX open() or CreateFile() can return. </dd></dl> -<div class="fragment"><div class="line"><a name="l00639"></a><span class="lineno"> 639</span> {</div><div class="line"><a name="l00640"></a><span class="lineno"> 640</span>  <span class="keywordflow">return</span> <a class="code" href="classasync__file__handle.html#aa2c709be14026d9acf306b964bc83099">async_file_handle::async_file</a>(std::forward<decltype(service)>(service), std::forward<decltype(base)>(base), std::forward<decltype(_path)>(_path), std::forward<decltype(_mode)>(_mode), std::forward<decltype(_creation)>(_creation), std::forward<decltype(_caching)>(_caching),</div><div class="line"><a name="l00641"></a><span class="lineno"> 641</span>  std::forward<decltype(flags)>(flags));</div><div class="line"><a name="l00642"></a><span class="lineno"> 642</span> }</div><div class="ttc" id="classasync__file__handle_html_aa2c709be14026d9acf306b964bc83099"><div class="ttname"><a href="classasync__file__handle.html#aa2c709be14026d9acf306b964bc83099">async_file_handle::async_file</a></div><div class="ttdeci">static LLFIO_MAKE_FREE_FUNCTION LLFIO_HEADERS_ONLY_MEMFUNC_SPEC result< async_file_handle > async_file(io_service &service, const path_handle &base, path_view_type _path, mode _mode=mode::read, creation _creation=creation::open_existing, caching _caching=caching::only_metadata, flag flags=flag::none) noexcept</div><div class="ttdef"><b>Definition:</b> async_file_handle.hpp:138</div></div> +<div class="fragment"><div class="line"><a name="l00640"></a><span class="lineno"> 640</span> {</div><div class="line"><a name="l00641"></a><span class="lineno"> 641</span>  <span class="keywordflow">return</span> <a class="code" href="classasync__file__handle.html#aa2c709be14026d9acf306b964bc83099">async_file_handle::async_file</a>(std::forward<decltype(service)>(service), std::forward<decltype(base)>(base), std::forward<decltype(_path)>(_path), std::forward<decltype(_mode)>(_mode), std::forward<decltype(_creation)>(_creation), std::forward<decltype(_caching)>(_caching),</div><div class="line"><a name="l00642"></a><span class="lineno"> 642</span>  std::forward<decltype(flags)>(flags));</div><div class="line"><a name="l00643"></a><span class="lineno"> 643</span> }</div><div class="ttc" id="classasync__file__handle_html_aa2c709be14026d9acf306b964bc83099"><div class="ttname"><a href="classasync__file__handle.html#aa2c709be14026d9acf306b964bc83099">async_file_handle::async_file</a></div><div class="ttdeci">static LLFIO_MAKE_FREE_FUNCTION LLFIO_HEADERS_ONLY_MEMFUNC_SPEC result< async_file_handle > async_file(io_service &service, const path_handle &base, path_view_type _path, mode _mode=mode::read, creation _creation=creation::open_existing, caching _caching=caching::only_metadata, flag flags=flag::none) noexcept</div><div class="ttdef"><b>Definition:</b> async_file_handle.hpp:138</div></div> </div><!-- fragment --> </div> </div> @@ -376,7 +376,7 @@ template<class CompletionRoutine > </div> </div><div class="memdoc"> <p>Create an async file handle creating a randomly named file on a path. The file is opened exclusively with <code>creation::only_if_not_exist</code> so it will never collide with nor overwrite any existing file.</p> <dl class="section user"><dt>Errors returnable</dt><dd>Any of the values POSIX open() or CreateFile() can return. </dd></dl> -<div class="fragment"><div class="line"><a name="l00650"></a><span class="lineno"> 650</span> {</div><div class="line"><a name="l00651"></a><span class="lineno"> 651</span>  <span class="keywordflow">return</span> <a class="code" href="classasync__file__handle.html#a5055bafbff7e2277e836b10d5173f674">async_file_handle::async_random_file</a>(std::forward<decltype(service)>(service), std::forward<decltype(dirpath)>(dirpath), std::forward<decltype(_mode)>(_mode), std::forward<decltype(_caching)>(_caching), std::forward<decltype(flags)>(flags));</div><div class="line"><a name="l00652"></a><span class="lineno"> 652</span> }</div><div class="ttc" id="classasync__file__handle_html_a5055bafbff7e2277e836b10d5173f674"><div class="ttname"><a href="classasync__file__handle.html#a5055bafbff7e2277e836b10d5173f674">async_file_handle::async_random_file</a></div><div class="ttdeci">static LLFIO_MAKE_FREE_FUNCTION result< async_file_handle > async_random_file(io_service &service, const path_handle &dirpath, mode _mode=mode::write, caching _caching=caching::only_metadata, flag flags=flag::none) noexcept</div><div class="ttdef"><b>Definition:</b> async_file_handle.hpp:154</div></div> +<div class="fragment"><div class="line"><a name="l00651"></a><span class="lineno"> 651</span> {</div><div class="line"><a name="l00652"></a><span class="lineno"> 652</span>  <span class="keywordflow">return</span> <a class="code" href="classasync__file__handle.html#a5055bafbff7e2277e836b10d5173f674">async_file_handle::async_random_file</a>(std::forward<decltype(service)>(service), std::forward<decltype(dirpath)>(dirpath), std::forward<decltype(_mode)>(_mode), std::forward<decltype(_caching)>(_caching), std::forward<decltype(flags)>(flags));</div><div class="line"><a name="l00653"></a><span class="lineno"> 653</span> }</div><div class="ttc" id="classasync__file__handle_html_a5055bafbff7e2277e836b10d5173f674"><div class="ttname"><a href="classasync__file__handle.html#a5055bafbff7e2277e836b10d5173f674">async_file_handle::async_random_file</a></div><div class="ttdeci">static LLFIO_MAKE_FREE_FUNCTION result< async_file_handle > async_random_file(io_service &service, const path_handle &dirpath, mode _mode=mode::write, caching _caching=caching::only_metadata, flag flags=flag::none) noexcept</div><div class="ttdef"><b>Definition:</b> async_file_handle.hpp:154</div></div> </div><!-- fragment --> </div> </div> @@ -442,7 +442,7 @@ template<class CompletionRoutine > </div> </dl> <dl class="section user"><dt>Errors returnable</dt><dd>As for <code>read()</code>, plus <code>ENOMEM</code>. </dd></dl> <dl class="section user"><dt>Memory Allocations</dt><dd>If mem is not set, one calloc, one free. The allocation is unavoidable due to the need to store a type erased completion handler of unknown type and state per buffers input. </dd></dl> -<div class="fragment"><div class="line"><a name="l00734"></a><span class="lineno"> 734</span>  {}) noexcept</div><div class="line"><a name="l00735"></a><span class="lineno"> 735</span> {</div><div class="line"><a name="l00736"></a><span class="lineno"> 736</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.async_read(std::forward<decltype(reqs)>(reqs), std::forward<decltype(completion)>(completion), std::forward<decltype(mem)>(mem));</div><div class="line"><a name="l00737"></a><span class="lineno"> 737</span> }</div></div><!-- fragment --> +<div class="fragment"><div class="line"><a name="l00735"></a><span class="lineno"> 735</span>  {}) noexcept</div><div class="line"><a name="l00736"></a><span class="lineno"> 736</span> {</div><div class="line"><a name="l00737"></a><span class="lineno"> 737</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.async_read(std::forward<decltype(reqs)>(reqs), std::forward<decltype(completion)>(completion), std::forward<decltype(mem)>(mem));</div><div class="line"><a name="l00738"></a><span class="lineno"> 738</span> }</div></div><!-- fragment --> </div> </div> <a id="a4bb05fa6eadd5038b0ffca890f87acc0"></a> @@ -505,7 +505,7 @@ template<class CompletionRoutine > </div> <p>Create an async file handle creating the named file on some path which the OS declares to be suitable for temporary files. Most OSs are very lazy about flushing changes made to these temporary files. Note the default flags are to have the newly created file deleted on first handle close. Note also that an empty name is equivalent to calling <code>async_random_file(path_discovery::storage_backed_temporary_files_directory())</code> and the creation parameter is ignored.</p> <dl class="section note"><dt>Note</dt><dd>If the temporary file you are creating is not going to have its path sent to another process for usage, this is the WRONG function to use. Use <code>temp_inode()</code> instead, it is far more secure.</dd></dl> <dl class="section user"><dt>Errors returnable</dt><dd>Any of the values POSIX open() or CreateFile() can return. </dd></dl> -<div class="fragment"><div class="line"><a name="l00670"></a><span class="lineno"> 670</span> {</div><div class="line"><a name="l00671"></a><span class="lineno"> 671</span>  <span class="keywordflow">return</span> <a class="code" href="classasync__file__handle.html#a23be7dcb955f7f7396db3f723ba38971">async_file_handle::async_temp_file</a>(std::forward<decltype(service)>(service), std::forward<decltype(name)>(name), std::forward<decltype(_mode)>(_mode), std::forward<decltype(_creation)>(_creation), std::forward<decltype(_caching)>(_caching), std::forward<decltype(flags)>(flags));</div><div class="line"><a name="l00672"></a><span class="lineno"> 672</span> }</div><div class="ttc" id="classasync__file__handle_html_a23be7dcb955f7f7396db3f723ba38971"><div class="ttname"><a href="classasync__file__handle.html#a23be7dcb955f7f7396db3f723ba38971">async_file_handle::async_temp_file</a></div><div class="ttdeci">static LLFIO_MAKE_FREE_FUNCTION result< async_file_handle > async_temp_file(io_service &service, path_view_type name=path_view_type(), mode _mode=mode::write, creation _creation=creation::if_needed, caching _caching=caching::only_metadata, flag flags=flag::unlink_on_first_close) noexcept</div><div class="ttdef"><b>Definition:</b> async_file_handle.hpp:190</div></div> +<div class="fragment"><div class="line"><a name="l00671"></a><span class="lineno"> 671</span> {</div><div class="line"><a name="l00672"></a><span class="lineno"> 672</span>  <span class="keywordflow">return</span> <a class="code" href="classasync__file__handle.html#a23be7dcb955f7f7396db3f723ba38971">async_file_handle::async_temp_file</a>(std::forward<decltype(service)>(service), std::forward<decltype(name)>(name), std::forward<decltype(_mode)>(_mode), std::forward<decltype(_creation)>(_creation), std::forward<decltype(_caching)>(_caching), std::forward<decltype(flags)>(flags));</div><div class="line"><a name="l00673"></a><span class="lineno"> 673</span> }</div><div class="ttc" id="classasync__file__handle_html_a23be7dcb955f7f7396db3f723ba38971"><div class="ttname"><a href="classasync__file__handle.html#a23be7dcb955f7f7396db3f723ba38971">async_file_handle::async_temp_file</a></div><div class="ttdeci">static LLFIO_MAKE_FREE_FUNCTION result< async_file_handle > async_temp_file(io_service &service, path_view_type name=path_view_type(), mode _mode=mode::write, creation _creation=creation::if_needed, caching _caching=caching::only_metadata, flag flags=flag::unlink_on_first_close) noexcept</div><div class="ttdef"><b>Definition:</b> async_file_handle.hpp:190</div></div> </div><!-- fragment --> </div> </div> @@ -556,7 +556,7 @@ template<class CompletionRoutine > </div> </div><div class="memdoc"> <p><em>Securely</em> create an async file handle creating a temporary anonymous inode in the filesystem referred to by <em>dirpath</em>. The inode created has no name nor accessible path on the filing system and ceases to exist as soon as the last handle is closed, making it ideal for use as a temporary file where other processes do not need to have access to its contents via some path on the filing system (a classic use case is for backing shared memory maps).</p> <dl class="section user"><dt>Errors returnable</dt><dd>Any of the values POSIX open() or CreateFile() can return. </dd></dl> -<div class="fragment"><div class="line"><a name="l00684"></a><span class="lineno"> 684</span> {</div><div class="line"><a name="l00685"></a><span class="lineno"> 685</span>  <span class="keywordflow">return</span> <a class="code" href="classasync__file__handle.html#a823ff9a0f930eb5d696127283a44fa82">async_file_handle::async_temp_inode</a>(std::forward<decltype(service)>(service), std::forward<decltype(dir)>(dir), std::forward<decltype(_mode)>(_mode), std::forward<decltype(flags)>(flags));</div><div class="line"><a name="l00686"></a><span class="lineno"> 686</span> }</div><div class="ttc" id="classasync__file__handle_html_a823ff9a0f930eb5d696127283a44fa82"><div class="ttname"><a href="classasync__file__handle.html#a823ff9a0f930eb5d696127283a44fa82">async_file_handle::async_temp_inode</a></div><div class="ttdeci">static LLFIO_MAKE_FREE_FUNCTION LLFIO_HEADERS_ONLY_MEMFUNC_SPEC result< async_file_handle > async_temp_inode(io_service &service, const path_handle &dir=path_discovery::storage_backed_temporary_files_directory(), mode _mode=mode::write, flag flags=flag::none) noexcept</div><div class="ttdef"><b>Definition:</b> async_file_handle.hpp:206</div></div> +<div class="fragment"><div class="line"><a name="l00685"></a><span class="lineno"> 685</span> {</div><div class="line"><a name="l00686"></a><span class="lineno"> 686</span>  <span class="keywordflow">return</span> <a class="code" href="classasync__file__handle.html#a823ff9a0f930eb5d696127283a44fa82">async_file_handle::async_temp_inode</a>(std::forward<decltype(service)>(service), std::forward<decltype(dir)>(dir), std::forward<decltype(_mode)>(_mode), std::forward<decltype(flags)>(flags));</div><div class="line"><a name="l00687"></a><span class="lineno"> 687</span> }</div><div class="ttc" id="classasync__file__handle_html_a823ff9a0f930eb5d696127283a44fa82"><div class="ttname"><a href="classasync__file__handle.html#a823ff9a0f930eb5d696127283a44fa82">async_file_handle::async_temp_inode</a></div><div class="ttdeci">static LLFIO_MAKE_FREE_FUNCTION LLFIO_HEADERS_ONLY_MEMFUNC_SPEC result< async_file_handle > async_temp_inode(io_service &service, const path_handle &dir=path_discovery::storage_backed_temporary_files_directory(), mode _mode=mode::write, flag flags=flag::none) noexcept</div><div class="ttdef"><b>Definition:</b> async_file_handle.hpp:206</div></div> </div><!-- fragment --> </div> </div> @@ -622,7 +622,7 @@ template<class CompletionRoutine > </div> </dl> <dl class="section user"><dt>Errors returnable</dt><dd>As for <code>write()</code>, plus <code>ENOMEM</code>. </dd></dl> <dl class="section user"><dt>Memory Allocations</dt><dd>If mem in not set, one calloc, one free. The allocation is unavoidable due to the need to store a type erased completion handler of unknown type and state per buffers input. </dd></dl> -<div class="fragment"><div class="line"><a name="l00757"></a><span class="lineno"> 757</span>  {}) noexcept</div><div class="line"><a name="l00758"></a><span class="lineno"> 758</span> {</div><div class="line"><a name="l00759"></a><span class="lineno"> 759</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.async_write(std::forward<decltype(reqs)>(reqs), std::forward<decltype(completion)>(completion), std::forward<decltype(mem)>(mem));</div><div class="line"><a name="l00760"></a><span class="lineno"> 760</span> }</div></div><!-- fragment --> +<div class="fragment"><div class="line"><a name="l00758"></a><span class="lineno"> 758</span>  {}) noexcept</div><div class="line"><a name="l00759"></a><span class="lineno"> 759</span> {</div><div class="line"><a name="l00760"></a><span class="lineno"> 760</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.async_write(std::forward<decltype(reqs)>(reqs), std::forward<decltype(completion)>(completion), std::forward<decltype(mem)>(mem));</div><div class="line"><a name="l00761"></a><span class="lineno"> 761</span> }</div></div><!-- fragment --> </div> </div> <a id="adca2a1a80aae35f32f8c575db5d22215"></a> @@ -670,7 +670,7 @@ template<class CompletionRoutine > </div> </dl> <dl class="section user"><dt>Errors returnable</dt><dd>As for read(), plus ENOMEM. </dd></dl> <dl class="section user"><dt>Memory Allocations</dt><dd>One calloc, one free. </dd></dl> -<div class="fragment"><div class="line"><a name="l00775"></a><span class="lineno"> 775</span> {</div><div class="line"><a name="l00776"></a><span class="lineno"> 776</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.co_read(std::forward<decltype(reqs)>(reqs));</div><div class="line"><a name="l00777"></a><span class="lineno"> 777</span> }</div></div><!-- fragment --> +<div class="fragment"><div class="line"><a name="l00776"></a><span class="lineno"> 776</span> {</div><div class="line"><a name="l00777"></a><span class="lineno"> 777</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.co_read(std::forward<decltype(reqs)>(reqs));</div><div class="line"><a name="l00778"></a><span class="lineno"> 778</span> }</div></div><!-- fragment --> </div> </div> <a id="a6e58e89423ae965216b7034f436cb596"></a> @@ -713,7 +713,7 @@ template<class CompletionRoutine > </div> </table> </div><div class="memdoc"> <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> -<div class="fragment"><div class="line"><a name="l00780"></a><span class="lineno"> 780</span> {</div><div class="line"><a name="l00781"></a><span class="lineno"> 781</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.co_read(std::forward<decltype(offset)>(offset), std::forward<decltype(lst)>(lst));</div><div class="line"><a name="l00782"></a><span class="lineno"> 782</span> }</div></div><!-- fragment --> +<div class="fragment"><div class="line"><a name="l00781"></a><span class="lineno"> 781</span> {</div><div class="line"><a name="l00782"></a><span class="lineno"> 782</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.co_read(std::forward<decltype(offset)>(offset), std::forward<decltype(lst)>(lst));</div><div class="line"><a name="l00783"></a><span class="lineno"> 783</span> }</div></div><!-- fragment --> </div> </div> <a id="a5118170b546db016ecf8117f0d315923"></a> @@ -761,7 +761,7 @@ template<class CompletionRoutine > </div> </dl> <dl class="section user"><dt>Errors returnable</dt><dd>As for write(), plus ENOMEM. </dd></dl> <dl class="section user"><dt>Memory Allocations</dt><dd>One calloc, one free. </dd></dl> -<div class="fragment"><div class="line"><a name="l00795"></a><span class="lineno"> 795</span> {</div><div class="line"><a name="l00796"></a><span class="lineno"> 796</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.co_write(std::forward<decltype(reqs)>(reqs));</div><div class="line"><a name="l00797"></a><span class="lineno"> 797</span> }</div></div><!-- fragment --> +<div class="fragment"><div class="line"><a name="l00796"></a><span class="lineno"> 796</span> {</div><div class="line"><a name="l00797"></a><span class="lineno"> 797</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.co_write(std::forward<decltype(reqs)>(reqs));</div><div class="line"><a name="l00798"></a><span class="lineno"> 798</span> }</div></div><!-- fragment --> </div> </div> <a id="a8883262b133d4ac3f1c1a113b607bb3b"></a> @@ -804,7 +804,7 @@ template<class CompletionRoutine > </div> </table> </div><div class="memdoc"> <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> -<div class="fragment"><div class="line"><a name="l00800"></a><span class="lineno"> 800</span> {</div><div class="line"><a name="l00801"></a><span class="lineno"> 801</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.co_write(std::forward<decltype(offset)>(offset), std::forward<decltype(lst)>(lst));</div><div class="line"><a name="l00802"></a><span class="lineno"> 802</span> }</div></div><!-- fragment --> +<div class="fragment"><div class="line"><a name="l00801"></a><span class="lineno"> 801</span> {</div><div class="line"><a name="l00802"></a><span class="lineno"> 802</span>  <span class="keywordflow">return</span> <span class="keyword">self</span>.co_write(std::forward<decltype(offset)>(offset), std::forward<decltype(lst)>(lst));</div><div class="line"><a name="l00803"></a><span class="lineno"> 803</span> }</div></div><!-- fragment --> </div> </div> </div><!-- contents --> |