shaka-packager/docs/dd/d3e/callback__file_8cc_source.html

93 lines
21 KiB
HTML

<!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"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: packager/file/callback_file.cc 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.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<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>
<!-- 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">callback_file.cc</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2017 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">#include &quot;packager/file/callback_file.h&quot;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;packager/base/logging.h&quot;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="../../dd/d40/classshaka_1_1CallbackFile.html#a0e1e50e81d926b17938b0dad89d1c05f"> 13</a></span>&#160;<a class="code" href="../../dd/d40/classshaka_1_1CallbackFile.html#a0e1e50e81d926b17938b0dad89d1c05f">CallbackFile::CallbackFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* file_name, <span class="keyword">const</span> <span class="keywordtype">char</span>* mode)</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; : <a class="code" href="../../d3/d73/classshaka_1_1File.html">File</a>(file_name), file_mode_(mode) {}</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;CallbackFile::~CallbackFile() {}</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="../../dd/d40/classshaka_1_1CallbackFile.html#aac23ef04e5bafef7d5b4c5d7a3fcfbb5"> 18</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="../../dd/d40/classshaka_1_1CallbackFile.html#aac23ef04e5bafef7d5b4c5d7a3fcfbb5">CallbackFile::Close</a>() {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">delete</span> <span class="keyword">this</span>;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;}</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="../../dd/d40/classshaka_1_1CallbackFile.html#a867e0c5eaf81a41902e1370deb912617"> 23</a></span>&#160;int64_t <a class="code" href="../../dd/d40/classshaka_1_1CallbackFile.html#a867e0c5eaf81a41902e1370deb912617">CallbackFile::Read</a>(<span class="keywordtype">void</span>* buffer, uint64_t length) {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keywordflow">if</span> (!callback_params_-&gt;<a class="code" href="../../d9/da8/structshaka_1_1BufferCallbackParams.html#a6e6e97682ba2be686a2d1e9b62d26e13">read_func</a>) {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; LOG(ERROR) &lt;&lt; <span class="stringliteral">&quot;Read function not defined.&quot;</span>;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; }</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">return</span> callback_params_-&gt;<a class="code" href="../../d9/da8/structshaka_1_1BufferCallbackParams.html#a6e6e97682ba2be686a2d1e9b62d26e13">read_func</a>(name_, buffer, length);</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;}</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="../../dd/d40/classshaka_1_1CallbackFile.html#aa758dfb05daff81afa1ddfaf0bb0a105"> 31</a></span>&#160;int64_t <a class="code" href="../../dd/d40/classshaka_1_1CallbackFile.html#aa758dfb05daff81afa1ddfaf0bb0a105">CallbackFile::Write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, uint64_t length) {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">if</span> (!callback_params_-&gt;<a class="code" href="../../d9/da8/structshaka_1_1BufferCallbackParams.html#ad966040c5a75389ac6376c6378a0f307">write_func</a>) {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; LOG(ERROR) &lt;&lt; <span class="stringliteral">&quot;Write function not defined.&quot;</span>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; }</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">return</span> callback_params_-&gt;<a class="code" href="../../d9/da8/structshaka_1_1BufferCallbackParams.html#ad966040c5a75389ac6376c6378a0f307">write_func</a>(name_, buffer, length);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;}</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="../../dd/d40/classshaka_1_1CallbackFile.html#ab6bcbc6773b29fee1664507558e8759f"> 39</a></span>&#160;int64_t <a class="code" href="../../dd/d40/classshaka_1_1CallbackFile.html#ab6bcbc6773b29fee1664507558e8759f">CallbackFile::Size</a>() {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; LOG(INFO) &lt;&lt; <span class="stringliteral">&quot;CallbackFile does not support Size().&quot;</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">return</span> -1;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;}</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="../../dd/d40/classshaka_1_1CallbackFile.html#aef34f60f2e94f862e495c254edc58bd9"> 44</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="../../dd/d40/classshaka_1_1CallbackFile.html#aef34f60f2e94f862e495c254edc58bd9">CallbackFile::Flush</a>() {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// Do nothing on Flush.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;}</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="../../dd/d40/classshaka_1_1CallbackFile.html#a7c9039e25fcc468a7ec2cdfa8394ffc2"> 49</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="../../dd/d40/classshaka_1_1CallbackFile.html#a7c9039e25fcc468a7ec2cdfa8394ffc2">CallbackFile::Seek</a>(uint64_t position) {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; VLOG(1) &lt;&lt; <span class="stringliteral">&quot;CallbackFile does not support Seek().&quot;</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;}</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="../../dd/d40/classshaka_1_1CallbackFile.html#adef67a4de398b8be95bb3ae4ce770d69"> 54</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="../../dd/d40/classshaka_1_1CallbackFile.html#adef67a4de398b8be95bb3ae4ce770d69">CallbackFile::Tell</a>(uint64_t* position) {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; VLOG(1) &lt;&lt; <span class="stringliteral">&quot;CallbackFile does not support Tell().&quot;</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;}</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="../../dd/d40/classshaka_1_1CallbackFile.html#ac7260f6114fc4f234df79a163abc6c0e"> 59</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="../../dd/d40/classshaka_1_1CallbackFile.html#ac7260f6114fc4f234df79a163abc6c0e">CallbackFile::Open</a>() {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">if</span> (file_mode_ != <span class="stringliteral">&quot;r&quot;</span> &amp;&amp; file_mode_ != <span class="stringliteral">&quot;w&quot;</span> &amp;&amp; file_mode_ != <span class="stringliteral">&quot;rb&quot;</span> &amp;&amp;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; file_mode_ != <span class="stringliteral">&quot;wb&quot;</span>) {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; LOG(ERROR) &lt;&lt; <span class="stringliteral">&quot;CallbackFile does not support file mode &quot;</span> &lt;&lt; file_mode_;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">return</span> <a class="code" href="../../d3/d73/classshaka_1_1File.html#ae87642f9661588e47479721cd101bf7d">ParseCallbackFileName</a>(<a class="code" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>(), &amp;callback_params_, &amp;name_);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;}</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;} <span class="comment">// namespace shaka</span></div><div class="ttc" id="classshaka_1_1CallbackFile_html_aac23ef04e5bafef7d5b4c5d7a3fcfbb5"><div class="ttname"><a href="../../dd/d40/classshaka_1_1CallbackFile.html#aac23ef04e5bafef7d5b4c5d7a3fcfbb5">shaka::CallbackFile::Close</a></div><div class="ttdeci">bool Close() override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d3e/callback__file_8cc_source.html#l00018">callback_file.cc:18</a></div></div>
<div class="ttc" id="structshaka_1_1BufferCallbackParams_html_a6e6e97682ba2be686a2d1e9b62d26e13"><div class="ttname"><a href="../../d9/da8/structshaka_1_1BufferCallbackParams.html#a6e6e97682ba2be686a2d1e9b62d26e13">shaka::BufferCallbackParams::read_func</a></div><div class="ttdeci">std::function&lt; int64_t(const std::string &amp;name, void *buffer, uint64_t size)&gt; read_func</div><div class="ttdef"><b>Definition:</b> <a href="../../dc/da3/buffer__callback__params_8h_source.html#l00020">buffer_callback_params.h:20</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_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 &amp; file_name() const</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d4d/file_8h_source.html#l00094">file.h:94</a></div></div>
<div class="ttc" id="classshaka_1_1CallbackFile_html_aa758dfb05daff81afa1ddfaf0bb0a105"><div class="ttname"><a href="../../dd/d40/classshaka_1_1CallbackFile.html#aa758dfb05daff81afa1ddfaf0bb0a105">shaka::CallbackFile::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="../../dd/d3e/callback__file_8cc_source.html#l00031">callback_file.cc:31</a></div></div>
<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>
<div class="ttc" id="classshaka_1_1CallbackFile_html_adef67a4de398b8be95bb3ae4ce770d69"><div class="ttname"><a href="../../dd/d40/classshaka_1_1CallbackFile.html#adef67a4de398b8be95bb3ae4ce770d69">shaka::CallbackFile::Tell</a></div><div class="ttdeci">bool Tell(uint64_t *position) override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d3e/callback__file_8cc_source.html#l00054">callback_file.cc:54</a></div></div>
<div class="ttc" id="classshaka_1_1CallbackFile_html_aef34f60f2e94f862e495c254edc58bd9"><div class="ttname"><a href="../../dd/d40/classshaka_1_1CallbackFile.html#aef34f60f2e94f862e495c254edc58bd9">shaka::CallbackFile::Flush</a></div><div class="ttdeci">bool Flush() override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d3e/callback__file_8cc_source.html#l00044">callback_file.cc:44</a></div></div>
<div class="ttc" id="classshaka_1_1CallbackFile_html_a7c9039e25fcc468a7ec2cdfa8394ffc2"><div class="ttname"><a href="../../dd/d40/classshaka_1_1CallbackFile.html#a7c9039e25fcc468a7ec2cdfa8394ffc2">shaka::CallbackFile::Seek</a></div><div class="ttdeci">bool Seek(uint64_t position) override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d3e/callback__file_8cc_source.html#l00049">callback_file.cc:49</a></div></div>
<div class="ttc" id="structshaka_1_1BufferCallbackParams_html_ad966040c5a75389ac6376c6378a0f307"><div class="ttname"><a href="../../d9/da8/structshaka_1_1BufferCallbackParams.html#ad966040c5a75389ac6376c6378a0f307">shaka::BufferCallbackParams::write_func</a></div><div class="ttdeci">std::function&lt; int64_t(const std::string &amp;name, const void *buffer, uint64_t size)&gt; write_func</div><div class="ttdef"><b>Definition:</b> <a href="../../dc/da3/buffer__callback__params_8h_source.html#l00030">buffer_callback_params.h:30</a></div></div>
<div class="ttc" id="classshaka_1_1File_html_ae87642f9661588e47479721cd101bf7d"><div class="ttname"><a href="../../d3/d73/classshaka_1_1File.html#ae87642f9661588e47479721cd101bf7d">shaka::File::ParseCallbackFileName</a></div><div class="ttdeci">static bool ParseCallbackFileName(const std::string &amp;callback_file_name, const BufferCallbackParams **callback_params, std::string *name)</div><div class="ttdef"><b>Definition:</b> <a href="../../d5/dfc/file_8cc_source.html#l00364">file.cc:364</a></div></div>
<div class="ttc" id="classshaka_1_1CallbackFile_html_ac7260f6114fc4f234df79a163abc6c0e"><div class="ttname"><a href="../../dd/d40/classshaka_1_1CallbackFile.html#ac7260f6114fc4f234df79a163abc6c0e">shaka::CallbackFile::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="../../dd/d3e/callback__file_8cc_source.html#l00059">callback_file.cc:59</a></div></div>
<div class="ttc" id="classshaka_1_1CallbackFile_html_a867e0c5eaf81a41902e1370deb912617"><div class="ttname"><a href="../../dd/d40/classshaka_1_1CallbackFile.html#a867e0c5eaf81a41902e1370deb912617">shaka::CallbackFile::Read</a></div><div class="ttdeci">int64_t Read(void *buffer, uint64_t length) override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d3e/callback__file_8cc_source.html#l00023">callback_file.cc:23</a></div></div>
<div class="ttc" id="classshaka_1_1CallbackFile_html_a0e1e50e81d926b17938b0dad89d1c05f"><div class="ttname"><a href="../../dd/d40/classshaka_1_1CallbackFile.html#a0e1e50e81d926b17938b0dad89d1c05f">shaka::CallbackFile::CallbackFile</a></div><div class="ttdeci">CallbackFile(const char *file_name, const char *mode)</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d3e/callback__file_8cc_source.html#l00013">callback_file.cc:13</a></div></div>
<div class="ttc" id="classshaka_1_1CallbackFile_html_ab6bcbc6773b29fee1664507558e8759f"><div class="ttname"><a href="../../dd/d40/classshaka_1_1CallbackFile.html#ab6bcbc6773b29fee1664507558e8759f">shaka::CallbackFile::Size</a></div><div class="ttdeci">int64_t Size() override</div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d3e/callback__file_8cc_source.html#l00039">callback_file.cc:39</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 20 2018 14:37:37 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>