2021-04-10 04:00:37 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2017-09-20 02:35:05 +00:00
< 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" / >
2021-06-22 00:16:40 +00:00
< meta name = "generator" content = "Doxygen 1.8.17" / >
2018-02-10 23:37:42 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2017-09-20 02:35:05 +00:00
< title > Shaka Packager SDK: shaka::ThreadedIoFile 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 = "../../search/search.css" rel = "stylesheet" type = "text/css" / >
2018-02-10 23:37:42 +00:00
< script type = "text/javascript" src = "../../search/searchdata.js" > < / script >
2017-09-20 02:35:05 +00:00
< script type = "text/javascript" src = "../../search/search.js" > < / script >
< link href = "../../doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
2018-02-10 23:37:42 +00:00
< td id = "projectalign" style = "padding-left: 0.5em;" >
2017-09-20 02:35:05 +00:00
< div id = "projectname" > Shaka Packager SDK
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2021-06-22 00:16:40 +00:00
<!-- Generated by Doxygen 1.8.17 -->
2017-09-20 02:35:05 +00:00
< script type = "text/javascript" >
2021-04-10 04:00:37 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2021-06-22 00:16:40 +00:00
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
2021-04-10 04:00:37 +00:00
/* @license-end */
2017-09-20 02:35:05 +00:00
< / script >
2018-02-10 23:37:42 +00:00
< script type = "text/javascript" src = "../../menudata.js" > < / script >
< script type = "text/javascript" src = "../../menu.js" > < / script >
< script type = "text/javascript" >
2021-04-10 04:00:37 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2018-02-10 23:37:42 +00:00
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2021-04-10 04:00:37 +00:00
/* @license-end */< / script >
2018-02-10 23:37:42 +00:00
< div id = "main-nav" > < / div >
2017-09-20 02:35:05 +00:00
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
2018-02-10 23:37:42 +00:00
< / div >
2017-09-20 02:35:05 +00:00
<!-- 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 id = "nav-path" class = "navpath" >
< ul >
< li class = "navelem" > < a class = "el" href = "../../d8/daf/namespaceshaka.html" > shaka< / a > < / li > < li class = "navelem" > < a class = "el" href = "../../dd/d0c/classshaka_1_1ThreadedIoFile.html" > ThreadedIoFile< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-types" > Public Types< / a > |
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "#pro-methods" > Protected Member Functions< / a > |
< a href = "../../dd/d95/classshaka_1_1ThreadedIoFile-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > shaka::ThreadedIoFile Class Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > Declaration of class which implements a thread-safe circular buffer.
< a href = "../../dd/d0c/classshaka_1_1ThreadedIoFile.html#details" > More...< / a > < / p >
< p > < code > #include < < a class = "el" href = "../../d2/da6/threaded__io__file_8h_source.html" > threaded_io_file.h< / a > > < / code > < / p >
< div class = "dynheader" >
Inheritance diagram for shaka::ThreadedIoFile:< / div >
< div class = "dyncontent" >
< div class = "center" >
< img src = "../../dd/d0c/classshaka_1_1ThreadedIoFile.png" usemap = "#shaka::ThreadedIoFile_map" alt = "" / >
< map id = "shaka::ThreadedIoFile_map" name = "shaka::ThreadedIoFile_map" >
2021-04-10 04:00:37 +00:00
< area href = "../../d3/d73/classshaka_1_1File.html" title = "Define an abstract file interface." alt = "shaka::File" shape = "rect" coords = "0,0,136,24" / >
< / map >
< / div > < / div >
2017-09-20 02:35:05 +00:00
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-types" > < / a >
Public Types< / h2 > < / td > < / tr >
2021-06-22 00:16:40 +00:00
< tr class = "memitem:a891c11531b9d7110c725070e0a6cae2b" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a891c11531b9d7110c725070e0a6cae2b" > < / a > enum   < / td > < td class = "memItemRight" valign = "bottom" > < b > Mode< / b > { < b > kInputMode< / b > ,
< b > kOutputMode< / b >
2017-09-20 02:35:05 +00:00
}< / td > < / tr >
< tr class = "separator:a891c11531b9d7110c725070e0a6cae2b" > < 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 >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:aad6e00e2b1842e730047b5a0c1b85060" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "aad6e00e2b1842e730047b5a0c1b85060" > < / a >
2017-09-20 02:35:05 +00:00
  < / td > < td class = "memItemRight" valign = "bottom" > < b > ThreadedIoFile< / b > (std::unique_ptr< < a class = "el" href = "../../d3/d73/classshaka_1_1File.html" > File< / a > , < a class = "el" href = "../../d3/de2/structshaka_1_1FileCloser.html" > FileCloser< / a > > internal_file, Mode mode, uint64_t io_cache_size, uint64_t io_block_size)< / td > < / tr >
