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/d2/da6/threaded__io__file_8h_sourc...

90 lines
18 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/threaded_io_file.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">threaded_io_file.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_THREADED_IO_FILE_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_FILE_THREADED_IO_FILE_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;memory&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;packager/base/atomicops.h&quot;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;packager/base/synchronization/waitable_event.h&quot;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;packager/file/file.h&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;packager/file/file_closer.h&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;packager/file/io_cache.h&quot;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html"> 20</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html">ThreadedIoFile</a> : <span class="keyword">public</span> <a class="code" href="../../d3/d73/classshaka_1_1File.html">File</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">enum</span> Mode { kInputMode, kOutputMode };</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html">ThreadedIoFile</a>(std::unique_ptr&lt;File, FileCloser&gt; internal_file,</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; Mode mode,</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; uint64_t io_cache_size,</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; uint64_t io_block_size);</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00031"></a><span clas
Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
2017-09-20 02:35:05 +00:00
<div class="ttc" id="classshaka_1_1ThreadedIoFile_html_af23f2da404e1602c240bb59d2601f1b9"><div class="ttname"><a href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#af23f2da404e1602c240bb59d2601f1b9">shaka::ThreadedIoFile::Size</a></div><div class="ttdeci">int64_t Size() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d23/threaded__io__file_8cc_source.html#l00104">threaded_io_file.cc:104</a></div></div>
<div class="ttc" id="classshaka_1_1File_html"><div class="ttname"><a href="../../d3/d73/classshaka_1_1File.html">shaka::File</a></div><div class="ttdoc">Define an abstract file interface. </div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d4d/file_8h_source.html#l00026">file.h:26</a></div></div>
<div class="ttc" id="classshaka_1_1ThreadedIoFile_html_ab8acfe4af14c1120ae6d2baa44a10583"><div class="ttname"><a href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#ab8acfe4af14c1120ae6d2baa44a10583">shaka::ThreadedIoFile::Write</a></div><div class="ttdeci">int64_t Write(const void *buffer, uint64_t length) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d23/threaded__io__file_8cc_source.html#l00089">threaded_io_file.cc:89</a></div></div>
<div class="ttc" id="classshaka_1_1ThreadedIoFile_html_a2b53b72d99aad4439781e3887492452c"><div class="ttname"><a href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a2b53b72d99aad4439781e3887492452c">shaka::ThreadedIoFile::Flush</a></div><div class="ttdeci">bool Flush() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d23/threaded__io__file_8cc_source.html#l00110">threaded_io_file.cc:110</a></div></div>
<div class="ttc" id="classshaka_1_1ThreadedIoFile_html"><div class="ttname"><a href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html">shaka::ThreadedIoFile</a></div><div class="ttdoc">Declaration of class which implements a thread-safe circular buffer. </div><div class="ttdef"><b>Definition:</b> <a href="../../d2/da6/threaded__io__file_8h_source.html#l00020">threaded_io_file.h:20</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_1ThreadedIoFile_html_a353eb138e2f23f4e75c8c56580050aa0"><div class="ttname"><a href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a353eb138e2f23f4e75c8c56580050aa0">shaka::ThreadedIoFile::Open</a></div><div class="ttdeci">bool Open() override</div><div class="ttdoc">Internal open. Should not be used directly. </div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d23/threaded__io__file_8cc_source.html#l00042">threaded_io_file.cc:42</a></div></div>
<div class="ttc" id="classshaka_1_1ThreadedIoFile_html_a9b95550cf6342f970645c086a2ed58c2"><div class="ttname"><a href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a9b95550cf6342f970645c086a2ed58c2">shaka::ThreadedIoFile::Seek</a></div><div class="ttdeci">bool Seek(uint64_t position) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d23/threaded__io__file_8cc_source.html#l00123">threaded_io_file.cc:123</a></div></div>
<div class="ttc" id="classshaka_1_1ThreadedIoFile_html_a79292b93c39f609b5348787a39fc77b2"><div class="ttname"><a href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a79292b93c39f609b5348787a39fc77b2">shaka::ThreadedIoFile::Close</a></div><div class="ttdeci">bool Close() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d23/threaded__io__file_8cc_source.html#l00058">threaded_io_file.cc:58</a></div></div>
<div class="ttc" id="classshaka_1_1ThreadedIoFile_html_a6ee5bcbe6bb8dd232679b2c50d968f4e"><div class="ttname"><a href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a6ee5bcbe6bb8dd232679b2c50d968f4e">shaka::ThreadedIoFile::Tell</a></div><div class="ttdeci">bool Tell(uint64_t *position) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d23/threaded__io__file_8cc_source.html#l00155">threaded_io_file.cc:155</a></div></div>
<div class="ttc" id="classshaka_1_1ThreadedIoFile_html_af45702d95d4e46e93b1f4a897844212e"><div class="ttname"><a href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#af45702d95d4e46e93b1f4a897844212e">shaka::ThreadedIoFile::Read</a></div><div class="ttdeci">int64_t Read(void *buffer, uint64_t length) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d23/threaded__io__file_8cc_source.html#l00073">threaded_io_file.cc:73</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generate documents for commit d3903fad190606e4e7015543e8cac79ad38661d4
2018-06-29 00:34:00 +00:00
Generated on Thu Jun 28 2018 17:32:55 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>