Mirror-Tools
/
shaka-packager
mirror of https://github.com/shaka-project/shaka-packager.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shaka-packager/docs/d3/d19/io__cache_8h_source.html

89 lines
16 KiB
HTML
Raw Normal View History

Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
2017-09-20 02:35:05 +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"/>
Generate documents for v2.0.0
2018-02-10 23:37:42 +00:00
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
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"/>
Generate documents for v2.0.0
2018-02-10 23:37:42 +00:00
<script type="text/javascript" src="../../search/searchdata.js"></script>
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
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;">
Generate documents for v2.0.0
2018-02-10 23:37:42 +00:00
<td id="projectalign" style="padding-left: 0.5em;">
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
2017-09-20 02:35:05 +00:00
<div id="projectname">Shaka Packager SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
Generate documents for v2.0.0
2018-02-10 23:37:42 +00:00
<!-- Generated by Doxygen 1.8.13 -->
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
2017-09-20 02:35:05 +00:00
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
Generate documents for v2.0.0
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">
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
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)">
Generate documents for v2.0.0
2018-02-10 23:37:42 +00:00
</div>
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
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">
Generate documents for v2.0.0
2018-02-10 23:37:42 +00:00
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2015 Google Inc. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<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>&#160;<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>&#160;<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>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#ifndef PACKAGER_FILE_IO_CACHE_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_FILE_IO_CACHE_H_</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;packager/base/macros.h&quot;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;packager/base/synchronization/lock.h&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;packager/base/synchronization/waitable_event.h&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<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>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="../../df/d4e/classshaka_1_1IoCache.html"> 19</a></span>&#160;<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>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <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>&#160; ~<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>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; 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>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; 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>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;
Generate documents for commit d3903fad190606e4e7015543e8cac79ad38661d4
2018-06-29 00:34:00 +00:00
<div class="ttc" id="classshaka_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>
<div class="ttc" id="classshaka_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="classshaka_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>
Generate documents for v2.0.0
2018-02-10 23:37:42 +00:00
<div class="ttc" id="namespaceshaka_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>
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
2017-09-20 02:35:05 +00:00
<div class="ttc" id="classshaka_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>
<div class="ttc" id="classshaka_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>
Generate documents for commit d3903fad190606e4e7015543e8cac79ad38661d4
2018-06-29 00:34:00 +00:00
<div class="ttc" id="classshaka_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>
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
2017-09-20 02:35:05 +00:00
<div class="ttc" id="classshaka_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>
Generate documents for commit d3903fad190606e4e7015543e8cac79ad38661d4
2018-06-29 00:34:00 +00:00
<div class="ttc" id="classshaka_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>
<div class="ttc" id="classshaka_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>
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
2017-09-20 02:35:05 +00:00
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generate documents for commit 4640cac4eb2d8c06df667ae7698a3d62d20ab90b
2018-12-20 22:38:40 +00:00
Generated on Thu Dec 20 2018 14:37:37 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
2017-09-20 02:35:05 +00:00
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
Generate documents for v2.0.0
2018-02-10 23:37:42 +00:00
</a> 1.8.13
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
2017-09-20 02:35:05 +00:00
</small></address>
</body>
</html>