157 lines
18 KiB
HTML
157 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<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"/>
|
|
<script type="text/javascript" src="../../search/searchdata.js"></script>
|
|
<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;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Shaka Packager SDK
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('../../',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- 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">
|
|
<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_THREADED_IO_FILE_H_</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define PACKAGER_FILE_THREADED_IO_FILE_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 <atomic></span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "packager/base/synchronization/waitable_event.h"</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "packager/file/file.h"</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "packager/file/file_closer.h"</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "packager/file/io_cache.h"</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <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>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html"> 20</a></span> <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>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">enum</span> Mode { kInputMode, kOutputMode };</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html">ThreadedIoFile</a>(std::unique_ptr<File, FileCloser> internal_file,</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  Mode mode,</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  uint64_t io_cache_size,</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  uint64_t io_block_size);</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">bool</span> <a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a79292b93c39f609b5348787a39fc77b2">Close</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  int64_t <a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#af45702d95d4e46e93b1f4a897844212e">Read</a>(<span class="keywordtype">void</span>* buffer, uint64_t length) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  int64_t <a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#ab8acfe4af14c1120ae6d2baa44a10583">Write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, uint64_t length) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  int64_t <a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#af23f2da404e1602c240bb59d2601f1b9">Size</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">bool</span> <a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a2b53b72d99aad4439781e3887492452c">Flush</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">bool</span> <a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a9b95550cf6342f970645c086a2ed58c2">Seek</a>(uint64_t position) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">bool</span> <a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a6ee5bcbe6bb8dd232679b2c50d968f4e">Tell</a>(uint64_t* position) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  ~<a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html">ThreadedIoFile</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">bool</span> <a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html#a353eb138e2f23f4e75c8c56580050aa0">Open</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// Internal task handler implementation. Will dispatch to either</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// |RunInInputMode| or |RunInOutputMode| depending on |mode_|.</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> TaskHandler();</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> RunInInputMode();</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> RunInOutputMode();</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  std::unique_ptr<File, FileCloser> internal_file_;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">const</span> Mode mode_;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="../../df/d4e/classshaka_1_1IoCache.html">IoCache</a> cache_;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  std::vector<uint8_t> io_buffer_;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  uint64_t position_;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  uint64_t size_;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::atomic<bool> eof_;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">bool</span> flushing_;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  base::WaitableEvent flush_complete_event_;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  std::atomic<int32_t> internal_file_error_;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// Signalled when thread task exits.</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  base::WaitableEvent task_exit_event_;</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>  DISALLOW_COPY_AND_ASSIGN(<a class="code" href="../../dd/d0c/classshaka_1_1ThreadedIoFile.html">ThreadedIoFile</a>);</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> };</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> } <span class="comment">// namespace shaka</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#endif </span><span class="comment">// PACKAGER_FILE_THREADED_IO_FILE_H</span></div>
|
|
<div class="ttc" id="aclassshaka_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#l00027">file.h:27</a></div></div>
|
|
<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>
|
|
<div class="ttc" id="aclassshaka_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>
|
|
<div class="ttc" id="aclassshaka_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#l00107">threaded_io_file.cc:107</a></div></div>
|
|
<div class="ttc" id="aclassshaka_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#l00039">threaded_io_file.cc:39</a></div></div>
|
|
<div class="ttc" id="aclassshaka_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#l00152">threaded_io_file.cc:152</a></div></div>
|
|
<div class="ttc" id="aclassshaka_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#l00055">threaded_io_file.cc:55</a></div></div>
|
|
<div class="ttc" id="aclassshaka_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#l00120">threaded_io_file.cc:120</a></div></div>
|
|
<div class="ttc" id="aclassshaka_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#l00086">threaded_io_file.cc:86</a></div></div>
|
|
<div class="ttc" id="aclassshaka_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#l00101">threaded_io_file.cc:101</a></div></div>
|
|
<div class="ttc" id="aclassshaka_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#l00070">threaded_io_file.cc:70</a></div></div>
|
|
<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>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Jun 10 2021 21:44:25 for Shaka Packager SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|