2015-10-16 00:33:37 +00:00
<!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.6" / >
2016-05-24 23:43:16 +00:00
< title > DASH Media Packaging SDK: shaka::media::ThreadedIoFile Class Reference< / title >
2015-10-16 00:33:37 +00:00
< 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" / >
< 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" > DASH Media Packaging SDK
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
< 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 = "../../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 >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
2016-05-11 18:03:07 +00:00
< 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 > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Typedefs< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < / div >
2015-10-16 00:33:37 +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 >
2016-05-24 23:43:16 +00:00
< li class = "navelem" > < a class = "el" href = "../../d8/daf/namespaceshaka.html" > shaka< / a > < / li > < li class = "navelem" > < b > media< / b > < / li > < li class = "navelem" > < a class = "el" href = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html" > ThreadedIoFile< / a > < / li > < / ul >
2015-10-16 00:33:37 +00:00
< / 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 > |
2016-05-24 23:43:16 +00:00
< a href = "../../df/d46/classshaka_1_1media_1_1ThreadedIoFile-members.html" > List of all members< / a > < / div >
2015-10-16 00:33:37 +00:00
< div class = "headertitle" >
2016-05-24 23:43:16 +00:00
< div class = "title" > shaka::media::ThreadedIoFile Class Reference< / div > < / div >
2015-10-16 00:33:37 +00:00
< / div > <!-- header -->
< div class = "contents" >
< p > Declaration of class which implements a thread-safe circular buffer.
2016-05-24 23:43:16 +00:00
< a href = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#details" > More...< / a > < / p >
2015-10-16 00:33:37 +00:00
< 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" >
2016-05-24 23:43:16 +00:00
Inheritance diagram for shaka::media::ThreadedIoFile:< / div >
2015-10-16 00:33:37 +00:00
< div class = "dyncontent" >
< div class = "center" >
2016-05-24 23:43:16 +00:00
< img src = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.png" usemap = "#shaka::media::ThreadedIoFile_map" alt = "" / >
< map id = "shaka::media::ThreadedIoFile_map" name = "shaka::media::ThreadedIoFile_map" >
< area href = "../../d3/d61/classshaka_1_1media_1_1File.html" title = "Define an abstract file interface. " alt = "shaka::media::File" shape = "rect" coords = "0,0,175,24" / >
2015-10-16 00:33:37 +00:00
< / map >
< / div > < / div >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-types" > < / a >
Public Types< / h2 > < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "memitem:a831d16b60c49ad379f4eb23d0d50e6ba" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < b > Mode< / b > { < b > kInputMode< / b > ,
2015-10-16 00:33:37 +00:00
< b > kOutputMode< / b >
}< / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "separator:a831d16b60c49ad379f4eb23d0d50e6ba" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-10-16 00:33:37 +00:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
2016-08-19 00:58:26 +00:00
< tr class = "memitem:a3ddd3e2e5297cbe02c8bb0e030e1612f" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a3ddd3e2e5297cbe02c8bb0e030e1612f" > < / a >
  < / td > < td class = "memItemRight" valign = "bottom" > < b > ThreadedIoFile< / b > (std::unique_ptr< < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html" > File< / a > , < a class = "el" href = "../../d3/d8b/structshaka_1_1media_1_1FileCloser.html" > FileCloser< / a > > internal_file, Mode mode, uint64_t io_cache_size, uint64_t io_block_size)< / td > < / tr >
< tr class = "separator:a3ddd3e2e5297cbe02c8bb0e030e1612f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-10-16 00:33:37 +00:00
< tr > < td colspan = "2" > < div class = "groupHeader" > File implementation overrides.< / div > < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "memitem:a4a85d185a7eaa1abc857540ef703ab9a" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#a4a85d185a7eaa1abc857540ef703ab9a" > Close< / a > () override< / td > < / tr >
< tr class = "separator:a4a85d185a7eaa1abc857540ef703ab9a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a5bd05e37779441004cd7ba0c33de1ad6" > < td class = "memItemLeft" align = "right" valign = "top" > int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#a5bd05e37779441004cd7ba0c33de1ad6" > Read< / a > (void *buffer, uint64_t length) override< / td > < / tr >
< tr class = "separator:a5bd05e37779441004cd7ba0c33de1ad6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aa14502dd48c1c64329283f5f1340f60f" > < td class = "memItemLeft" align = "right" valign = "top" > int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#aa14502dd48c1c64329283f5f1340f60f" > Write< / a > (const void *buffer, uint64_t length) override< / td > < / tr >
< tr class = "separator:aa14502dd48c1c64329283f5f1340f60f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ac8c1f49d9e7ff55b1484129240c065f3" > < td class = "memItemLeft" align = "right" valign = "top" > int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#ac8c1f49d9e7ff55b1484129240c065f3" > Size< / a > () override< / td > < / tr >
< tr class = "separator:ac8c1f49d9e7ff55b1484129240c065f3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a4c8d46b1a16fba8bf4267c0a11fa856e" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#a4c8d46b1a16fba8bf4267c0a11fa856e" > Flush< / a > () override< / td > < / tr >
< tr class = "separator:a4c8d46b1a16fba8bf4267c0a11fa856e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a4a30faf9c8e8b367bcfebb7b642d73e7" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#a4a30faf9c8e8b367bcfebb7b642d73e7" > Seek< / a > (uint64_t position) override< / td > < / tr >
< tr class = "separator:a4a30faf9c8e8b367bcfebb7b642d73e7" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a23949d75527c8de9f02e749c7744f11e" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#a23949d75527c8de9f02e749c7744f11e" > Tell< / a > (uint64_t *position) override< / td > < / tr >
< tr class = "separator:a23949d75527c8de9f02e749c7744f11e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "inherit_header pub_methods_classshaka_1_1media_1_1File" > < td colspan = "2" onclick = "javascript:toggleInherit('pub_methods_classshaka_1_1media_1_1File')" > < img src = "../../closed.png" alt = "-" / >   Public Member Functions inherited from < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html" > shaka::media::File< / a > < / td > < / tr >
< tr class = "memitem:abe158b9e7b1e073956a16c55a8fcf5f4 inherit pub_methods_classshaka_1_1media_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > const std::string &   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4" > file_name< / a > () const < / td > < / tr >
< tr class = "separator:abe158b9e7b1e073956a16c55a8fcf5f4 inherit pub_methods_classshaka_1_1media_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-10-16 00:33:37 +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 >
2016-05-24 23:43:16 +00:00
< tr class = "memitem:ae3db248116be393b18d70bb27f6aeb68" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ae3db248116be393b18d70bb27f6aeb68" > < / a >
bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#ae3db248116be393b18d70bb27f6aeb68" > Open< / a > () override< / td > < / tr >
< tr class = "memdesc:ae3db248116be393b18d70bb27f6aeb68" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Internal open. Should not be used directly. < br / > < / td > < / tr >
< tr class = "separator:ae3db248116be393b18d70bb27f6aeb68" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "inherit_header pro_methods_classshaka_1_1media_1_1File" > < td colspan = "2" onclick = "javascript:toggleInherit('pro_methods_classshaka_1_1media_1_1File')" > < img src = "../../closed.png" alt = "-" / >   Protected Member Functions inherited from < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html" > shaka::media::File< / a > < / td > < / tr >
< tr class = "memitem:a476502e5ab3eaed4427fd3b8468211ce inherit pro_methods_classshaka_1_1media_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a476502e5ab3eaed4427fd3b8468211ce" > < / a >
  < / td > < td class = "memItemRight" valign = "bottom" > < b > File< / b > (const std::string & < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4" > file_name< / a > )< / td > < / tr >
< tr class = "separator:a476502e5ab3eaed4427fd3b8468211ce inherit pro_methods_classshaka_1_1media_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aeb5c0673c6d8120d636385a1ad3b3f71 inherit pro_methods_classshaka_1_1media_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > virtual  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#aeb5c0673c6d8120d636385a1ad3b3f71" > ~File< / a > ()< / td > < / tr >
< tr class = "separator:aeb5c0673c6d8120d636385a1ad3b3f71 inherit pro_methods_classshaka_1_1media_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-10-16 00:33:37 +00:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "inherited" > < / a >
Additional Inherited Members< / h2 > < / td > < / tr >
2016-05-24 23:43:16 +00:00
< tr class = "inherit_header pub_static_methods_classshaka_1_1media_1_1File" > < td colspan = "2" onclick = "javascript:toggleInherit('pub_static_methods_classshaka_1_1media_1_1File')" > < img src = "../../closed.png" alt = "-" / >   Static Public Member Functions inherited from < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html" > shaka::media::File< / a > < / td > < / tr >
< tr class = "memitem:a921efa1c8f7978e3b5aac33d648b0250 inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html" > File< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#a921efa1c8f7978e3b5aac33d648b0250" > Open< / a > (const char *< a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4" > file_name< / a > , const char *mode)< / td > < / tr >
< tr class = "separator:a921efa1c8f7978e3b5aac33d648b0250 inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad1e9fc834093c8b35c0f8c1957974fda inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html" > File< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#ad1e9fc834093c8b35c0f8c1957974fda" > OpenWithNoBuffering< / a > (const char *< a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4" > file_name< / a > , const char *mode)< / td > < / tr >
< tr class = "separator:ad1e9fc834093c8b35c0f8c1957974fda inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a92cdfd68e6384dfcc14c78b20c98368e inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#a92cdfd68e6384dfcc14c78b20c98368e" > Delete< / a > (const char *< a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4" > file_name< / a > )< / td > < / tr >
< tr class = "separator:a92cdfd68e6384dfcc14c78b20c98368e inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a6981994874ee5832e3394744fd51fd79 inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#a6981994874ee5832e3394744fd51fd79" > GetFileSize< / a > (const char *< a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4" > file_name< / a > )< / td > < / tr >
< tr class = "separator:a6981994874ee5832e3394744fd51fd79 inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a622dbc8abacebb40b816aa0174ba7c60 inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#a622dbc8abacebb40b816aa0174ba7c60" > ReadFileToString< / a > (const char *< a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4" > file_name< / a > , std::string *contents)< / td > < / tr >
< tr class = "separator:a622dbc8abacebb40b816aa0174ba7c60 inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:afacdff207ba8359eaa029d8b1414c641 inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#afacdff207ba8359eaa029d8b1414c641" > Copy< / a > (const char *from_file_name, const char *to_file_name)< / td > < / tr >
< tr class = "separator:afacdff207ba8359eaa029d8b1414c641 inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1c218b7f815bae0f48800b385ddce67e inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#a1c218b7f815bae0f48800b385ddce67e" > CopyFile< / a > (< a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html" > File< / a > *source, < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html" > File< / a > *destination)< / td > < / tr >
< tr class = "separator:a1c218b7f815bae0f48800b385ddce67e inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a9f5ebcd3bdebb7fb02a7a7adf378b344 inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memItemLeft" align = "right" valign = "top" > static int64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#a9f5ebcd3bdebb7fb02a7a7adf378b344" > CopyFile< / a > (< a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html" > File< / a > *source, < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html" > File< / a > *destination, int64_t max_copy)< / td > < / tr >
< tr class = "separator:a9f5ebcd3bdebb7fb02a7a7adf378b344 inherit pub_static_methods_classshaka_1_1media_1_1File" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-10-16 00:33:37 +00:00
< / 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 >
2016-01-09 01:03:21 +00:00
< p > Definition at line < a class = "el" href = "../../d2/da6/threaded__io__file_8h_source.html#l00021" > 21< / a > of file < a class = "el" href = "../../d2/da6/threaded__io__file_8h_source.html" > threaded_io_file.h< / a > .< / p >
2015-10-16 00:33:37 +00:00
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "a4a85d185a7eaa1abc857540ef703ab9a" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > bool shaka::media::ThreadedIoFile::Close < / td >
2015-10-16 00:33:37 +00:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
2015-10-19 17:27:30 +00:00
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
2015-10-16 00:33:37 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2016-05-24 23:43:16 +00:00
< p > < a class = "el" href = "../../d0/d66/classshaka_1_1media_1_1ThreadedIoFile.html#a4c8d46b1a16fba8bf4267c0a11fa856e" > Flush()< / a > and de-allocate resources associated with this file, and delete this < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html" title = "Define an abstract file interface. " > File< / a > object. THIS IS THE ONE TRUE WAY TO DEALLOCATE THIS OBJECT. < / p >
2015-10-16 00:33:37 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > true on success. For writable files, returning false MAY INDICATE DATA LOSS. < / dd > < / dl >
2016-05-24 23:43:16 +00:00
< p > Implements < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#a2bfb0c180840356933652a795527b5c8" > shaka::media::File< / a > .< / p >
2015-10-16 00:33:37 +00:00
2016-08-19 23:43:16 +00:00
< p > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00058" > 58< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2015-10-16 00:33:37 +00:00
< / div >
< / div >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "a4c8d46b1a16fba8bf4267c0a11fa856e" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > bool shaka::media::ThreadedIoFile::Flush < / td >
2015-10-16 00:33:37 +00:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
2015-10-19 17:27:30 +00:00
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
2015-10-16 00:33:37 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2016-05-24 23:43:16 +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 = "../../d9/de6/classshaka_1_1media_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 >
2015-10-16 00:33:37 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > true on success, false otherwise. < / dd > < / dl >
2016-05-24 23:43:16 +00:00
< p > Implements < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#aba73e887fbfe2de3a679c679ddf03f4b" > shaka::media::File< / a > .< / p >
2015-10-16 00:33:37 +00:00
2016-08-19 23:43:16 +00:00
< p > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00110" > 110< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2015-10-16 00:33:37 +00:00
< / div >
< / div >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "a5bd05e37779441004cd7ba0c33de1ad6" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > int64_t shaka::media::ThreadedIoFile::Read < / td >
2015-10-16 00:33:37 +00:00
< 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" >
2015-10-19 17:27:30 +00:00
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
2015-10-16 00:33:37 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Read data and return it in buffer. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< 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 >
2016-05-24 23:43:16 +00:00
< p > Implements < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#aed0c0793fd8751330583314a4d3012b9" > shaka::media::File< / a > .< / p >
2015-10-16 00:33:37 +00:00
2016-08-19 23:43:16 +00:00
< p > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00072" > 72< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2015-10-16 00:33:37 +00:00
< / div >
< / div >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "a4a30faf9c8e8b367bcfebb7b642d73e7" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > bool shaka::media::ThreadedIoFile::Seek < / td >
2015-10-16 00:33:37 +00:00
< 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" >
2015-10-19 17:27:30 +00:00
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
2015-10-16 00:33:37 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Seek to the specifield position in the file. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< 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 >
2016-05-24 23:43:16 +00:00
< p > Implements < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#a3baaa3207abaeb6af1a8239ee866b5d3" > shaka::media::File< / a > .< / p >
2015-10-16 00:33:37 +00:00
2016-08-19 23:43:16 +00:00
< p > 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 >
2015-10-16 00:33:37 +00:00
< / div >
< / div >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "ac8c1f49d9e7ff55b1484129240c065f3" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > int64_t shaka::media::ThreadedIoFile::Size < / td >
2015-10-16 00:33:37 +00:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
2015-10-19 17:27:30 +00:00
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
2015-10-16 00:33:37 +00:00
< / 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 >
2016-05-24 23:43:16 +00:00
< p > Implements < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#adffa2c3d12ae0a579704cf1f5b3bf8ab" > shaka::media::File< / a > .< / p >
2015-10-16 00:33:37 +00:00
2016-08-19 23:43:16 +00:00
< p > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00104" > 104< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2015-10-16 00:33:37 +00:00
< / div >
< / div >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "a23949d75527c8de9f02e749c7744f11e" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > bool shaka::media::ThreadedIoFile::Tell < / td >
2015-10-16 00:33:37 +00:00
< 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" >
2015-10-19 17:27:30 +00:00
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
2015-10-16 00:33:37 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the current file position. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< 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 >
2016-05-24 23:43:16 +00:00
< p > Implements < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#a57dd80258b1989f85d99c154ba377db8" > shaka::media::File< / a > .< / p >
2015-10-16 00:33:37 +00:00
2016-08-19 23:43:16 +00:00
< p > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00149" > 149< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2015-10-16 00:33:37 +00:00
< / div >
< / div >
2016-05-24 23:43:16 +00:00
< a class = "anchor" id = "aa14502dd48c1c64329283f5f1340f60f" > < / a >
2015-10-16 00:33:37 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2016-05-24 23:43:16 +00:00
< td class = "memname" > int64_t shaka::media::ThreadedIoFile::Write < / td >
2015-10-16 00:33:37 +00:00
< 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" >
2015-10-19 17:27:30 +00:00
< span class = "mlabels" > < span class = "mlabel" > override< / span > < span class = "mlabel" > virtual< / span > < / span > < / td >
2015-10-16 00:33:37 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Write block of data. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< 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 >
2016-05-24 23:43:16 +00:00
< p > Implements < a class = "el" href = "../../d3/d61/classshaka_1_1media_1_1File.html#a3149670c0d085e71f0aa085ee87fdda5" > shaka::media::File< / a > .< / p >
2015-10-16 00:33:37 +00:00
2016-08-19 23:43:16 +00:00
< p > Definition at line < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html#l00089" > 89< / a > of file < a class = "el" href = "../../d2/d23/threaded__io__file_8cc_source.html" > threaded_io_file.cc< / a > .< / p >
2015-10-16 00:33:37 +00:00
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
< li > media/file/< a class = "el" href = "../../d2/da6/threaded__io__file_8h_source.html" > threaded_io_file.h< / a > < / li >
< li > media/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 >
2017-03-08 19:14:10 +00:00
Generated on Wed Mar 8 2017 19:14:05 for DASH Media Packaging SDK by   < a href = "http://www.doxygen.org/index.html" >
2015-10-16 00:33:37 +00:00
< img class = "footer" src = "../../doxygen.png" alt = "doxygen" / >
< / a > 1.8.6
< / small > < / address >
< / body >
< / html >