< tr class = "separator:aad6e00e2b1842e730047b5a0c1b85060" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr > < td colspan = "2" > < div class = "groupHeader" > File implementation overrides.< / div > < / td > < / tr >
< tr class = "memitem:a79292b93c39f609b5348787a39fc77b2" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a79292b93c39f609b5348787a39fc77b2" > Close< / a > () override< / td > < / tr >
< tr class = "separator:a79292b93c39f609b5348787a39fc77b2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:af45702d95d4e46e93b1f4a897844212e" > < td class = "memItemLeft" align = "right" valign = "top" > int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../dd/d0c/classshaka_1_1ThreadedIoFile.html#af45702d95d4e46e93b1f4a897844212e" > Read< / a > (void *buffer, uint64_t length) override< / td > < / tr >
< tr class = "separator:af45702d95d4e46e93b1f4a897844212e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab8acfe4af14c1120ae6d2baa44a10583" > < td class = "memItemLeft" align = "right" valign = "top" > int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../dd/d0c/classshaka_1_1ThreadedIoFile.html#ab8acfe4af14c1120ae6d2baa44a10583" > Write< / a > (const void *buffer, uint64_t length) override< / td > < / tr >
< tr class = "separator:ab8acfe4af14c1120ae6d2baa44a10583" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:af23f2da404e1602c240bb59d2601f1b9" > < td class = "memItemLeft" align = "right" valign = "top" > int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../dd/d0c/classshaka_1_1ThreadedIoFile.html#af23f2da404e1602c240bb59d2601f1b9" > Size< / a > () override< / td > < / tr >
< tr class = "separator:af23f2da404e1602c240bb59d2601f1b9" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a2b53b72d99aad4439781e3887492452c" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a2b53b72d99aad4439781e3887492452c" > Flush< / a > () override< / td > < / tr >
< tr class = "separator:a2b53b72d99aad4439781e3887492452c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a9b95550cf6342f970645c086a2ed58c2" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a9b95550cf6342f970645c086a2ed58c2" > Seek< / a > (uint64_t position) override< / td > < / tr >
< tr class = "separator:a9b95550cf6342f970645c086a2ed58c2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a6ee5bcbe6bb8dd232679b2c50d968f4e" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a6ee5bcbe6bb8dd232679b2c50d968f4e" > Tell< / a > (uint64_t *position) override< / td > < / tr >
< tr class = "separator:a6ee5bcbe6bb8dd232679b2c50d968f4e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "inherit_header pub_methods_classshaka_1_1File" > < td colspan = "2" onclick = "javascript:toggleInherit('pub_methods_classshaka_1_1File')" > < img src = "../../closed.png" alt = "-" / >   Public Member Functions inherited from < a class = "el" href = "../../d3/d73/classshaka_1_1File.html" > shaka::File< / a > < / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:a4b06e08bb0295cb89fca45f9356ecbae inherit pub_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > const std::string &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae" > file_name< / a > () const< / td > < / tr >
< tr class = "separator:a4b06e08bb0295cb89fca45f9356ecbae inherit pub_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-09-20 02:35:05 +00:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pro-methods" > < / a >
Protected Member Functions< / h2 > < / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:a353eb138e2f23f4e75c8c56580050aa0" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a353eb138e2f23f4e75c8c56580050aa0" > < / a >
2017-09-20 02:35:05 +00:00
bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a353eb138e2f23f4e75c8c56580050aa0" > Open< / a > () override< / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memdesc:a353eb138e2f23f4e75c8c56580050aa0" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Internal open. Should not be used directly. < br / > < / td > < / tr >
2017-09-20 02:35:05 +00:00
< tr class = "separator:a353eb138e2f23f4e75c8c56580050aa0" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "inherit_header pro_methods_classshaka_1_1File" > < td colspan = "2" onclick = "javascript:toggleInherit('pro_methods_classshaka_1_1File')" > < img src = "../../closed.png" alt = "-" / >   Protected Member Functions inherited from < a class = "el" href = "../../d3/d73/classshaka_1_1File.html" > shaka::File< / a > < / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:a33ead01d4090de618937d4e989a9f27f inherit pro_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a33ead01d4090de618937d4e989a9f27f" > < / a >
  < / td > < td class = "memItemRight" valign = "bottom" > < b > File< / b > (const std::string & < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae" > file_name< / a > )< / td > < / tr >
2017-09-20 02:35:05 +00:00
< tr class = "separator:a33ead01d4090de618937d4e989a9f27f inherit pro_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a92d1a67d1560a5290eb36447c50fabf9 inherit pro_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > virtual  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a92d1a67d1560a5290eb36447c50fabf9" > ~File< / a > ()< / td > < / tr >
< tr class = "separator:a92d1a67d1560a5290eb36447c50fabf9 inherit pro_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "inherited" > < / a >
Additional Inherited Members< / h2 > < / td > < / tr >
< tr class = "inherit_header pub_static_methods_classshaka_1_1File" > < td colspan = "2" onclick = "javascript:toggleInherit('pub_static_methods_classshaka_1_1File')" > < img src = "../../closed.png" alt = "-" / >   Static Public Member Functions inherited from < a class = "el" href = "../../d3/d73/classshaka_1_1File.html" > shaka::File< / a > < / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:ac7b5143f9b8c3e786762fe4ada2b8dcf inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "../../d3/d73/classshaka_1_1File.html" > File< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#ac7b5143f9b8c3e786762fe4ada2b8dcf" > Open< / a > (const char *< a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae" > file_name< / a > , const char *mode)< / td > < / tr >
2017-09-20 02:35:05 +00:00
< tr class = "separator:ac7b5143f9b8c3e786762fe4ada2b8dcf inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:a0a50526352bd6e946c4f33d3e8431b2d inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "../../d3/d73/classshaka_1_1File.html" > File< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a0a50526352bd6e946c4f33d3e8431b2d" > OpenWithNoBuffering< / a > (const char *< a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae" > file_name< / a > , const char *mode)< / td > < / tr >
2017-09-20 02:35:05 +00:00
< tr class = "separator:a0a50526352bd6e946c4f33d3e8431b2d inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:a383c9f670511961f334569fd1a7a103b inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a383c9f670511961f334569fd1a7a103b" > Delete< / a > (const char *< a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae" > file_name< / a > )< / td > < / tr >
2017-09-20 02:35:05 +00:00
< tr class = "separator:a383c9f670511961f334569fd1a7a103b inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:ac978d5c0585850d4d9948fdf39b33292 inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#ac978d5c0585850d4d9948fdf39b33292" > GetFileSize< / a > (const char *< a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae" > file_name< / a > )< / td > < / tr >
2017-09-20 02:35:05 +00:00
< tr class = "separator:ac978d5c0585850d4d9948fdf39b33292 inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:ac9a19cb5fc45664ca440996bf1201c30 inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#ac9a19cb5fc45664ca440996bf1201c30" > ReadFileToString< / a > (const char *< a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae" > file_name< / a > , std::string *contents)< / td > < / tr >
2017-09-20 02:35:05 +00:00
< tr class = "separator:ac9a19cb5fc45664ca440996bf1201c30 inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:a483ce187d628385d342748315d72f8ab inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a483ce187d628385d342748315d72f8ab" > WriteStringToFile< / a > (const char *< a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae" > file_name< / a > , const std::string & contents)< / td > < / tr >
2017-09-20 02:35:05 +00:00
< tr class = "separator:a483ce187d628385d342748315d72f8ab inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2018-02-10 23:37:42 +00:00
< tr class = "memitem:a4b5280fe058359b5991037f90dde2b77 inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a4b5280fe058359b5991037f90dde2b77" > WriteFileAtomically< / a > (const char *< a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae" > file_name< / a > , const std::string & contents)< / td > < / tr >
2017-09-20 02:35:05 +00:00
< tr class = "separator:a4b5280fe058359b5991037f90dde2b77 inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:af2cbec5c6dc1c97ada010acd83b9728a inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#af2cbec5c6dc1c97ada010acd83b9728a" > Copy< / a > (const char *from_file_name, const char *to_file_name)< / td > < / tr >
< tr class = "separator:af2cbec5c6dc1c97ada010acd83b9728a inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a85633ec9f051eb9f32b07ff7e7740d1c inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a85633ec9f051eb9f32b07ff7e7740d1c" > CopyFile< / a > (< a class = "el" href = "../../d3/d73/classshaka_1_1File.html" > File< / a > *source, < a class = "el" href = "../../d3/d73/classshaka_1_1File.html" > File< / a > *destination)< / td > < / tr >
< tr class = "separator:a85633ec9f051eb9f32b07ff7e7740d1c inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a07e2d2f98597320f71fb96dff74cfcb2 inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a07e2d2f98597320f71fb96dff74cfcb2" > CopyFile< / a > (< a class = "el" href = "../../d3/d73/classshaka_1_1File.html" > File< / a > *source, < a class = "el" href = "../../d3/d73/classshaka_1_1File.html" > File< / a > *destination, int64_t max_copy)< / td > < / tr >
< tr class = "separator:a07e2d2f98597320f71fb96dff74cfcb2 inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2020-01-22 00:59:16 +00:00
< tr class = "memitem:a8eb71689f5456ba0b1a401c57386caaf inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a8eb71689f5456ba0b1a401c57386caaf" > IsLocalRegularFile< / a > (const char *< a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae" > file_name< / a > )< / td > < / tr >
< tr class = "separator:a8eb71689f5456ba0b1a401c57386caaf inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-09-20 02:35:05 +00:00
< tr class = "memitem:a7a90ebd27f7728a7075cf3ba97396cae inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static std::string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a7a90ebd27f7728a7075cf3ba97396cae" > MakeCallbackFileName< / a > (const < a class = "el" href = "../../d9/da8/structshaka_1_1BufferCallbackParams.html" > BufferCallbackParams< / a > & callback_params, const std::string & name)< / td > < / tr >
< tr class = "separator:a7a90ebd27f7728a7075cf3ba97396cae inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ae87642f9661588e47479721cd101bf7d inherit pub_static_methods_classshaka_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#ae87642f9661588e47479721cd101bf7d" > ParseCallbackFileName< / a > (const std::string & callback_file_name, const < a class = "el" href = "../../d9/da8/structshaka_1_1BufferCallbackParams.html" > BufferCallbackParams< / a > **callback_params, std::string *name)< / td > < / tr >
< tr class = "separator:ae87642f9661588e47479721cd101bf7d inherit pub_static_methods_classshaka_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > Declaration of class which implements a thread-safe circular buffer. < / p >
2018-02-10 23:37:42 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d2/da6/threaded__io__file_8h_source.html#l00020" > 20< / a > of file < a class = "el" href = "../../d2/da6/threaded__io__file_8h_source.html" > threaded_io_file.h< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
2018-02-10 23:37:42 +00:00
< a id = "a79292b93c39f609b5348787a39fc77b2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a79292b93c39f609b5348787a39fc77b2" > ◆ < / a > < / span > Close()< / h2 >
2017-09-20 02:35:05 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > bool shaka::ThreadedIoFile::Close < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2021-04-10 04:00:37 +00:00
< p > < a class = "el" href = "../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a2b53b72d99aad4439781e3887492452c" > Flush()< / a > and de-allocate resources associated with this file, and delete this < a class = "el" href = "../../d3/d73/classshaka_1_1File.html" title = "Define an abstract file interface." > File< / a > object. THIS IS THE ONE TRUE WAY TO DEALLOCATE THIS OBJECT. < / p > < dl class = "section return" > < dt > Returns< / dt > < dd > true on success. For writable files, returning false MAY INDICATE DATA LOSS. < / dd > < / dl >
2017-09-20 02:35:05 +00:00
< p > Implements < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a932666ed1d6a565bf387a9d8b39a8948" > shaka::File< / a > .< / p >
2018-08-16 00:35:22 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00055" > 55< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div >
< / div >
2018-02-10 23:37:42 +00:00
< a id = "a2b53b72d99aad4439781e3887492452c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a2b53b72d99aad4439781e3887492452c" > ◆ < / a > < / span > Flush()< / h2 >
2017-09-20 02:35:05 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > bool shaka::ThreadedIoFile::Flush < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2021-04-10 04:00:37 +00:00
< p > Flush the file so that recently written data will survive an application crash (but not necessarily an OS crash). For instance, in < a class = "el" href = "../../d7/dbd/classshaka_1_1LocalFile.html" title = "Implement LocalFile which deals with local storage." > LocalFile< / a > the data is flushed into the OS but not necessarily to disk. < / p > < dl class = "section return" > < dt > Returns< / dt > < dd > true on success, false otherwise. < / dd > < / dl >
2017-09-20 02:35:05 +00:00
< p > Implements < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a5fa625751e03b9e7652ba1bfa98b8ca4" > shaka::File< / a > .< / p >
2018-08-16 00:35:22 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00107" > 107< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div >
< / div >
2018-02-10 23:37:42 +00:00
< a id = "af45702d95d4e46e93b1f4a897844212e" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#af45702d95d4e46e93b1f4a897844212e" > ◆ < / a > < / span > Read()< / h2 >
2017-09-20 02:35:05 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > int64_t shaka::ThreadedIoFile::Read < / td >
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > buffer< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint64_t  < / td >
< td class = "paramname" > < em > length< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2018-02-10 23:37:42 +00:00
< p > Read data and return it in buffer. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
2017-09-20 02:35:05 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [out]< / td > < td class = "paramname" > buffer< / td > < td > points to a block of memory with a size of at least < em > length< / em > bytes. < / td > < / tr >
< tr > < td class = "paramdir" > < / td > < td class = "paramname" > length< / td > < td > indicates number of bytes to be read. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > Number of bytes read, or a value < 0 on error. Zero on end-of-file, or if 'length' is zero. < / dd > < / dl >
< p > Implements < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a6e1ecb2904b609554d332290f20fde0a" > shaka::File< / a > .< / p >
2018-08-16 00:35:22 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00070" > 70< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div >
< / div >
2018-02-10 23:37:42 +00:00
< a id = "a9b95550cf6342f970645c086a2ed58c2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a9b95550cf6342f970645c086a2ed58c2" > ◆ < / a > < / span > Seek()< / h2 >
2017-09-20 02:35:05 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > bool shaka::ThreadedIoFile::Seek < / td >
< td > (< / td >
< td class = "paramtype" > uint64_t  < / td >
< td class = "paramname" > < em > position< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2018-02-10 23:37:42 +00:00
< p > Seek to the specifield position in the file. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
2017-09-20 02:35:05 +00:00
< table class = "params" >
< tr > < td class = "paramname" > position< / td > < td > is the position to seek to. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > true on success, false otherwise. < / dd > < / dl >
< p > Implements < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a486bda715b58b1a1863fbfc8d48da62a" > shaka::File< / a > .< / p >
2018-08-16 00:35:22 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00120" > 120< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div >
< / div >
2018-02-10 23:37:42 +00:00
< a id = "af23f2da404e1602c240bb59d2601f1b9" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#af23f2da404e1602c240bb59d2601f1b9" > ◆ < / a > < / span > Size()< / h2 >
2017-09-20 02:35:05 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > int64_t shaka::ThreadedIoFile::Size < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "section return" > < dt > Returns< / dt > < dd > Size of the file in bytes. A return value less than zero indicates a problem getting the size. < / dd > < / dl >
< p > Implements < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#aeb98b64a05f141140e110170bef1bc55" > shaka::File< / a > .< / p >
2018-08-16 00:35:22 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00101" > 101< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div >
< / div >
2018-02-10 23:37:42 +00:00
< a id = "a6ee5bcbe6bb8dd232679b2c50d968f4e" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a6ee5bcbe6bb8dd232679b2c50d968f4e" > ◆ < / a > < / span > Tell()< / h2 >
2017-09-20 02:35:05 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > bool shaka::ThreadedIoFile::Tell < / td >
< td > (< / td >
< td class = "paramtype" > uint64_t *  < / td >
< td class = "paramname" > < em > position< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2018-02-10 23:37:42 +00:00
< p > Get the current file position. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
2017-09-20 02:35:05 +00:00
< table class = "params" >
< tr > < td class = "paramname" > position< / td > < td > is a pointer to contain the current file position upon successful return. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > true on succcess, false otherwise. < / dd > < / dl >
< p > Implements < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a07ae6476e88dab6c0cd9d8c0073b667d" > shaka::File< / a > .< / p >
2018-08-16 00:35:22 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00152" > 152< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div >
< / div >
2018-02-10 23:37:42 +00:00
< a id = "ab8acfe4af14c1120ae6d2baa44a10583" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab8acfe4af14c1120ae6d2baa44a10583" > ◆ < / a > < / span > Write()< / h2 >
2017-09-20 02:35:05 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > int64_t shaka::ThreadedIoFile::Write < / td >
< td > (< / td >
< td class = "paramtype" > const void *  < / td >
< td class = "paramname" > < em > buffer< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint64_t  < / td >
< td class = "paramname" > < em > length< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2018-02-10 23:37:42 +00:00
< p > Write block of data. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
2017-09-20 02:35:05 +00:00
< table class = "params" >
< tr > < td class = "paramname" > buffer< / td > < td > points to a block of memory with at least < em > length< / em > bytes. < / td > < / tr >
< tr > < td class = "paramname" > length< / td > < td > indicates number of bytes to write. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > Number of bytes written, or a value < 0 on error. < / dd > < / dl >
< p > Implements < a class = "el" href = "../../d3/d73/classshaka_1_1File.html#a8c498531ecbd205fceb0be3478361801" > shaka::File< / a > .< / p >
2018-08-16 00:35:22 +00:00
< p class = "definition" > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00086" > 86< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2017-09-20 02:35:05 +00:00
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
< li > packager/file/< a class = "el" href = "../../d2/da6/threaded__io__file_8h_source.html" > threaded_io_file.h< / a > < / li >
< li > packager/file/< a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > < / li >
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2021-06-22 00:16:40 +00:00
Generated on Tue Jun 22 2021 00:16:05 for Shaka Packager SDK by   < a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "../../doxygen.png" alt = "doxygen" / >
< / a > 1.8.17
2017-09-20 02:35:05 +00:00
< / small > < / address >
< / body >
< / html >
