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" / >
< title > DASH Media Packaging SDK: media/file/io_cache.h Source File< / 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" / >
< 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 > < a href = "../../annotated.html" > < span > Classes< / span > < / a > < / li >
< li class = "current" > < 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 = "../../files.html" > < span > File  List< / 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)">
2015-10-19 19:22:31 +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 > 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 >
< li class = "navelem" > < a class = "el" href = "../../dir_39dc0668bd5a501998f94e8b4e546c71.html" > media< / a > < / li > < li class = "navelem" > < a class = "el" href = "../../dir_279fd47bebb21302c25cfb685e84c359.html" > file< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "headertitle" >
< div class = "title" > io_cache.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< div class = "fragment" > < div class = "line" > < a name = "l00001" > < / a > < span class = "lineno" > 1< / span >   < span class = "comment" > // Copyright 2015 Google Inc. All rights reserved.< / span > < / div >
< div class = "line" > < a name = "l00002" > < / a > < span class = "lineno" > 2< / span >   < span class = "comment" > //< / span > < / div >
< div class = "line" > < a name = "l00003" > < / a > < span class = "lineno" > 3< / span >   < span class = "comment" > // Use of this source code is governed by a BSD-style< / span > < / div >
< div class = "line" > < a name = "l00004" > < / a > < span class = "lineno" > 4< / span >   < span class = "comment" > // license that can be found in the LICENSE file or at< / span > < / div >
< div class = "line" > < a name = "l00005" > < / a > < span class = "lineno" > 5< / span >   < span class = "comment" > // https://developers.google.com/open-source/licenses/bsd< / span > < / div >
< div class = "line" > < a name = "l00006" > < / a > < span class = "lineno" > 6< / span >   < / div >
< div class = "line" > < a name = "l00007" > < / a > < span class = "lineno" > 7< / span >   < span class = "preprocessor" > #ifndef PACKAGER_FILE_IO_CACHE_H_< / span > < / div >
2015-10-19 17:27:30 +00:00
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define PACKAGER_FILE_IO_CACHE_H_< / span > < / div >
< div class = "line" > < a name = "l00009" > < / a > < span class = "lineno" > 9< / span >   < span class = "preprocessor" > < / span > < / div >
2015-10-16 00:33:37 +00:00
< div class = "line" > < a name = "l00010" > < / a > < span class = "lineno" > 10< / span >   < span class = "preprocessor" > #include < stdint.h> < / span > < / div >
< div class = "line" > < a name = "l00011" > < / a > < span class = "lineno" > 11< / span >   < span class = "preprocessor" > #include < vector> < / span > < / div >
< div class = "line" > < a name = "l00012" > < / a > < span class = "lineno" > 12< / span >   < span class = "preprocessor" > #include " packager/base/macros.h" < / span > < / div >
< div class = "line" > < a name = "l00013" > < / a > < span class = "lineno" > 13< / span >   < span class = "preprocessor" > #include " packager/base/synchronization/lock.h" < / span > < / div >
< div class = "line" > < a name = "l00014" > < / a > < span class = "lineno" > 14< / span >   < span class = "preprocessor" > #include " packager/base/synchronization/waitable_event.h" < / span > < / div >
< div class = "line" > < a name = "l00015" > < / a > < span class = "lineno" > 15< / span >   < / div >
< div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > 16< / span >   < span class = "keyword" > namespace < / span > edash_packager {< / div >
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < span class = "keyword" > namespace < / span > media {< / div >
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   < / div >
< div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > < a class = "line" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html" > 20< / a > < / span >   < span class = "keyword" > class < / span > < a class = "code" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html" > IoCache< / a > {< / div >
< div class = "line" > < a name = "l00021" > < / a > < span class = "lineno" > 21< / span >   < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a name = "l00022" > < / a > < span class = "lineno" > 22< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html" > IoCache< / a > (uint64_t cache_size);< / div >
2015-10-19 17:27:30 +00:00
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > 23< / span >   ~< a class = "code" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html" > IoCache< / a > ();< / div >
2015-10-16 00:33:37 +00:00
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   < / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   uint64_t < a class = "code" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#a462bd5ddce8041eaa109271fd0d155a9" > Read< / a > (< span class = "keywordtype" > void< / span > * buffer, uint64_t size);< / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / span >   < / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   uint64_t < a class = "code" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#a4b7ee97ec07a6b2702ae4b58c9df4413" > Write< / a > (< span class = "keyword" > const< / span > < span class = "keywordtype" > void< / span > * buffer, uint64_t size);< / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#ae8ed4943296a88e5d5356347e63c6a42" > Clear< / a > ();< / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   < / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#a4588dbf505a08da8423b525ce24fee92" > Close< / a > ();< / div >
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   < / div >
< div class = "line" > < a name = "l00051" > < / a > < span class = "lineno" > 51< / span >   uint64_t < a class = "code" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#a0fe59125434e46c2ea5474cfc9f0e95c" > BytesCached< / a > ();< / div >
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > 52< / span >   < / div >
< div class = "line" > < a name = "l00055" > < / a > < span class = "lineno" > 55< / span >   uint64_t < a class = "code" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#ab5f7b9c5bc61e33f91cef7726f222586" > BytesFree< / a > ();< / div >
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   < / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#ace4946f4ecb34f84c4750d276404a3e5" > WaitUntilEmptyOrClosed< / a > ();< / div >
< div class = "line" > < a name = "l00059" > < / a > < span class = "lineno" > 59< / span >   < / div >
< div class = "line" > < a name = "l00060" > < / a > < span class = "lineno" > 60< / span >   < span class = "keyword" > private< / span > :< / div >
< div class = "line" > < a name = "l00061" > < / a > < span class = "lineno" > 61< / span >   uint64_t BytesCachedInternal();< / div >
< div class = "line" > < a name = "l00062" > < / a > < span class = "lineno" > 62< / span >   uint64_t BytesFreeInternal();< / div >
< div class = "line" > < a name = "l00063" > < / a > < span class = "lineno" > 63< / span >   < / div >
< div class = "line" > < a name = "l00064" > < / a > < span class = "lineno" > 64< / span >   < span class = "keyword" > const< / span > uint64_t cache_size_;< / div >
< div class = "line" > < a name = "l00065" > < / a > < span class = "lineno" > 65< / span >   base::Lock lock_;< / div >
< div class = "line" > < a name = "l00066" > < / a > < span class = "lineno" > 66< / span >   base::WaitableEvent read_event_;< / div >
< div class = "line" > < a name = "l00067" > < / a > < span class = "lineno" > 67< / span >   base::WaitableEvent write_event_;< / div >
< div class = "line" > < a name = "l00068" > < / a > < span class = "lineno" > 68< / span >   std::vector< uint8_t> circular_buffer_;< / div >
< div class = "line" > < a name = "l00069" > < / a > < span class = "lineno" > 69< / span >   < span class = "keyword" > const< / span > uint8_t* end_ptr_;< / div >
< div class = "line" > < a name = "l00070" > < / a > < span class = "lineno" > 70< / span >   uint8_t* r_ptr_;< / div >
< div class = "line" > < a name = "l00071" > < / a > < span class = "lineno" > 71< / span >   uint8_t* w_ptr_;< / div >
< div class = "line" > < a name = "l00072" > < / a > < span class = "lineno" > 72< / span >   < span class = "keywordtype" > bool< / span > closed_;< / div >
< div class = "line" > < a name = "l00073" > < / a > < span class = "lineno" > 73< / span >   < / div >
< div class = "line" > < a name = "l00074" > < / a > < span class = "lineno" > 74< / span >   DISALLOW_COPY_AND_ASSIGN(< a class = "code" href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html" > IoCache< / a > );< / div >
< div class = "line" > < a name = "l00075" > < / a > < span class = "lineno" > 75< / span >   };< / div >
< div class = "line" > < a name = "l00076" > < / a > < span class = "lineno" > 76< / span >   < / div >
< div class = "line" > < a name = "l00077" > < / a > < span class = "lineno" > 77< / span >   } < span class = "comment" > // namespace media< / span > < / div >
< div class = "line" > < a name = "l00078" > < / a > < span class = "lineno" > 78< / span >   } < span class = "comment" > // namespace edash_packager< / span > < / div >
< div class = "line" > < a name = "l00079" > < / a > < span class = "lineno" > 79< / span >   < / div >
< div class = "line" > < a name = "l00080" > < / a > < span class = "lineno" > 80< / span >   < span class = "preprocessor" > #endif // PACKAGER_FILE_IO_CACHE_H< / span > < / div >
< div class = "ttc" id = "classedash__packager_1_1media_1_1IoCache_html_a0fe59125434e46c2ea5474cfc9f0e95c" > < div class = "ttname" > < a href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#a0fe59125434e46c2ea5474cfc9f0e95c" > edash_packager::media::IoCache::BytesCached< / a > < / div > < div class = "ttdeci" > uint64_t BytesCached()< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/d37/io__cache_8cc_source.html#l00116" > io_cache.cc:116< / a > < / div > < / div >
< div class = "ttc" id = "classedash__packager_1_1media_1_1IoCache_html" > < div class = "ttname" > < a href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html" > edash_packager::media::IoCache< / a > < / div > < div class = "ttdoc" > Declaration of class which implements a thread-safe circular buffer. < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d3/d19/io__cache_8h_source.html#l00020" > io_cache.h:20< / a > < / div > < / div >
< div class = "ttc" id = "classedash__packager_1_1media_1_1IoCache_html_a4588dbf505a08da8423b525ce24fee92" > < div class = "ttname" > < a href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#a4588dbf505a08da8423b525ce24fee92" > edash_packager::media::IoCache::Close< / a > < / div > < div class = "ttdeci" > void Close()< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/d37/io__cache_8cc_source.html#l00109" > io_cache.cc:109< / a > < / div > < / div >
< div class = "ttc" id = "classedash__packager_1_1media_1_1IoCache_html_ace4946f4ecb34f84c4750d276404a3e5" > < div class = "ttname" > < a href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#ace4946f4ecb34f84c4750d276404a3e5" > edash_packager::media::IoCache::WaitUntilEmptyOrClosed< / a > < / div > < div class = "ttdeci" > void WaitUntilEmptyOrClosed()< / div > < div class = "ttdoc" > Waits until the cache is empty or has been closed. < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/d37/io__cache_8cc_source.html#l00136" > io_cache.cc:136< / a > < / div > < / div >
< div class = "ttc" id = "classedash__packager_1_1media_1_1IoCache_html_a4b7ee97ec07a6b2702ae4b58c9df4413" > < div class = "ttname" > < a href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#a4b7ee97ec07a6b2702ae4b58c9df4413" > edash_packager::media::IoCache::Write< / a > < / div > < div class = "ttdeci" > uint64_t Write(const void *buffer, uint64_t size)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/d37/io__cache_8cc_source.html#l00066" > io_cache.cc:66< / a > < / div > < / div >
< div class = "ttc" id = "classedash__packager_1_1media_1_1IoCache_html_ab5f7b9c5bc61e33f91cef7726f222586" > < div class = "ttname" > < a href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#ab5f7b9c5bc61e33f91cef7726f222586" > edash_packager::media::IoCache::BytesFree< / a > < / div > < div class = "ttdeci" > uint64_t BytesFree()< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/d37/io__cache_8cc_source.html#l00121" > io_cache.cc:121< / a > < / div > < / div >
< div class = "ttc" id = "classedash__packager_1_1media_1_1IoCache_html_ae8ed4943296a88e5d5356347e63c6a42" > < div class = "ttname" > < a href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#ae8ed4943296a88e5d5356347e63c6a42" > edash_packager::media::IoCache::Clear< / a > < / div > < div class = "ttdeci" > void Clear()< / div > < div class = "ttdoc" > Empties the cache. < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/d37/io__cache_8cc_source.html#l00102" > io_cache.cc:102< / a > < / div > < / div >
< div class = "ttc" id = "classedash__packager_1_1media_1_1IoCache_html_a462bd5ddce8041eaa109271fd0d155a9" > < div class = "ttname" > < a href = "../../d3/d6b/classedash__packager_1_1media_1_1IoCache.html#a462bd5ddce8041eaa109271fd0d155a9" > edash_packager::media::IoCache::Read< / a > < / div > < div class = "ttdeci" > uint64_t Read(void *buffer, uint64_t size)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/d37/io__cache_8cc_source.html#l00038" > io_cache.cc:38< / a > < / div > < / div >
< / div > <!-- fragment --> < / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2015-10-19 19:22:31 +00:00
Generated on Mon Oct 19 2015 19:22:22 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 >
