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: packager/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" / >
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 = "../../dir_3f8eec2fc361645de4b1ec14c19fffc7.html" > packager< / a > < / li > < li class = "navelem" > < a class = "el" href = "../../dir_d258fb6e36cbaad69b44b6c9489b2bbb.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" >
2021-04-10 04:00:37 +00:00
< 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 >
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < span class = "preprocessor" > #define PACKAGER_FILE_IO_CACHE_H_< / span > < / div >
< div class = "line" > < a name = "l00009" > < / a > < span class = "lineno" > 9< / span >   < / div >
< 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 > < a class = "code" href = "../../d8/daf/namespaceshaka.html" > shaka< / a > {< / div >
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < / div >
< div class = "line" > < a name = "l00019" > < / a > < span class = "lineno" > < a class = "line" href = "../../df/d4e/classshaka_1_1IoCache.html" > 19< / a > < / span >   < span class = "keyword" > class < / span > < a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html" > IoCache< / a > {< / div >
< div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > 20< / span >   < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a name = "l00021" > < / a > < span class = "lineno" > 21< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html" > IoCache< / a > (uint64_t cache_size);< / div >
< div class = "line" > < a name = "l00022" > < / a > < span class = "lineno" > 22< / span >   ~< a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html" > IoCache< / a > ();< / div >
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > 23< / span >   < / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   uint64_t < a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html#a7cc144c2f848725db08b3ca175475fc2" > Read< / a > (< span class = "keywordtype" > void< / span > * buffer, uint64_t size);< / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   < / div >
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > 39< / span >   uint64_t < a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html#a483277a6c68dd58cebb8dafb5c1dcd21" > Write< / a > (< span class = "keyword" > const< / span > < span class = "keywordtype" > void< / span > * buffer, uint64_t size);< / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   < / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html#a10c8e56478fe7bc4c30ea0087eb22804" > Clear< / a > ();< / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   < / div >
< div class = "line" > < a name = "l00046" > < / a > < span class = "lineno" > 46< / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html#a1c54ca1d747cf0b0b9ab681babff73e6" > Close< / a > ();< / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   < / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > < a class = "line" href = "../../df/d4e/classshaka_1_1IoCache.html#a69c0074123339c9c60dec6a27a5c085c" > 49< / a > < / span >   < span class = "keywordtype" > bool< / span > < a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html#a69c0074123339c9c60dec6a27a5c085c" > closed< / a > () { < span class = "keywordflow" > return< / span > closed_; }< / div >
< div class = "line" > < a name = "l00050" > < / a > < span class = "lineno" > 50< / span >   < / div >
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > 52< / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html#ac2c7cbec6d771de00fe0cfe0b7d0e454" > Reopen< / a > ();< / div >
< div class = "line" > < a name = "l00053" > < / a > < span class = "lineno" > 53< / span >   < / div >
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   uint64_t < a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html#a8033da711e62112877be7a6ac2186622" > BytesCached< / a > ();< / div >
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   < / div >
< div class = "line" > < a name = "l00060" > < / a > < span class = "lineno" > 60< / span >   uint64_t < a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html#a744559cbb0a3878027ca6fc2a12555c1" > BytesFree< / a > ();< / div >
< div class = "line" > < a name = "l00061" > < / a > < span class = "lineno" > 61< / span >   < / div >
< div class = "line" > < a name = "l00063" > < / a > < span class = "lineno" > 63< / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html#abafe56067c5961d56611271b6fc5a760" > WaitUntilEmptyOrClosed< / a > ();< / div >
< div class = "line" > < a name = "l00064" > < / a > < span class = "lineno" > 64< / span >   < / div >
< div class = "line" > < a name = "l00065" > < / a > < span class = "lineno" > 65< / span >   < span class = "keyword" > private< / span > :< / div >
< div class = "line" > < a name = "l00066" > < / a > < span class = "lineno" > 66< / span >   uint64_t BytesCachedInternal();< / div >
< div class = "line" > < a name = "l00067" > < / a > < span class = "lineno" > 67< / span >   uint64_t BytesFreeInternal();< / div >
< div class = "line" > < a name = "l00068" > < / a > < span class = "lineno" > 68< / span >   < / div >
< div class = "line" > < a name = "l00069" > < / a > < span class = "lineno" > 69< / span >   < span class = "keyword" > const< / span > uint64_t cache_size_;< / div >
< div class = "line" > < a name = "l00070" > < / a > < span class = "lineno" > 70< / span >   base::Lock lock_;< / div >
< div class = "line" > < a name = "l00071" > < / a > < span class = "lineno" > 71< / span >   base::WaitableEvent read_event_;< / div >
< div class = "line" > < a name = "l00072" > < / a > < span class = "lineno" > 72< / span >   base::WaitableEvent write_event_;< / div >
< div class = "line" > < a name = "l00073" > < / a > < span class = "lineno" > 73< / span >   std::vector< uint8_t> circular_buffer_;< / div >
< div class = "line" > < a name = "l00074" > < / a > < span class = "lineno" > 74< / span >   < span class = "keyword" > const< / span > uint8_t* end_ptr_;< / div >
< div class = "line" > < a name = "l00075" > < / a > < span class = "lineno" > 75< / span >   uint8_t* r_ptr_;< / div >
< div class = "line" > < a name = "l00076" > < / a > < span class = "lineno" > 76< / span >   uint8_t* w_ptr_;< / div >
< div class = "line" > < a name = "l00077" > < / a > < span class = "lineno" > 77< / span >   < span class = "keywordtype" > bool< / span > closed_;< / div >
< div class = "line" > < a name = "l00078" > < / a > < span class = "lineno" > 78< / span >   < / div >
< div class = "line" > < a name = "l00079" > < / a > < span class = "lineno" > 79< / span >   DISALLOW_COPY_AND_ASSIGN(< a class = "code" href = "../../df/d4e/classshaka_1_1IoCache.html" > IoCache< / a > );< / div >
< div class = "line" > < a name = "l00080" > < / a > < span class = "lineno" > 80< / span >   };< / div >
< div class = "line" > < a name = "l00081" > < / a > < span class = "lineno" > 81< / span >   < / div >
< div class = "line" > < a name = "l00082" > < / a > < span class = "lineno" > 82< / span >   } < span class = "comment" > // namespace shaka< / span > < / div >
< div class = "line" > < a name = "l00083" > < / a > < span class = "lineno" > 83< / span >   < / div >
2021-06-22 00:16:40 +00:00
< div class = "line" > < a name = "l00084" > < / a > < span class = "lineno" > 84< / span >   < span class = "preprocessor" > #endif // PACKAGER_FILE_IO_CACHE_H< / span > < / div >
< / div > <!-- fragment --> < / div > <!-- contents -->
< div class = "ttc" id = "anamespaceshaka_html" > < div class = "ttname" > < a href = "../../d8/daf/namespaceshaka.html" > shaka< / a > < / div > < div class = "ttdoc" > All the methods that are virtual are virtual for mocking.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/d15/gflags__hex__bytes_8cc_source.html#l00011" > gflags_hex_bytes.cc:11< / a > < / div > < / div >
2021-04-10 04:00:37 +00:00
< div class = "ttc" id = "aclassshaka_1_1IoCache_html_a10c8e56478fe7bc4c30ea0087eb22804" > < div class = "ttname" > < a href = "../../df/d4e/classshaka_1_1IoCache.html#a10c8e56478fe7bc4c30ea0087eb22804" > shaka::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#l00105" > io_cache.cc:105< / a > < / div > < / div >
< div class = "ttc" id = "aclassshaka_1_1IoCache_html_a483277a6c68dd58cebb8dafb5c1dcd21" > < div class = "ttname" > < a href = "../../df/d4e/classshaka_1_1IoCache.html#a483277a6c68dd58cebb8dafb5c1dcd21" > shaka::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 >
2021-06-22 00:16:40 +00:00
< div class = "ttc" id = "aclassshaka_1_1IoCache_html_a1c54ca1d747cf0b0b9ab681babff73e6" > < div class = "ttname" > < a href = "../../df/d4e/classshaka_1_1IoCache.html#a1c54ca1d747cf0b0b9ab681babff73e6" > shaka::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#l00112" > io_cache.cc:112< / a > < / div > < / div >
2021-04-10 04:00:37 +00:00
< div class = "ttc" id = "aclassshaka_1_1IoCache_html_a744559cbb0a3878027ca6fc2a12555c1" > < div class = "ttname" > < a href = "../../df/d4e/classshaka_1_1IoCache.html#a744559cbb0a3878027ca6fc2a12555c1" > shaka::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#l00133" > io_cache.cc:133< / a > < / div > < / div >
2021-06-22 00:16:40 +00:00
< div class = "ttc" id = "aclassshaka_1_1IoCache_html" > < div class = "ttname" > < a href = "../../df/d4e/classshaka_1_1IoCache.html" > shaka::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#l00019" > io_cache.h:19< / a > < / div > < / div >
2021-04-10 04:00:37 +00:00
< div class = "ttc" id = "aclassshaka_1_1IoCache_html_a8033da711e62112877be7a6ac2186622" > < div class = "ttname" > < a href = "../../df/d4e/classshaka_1_1IoCache.html#a8033da711e62112877be7a6ac2186622" > shaka::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#l00128" > io_cache.cc:128< / a > < / div > < / div >
2021-06-22 00:16:40 +00:00
< div class = "ttc" id = "aclassshaka_1_1IoCache_html_a7cc144c2f848725db08b3ca175475fc2" > < div class = "ttname" > < a href = "../../df/d4e/classshaka_1_1IoCache.html#a7cc144c2f848725db08b3ca175475fc2" > shaka::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 class = "ttc" id = "aclassshaka_1_1IoCache_html_a69c0074123339c9c60dec6a27a5c085c" > < div class = "ttname" > < a href = "../../df/d4e/classshaka_1_1IoCache.html#a69c0074123339c9c60dec6a27a5c085c" > shaka::IoCache::closed< / a > < / div > < div class = "ttdeci" > bool closed()< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d3/d19/io__cache_8h_source.html#l00049" > io_cache.h:49< / a > < / div > < / div >
2021-04-10 04:00:37 +00:00
< div class = "ttc" id = "aclassshaka_1_1IoCache_html_abafe56067c5961d56611271b6fc5a760" > < div class = "ttname" > < a href = "../../df/d4e/classshaka_1_1IoCache.html#abafe56067c5961d56611271b6fc5a760" > shaka::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#l00148" > io_cache.cc:148< / a > < / div > < / div >
< div class = "ttc" id = "aclassshaka_1_1IoCache_html_ac2c7cbec6d771de00fe0cfe0b7d0e454" > < div class = "ttname" > < a href = "../../df/d4e/classshaka_1_1IoCache.html#ac2c7cbec6d771de00fe0cfe0b7d0e454" > shaka::IoCache::Reopen< / a > < / div > < div class = "ttdeci" > void Reopen()< / div > < div class = "ttdoc" > Reopens the cache. Any data still in the cache will be lost.< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "../../d4/d37/io__cache_8cc_source.html#l00119" > io_cache.cc:119< / a > < / div > < / div >
2017-09-20 02:35:05 +00:00
<!-- 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:03 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 >
