140 lines
17 KiB
HTML
140 lines
17 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/local_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">local_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 2014 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_LOCAL_FILE_H_</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define PACKAGER_FILE_LOCAL_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 <stdint.h></span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "packager/base/compiler_specific.h"</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "packager/file/file.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="../../d7/dbd/classshaka_1_1LocalFile.html"> 20</a></span> <span class="keyword">class </span><a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html">LocalFile</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="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html#a2bc14434191cdc36e7e9f67c6ebf282f">LocalFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>, <span class="keyword">const</span> <span class="keywordtype">char</span>* mode);</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordtype">bool</span> <a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html#a3d881c251c19a36eaf50483971095370">Close</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  int64_t <a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html#a27c3bf51fe18ebc10bf42ebcec20c9cb">Read</a>(<span class="keywordtype">void</span>* buffer, uint64_t length) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  int64_t <a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html#aee10b7f2898c5047eb8505f16c49311c">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="l00032"></a><span class="lineno"> 32</span>  int64_t <a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html#ad20649d0ee575b81830a5abf88e2bde1">Size</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">bool</span> <a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html#a04b4523a7352572b2c6d72f1d6f3a077">Flush</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">bool</span> <a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html#a082cd6d64c8f04acff251cdafb66b203">Seek</a>(uint64_t position) <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="../../d7/dbd/classshaka_1_1LocalFile.html#af111d93e10ae0128f082eef77eaa914b">Tell</a>(uint64_t* position) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html#a7eb47bb6ceff52c57e3eb4a21fb0ba8d">Delete</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>);</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="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  ~<a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html">LocalFile</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">bool</span> <a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html#a8de3e633211e896c43319a5b6f080804">Open</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  std::string file_mode_;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  FILE* internal_file_;</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>  DISALLOW_COPY_AND_ASSIGN(<a class="code" href="../../d7/dbd/classshaka_1_1LocalFile.html">LocalFile</a>);</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> };</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> } <span class="comment">// namespace shaka</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#endif </span><span class="comment">// PACKAGER_FILE_LOCAL_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_1File_html_a4b06e08bb0295cb89fca45f9356ecbae"><div class="ttname"><a href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">shaka::File::file_name</a></div><div class="ttdeci">const std::string & file_name() const</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d4d/file_8h_source.html#l00095">file.h:95</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1LocalFile_html"><div class="ttname"><a href="../../d7/dbd/classshaka_1_1LocalFile.html">shaka::LocalFile</a></div><div class="ttdoc">Implement LocalFile which deals with local storage.</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d0f/local__file_8h_source.html#l00020">local_file.h:20</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1LocalFile_html_a04b4523a7352572b2c6d72f1d6f3a077"><div class="ttname"><a href="../../d7/dbd/classshaka_1_1LocalFile.html#a04b4523a7352572b2c6d72f1d6f3a077">shaka::LocalFile::Flush</a></div><div class="ttdeci">bool Flush() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/de8/local__file_8cc_source.html#l00156">local_file.cc:156</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1LocalFile_html_a082cd6d64c8f04acff251cdafb66b203"><div class="ttname"><a href="../../d7/dbd/classshaka_1_1LocalFile.html#a082cd6d64c8f04acff251cdafb66b203">shaka::LocalFile::Seek</a></div><div class="ttdeci">bool Seek(uint64_t position) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/de8/local__file_8cc_source.html#l00161">local_file.cc:161</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1LocalFile_html_a27c3bf51fe18ebc10bf42ebcec20c9cb"><div class="ttname"><a href="../../d7/dbd/classshaka_1_1LocalFile.html#a27c3bf51fe18ebc10bf42ebcec20c9cb">shaka::LocalFile::Read</a></div><div class="ttdeci">int64_t Read(void *buffer, uint64_t length) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/de8/local__file_8cc_source.html#l00114">local_file.cc:114</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1LocalFile_html_a2bc14434191cdc36e7e9f67c6ebf282f"><div class="ttname"><a href="../../d7/dbd/classshaka_1_1LocalFile.html#a2bc14434191cdc36e7e9f67c6ebf282f">shaka::LocalFile::LocalFile</a></div><div class="ttdeci">LocalFile(const char *file_name, const char *mode)</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/de8/local__file_8cc_source.html#l00098">local_file.cc:98</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1LocalFile_html_a3d881c251c19a36eaf50483971095370"><div class="ttname"><a href="../../d7/dbd/classshaka_1_1LocalFile.html#a3d881c251c19a36eaf50483971095370">shaka::LocalFile::Close</a></div><div class="ttdeci">bool Close() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/de8/local__file_8cc_source.html#l00104">local_file.cc:104</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1LocalFile_html_a7eb47bb6ceff52c57e3eb4a21fb0ba8d"><div class="ttname"><a href="../../d7/dbd/classshaka_1_1LocalFile.html#a7eb47bb6ceff52c57e3eb4a21fb0ba8d">shaka::LocalFile::Delete</a></div><div class="ttdeci">static bool Delete(const char *file_name)</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/de8/local__file_8cc_source.html#l00199">local_file.cc:199</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1LocalFile_html_a8de3e633211e896c43319a5b6f080804"><div class="ttname"><a href="../../d7/dbd/classshaka_1_1LocalFile.html#a8de3e633211e896c43319a5b6f080804">shaka::LocalFile::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="../../d6/de8/local__file_8cc_source.html#l00184">local_file.cc:184</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1LocalFile_html_ad20649d0ee575b81830a5abf88e2bde1"><div class="ttname"><a href="../../d7/dbd/classshaka_1_1LocalFile.html#ad20649d0ee575b81830a5abf88e2bde1">shaka::LocalFile::Size</a></div><div class="ttdeci">int64_t Size() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/de8/local__file_8cc_source.html#l00138">local_file.cc:138</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1LocalFile_html_aee10b7f2898c5047eb8505f16c49311c"><div class="ttname"><a href="../../d7/dbd/classshaka_1_1LocalFile.html#aee10b7f2898c5047eb8505f16c49311c">shaka::LocalFile::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="../../d6/de8/local__file_8cc_source.html#l00126">local_file.cc:126</a></div></div>
|
|
<div class="ttc" id="aclassshaka_1_1LocalFile_html_af111d93e10ae0128f082eef77eaa914b"><div class="ttname"><a href="../../d7/dbd/classshaka_1_1LocalFile.html#af111d93e10ae0128f082eef77eaa914b">shaka::LocalFile::Tell</a></div><div class="ttdeci">bool Tell(uint64_t *position) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/de8/local__file_8cc_source.html#l00170">local_file.cc:170</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>
|