shaka-packager/docs/d9/d2f/http__file_8h_source.html

173 lines
20 KiB
HTML
Raw Normal View History

<!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/http_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&amp;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&amp;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">http_file.h</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 2020 Google LLC. 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_HTTP_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define PACKAGER_FILE_HTTP_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 &lt;string&gt;</span></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"> 13</span>&#160;<span class="preprocessor">#include &quot;packager/base/synchronization/waitable_event.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.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;<span class="preprocessor">#include &quot;packager/status.h&quot;</span></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"> 18</span>&#160;<span class="keyword">typedef</span> <span class="keywordtype">void</span> CURL;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">struct </span>curl_slist;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</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"> 23</span>&#160;<span class="keyword">enum class</span> HttpMethod {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; kGet,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; kPost,</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; kPut,</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; </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="../../d1/dc7/classshaka_1_1HttpFile.html"> 38</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a> : <span class="keyword">public</span> <a class="code" href="../../d3/d73/classshaka_1_1File.html">File</a> {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a>(HttpMethod method, <span class="keyword">const</span> std::string&amp; url);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a>(HttpMethod method,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">const</span> std::string&amp; url,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">const</span> std::string&amp; upload_content_type,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; headers,</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; uint32_t timeout_in_seconds);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a>(<span class="keyword">const</span> <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> CloseWithStatus();</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html#a3fba23d4dc1f8ad1d92d2e2de377e1f6">Close</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; int64_t <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html#a5ae6eb4ad069afe42a6b3e940cefd49a">Read</a>(<span class="keywordtype">void</span>* buffer, uint64_t length) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; int64_t <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html#a412524f57722517b39d186fd10be445b">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="l00057"></a><span class="lineno"> 57</span>&#160; int64_t <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html#aa88365f37eda6210577db4a70d68319e">Size</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html#ad032c195629f85f8725192443518efd3">Flush</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html#a1664c0e4a8d13db5a1e1cadc5b637cd6">Seek</a>(uint64_t position) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html#a97d709df373c5fcbdbcb7e61b6e4f415">Tell</a>(uint64_t* position) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html#a268437f6b45da1fe07f3d541c6b6f808">Open</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; ~<a class="code" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a>() <span class="keyword">override</span>;</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; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">struct </span>CurlDelete {</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">void</span> operator()(CURL* curl);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordtype">void</span> operator()(curl_slist* headers);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; };</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">void</span> SetupRequest();</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">void</span> ThreadMain();</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">const</span> std::string url_;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">const</span> std::string upload_content_type_;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">const</span> uint32_t timeout_in_seconds_;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">const</span> HttpMethod method_;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="../../df/d4e/classshaka_1_1IoCache.html">IoCache</a> download_cache_;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="../../df/d4e/classshaka_1_1IoCache.html">IoCache</a> upload_cache_;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; std::unique_ptr&lt;CURL, CurlDelete&gt; curl_;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="comment">// The headers need to remain alive for the duration of the request.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; std::unique_ptr&lt;curl_slist, CurlDelete&gt; request_headers_;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> status_;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="comment">// Signaled when the &quot;curl easy perform&quot; task completes.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; base::WaitableEvent task_exit_event_;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;};</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;} <span class="comment">// namespace shaka</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// PACKAGER_FILE_HTTP_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_1HttpFile_html"><div class="ttname"><a href="../../d1/dc7/classshaka_1_1HttpFile.html">shaka::HttpFile</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d9/d2f/http__file_8h_source.html#l00038">http_file.h:38</a></div></div>
<div class="ttc" id="aclassshaka_1_1HttpFile_html_a1664c0e4a8d13db5a1e1cadc5b637cd6"><div class="ttname"><a href="../../d1/dc7/classshaka_1_1HttpFile.html#a1664c0e4a8d13db5a1e1cadc5b637cd6">shaka::HttpFile::Seek</a></div><div class="ttdeci">bool Seek(uint64_t position) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d16/http__file_8cc_source.html#l00248">http_file.cc:248</a></div></div>
<div class="ttc" id="aclassshaka_1_1HttpFile_html_a268437f6b45da1fe07f3d541c6b6f808"><div class="ttname"><a href="../../d1/dc7/classshaka_1_1HttpFile.html#a268437f6b45da1fe07f3d541c6b6f808">shaka::HttpFile::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="../../d8/d16/http__file_8cc_source.html#l00191">http_file.cc:191</a></div></div>
<div class="ttc" id="aclassshaka_1_1HttpFile_html_a3fba23d4dc1f8ad1d92d2e2de377e1f6"><div class="ttname"><a href="../../d1/dc7/classshaka_1_1HttpFile.html#a3fba23d4dc1f8ad1d92d2e2de377e1f6">shaka::HttpFile::Close</a></div><div class="ttdeci">bool Close() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d16/http__file_8cc_source.html#l00224">http_file.cc:224</a></div></div>
<div class="ttc" id="aclassshaka_1_1HttpFile_html_a412524f57722517b39d186fd10be445b"><div class="ttname"><a href="../../d1/dc7/classshaka_1_1HttpFile.html#a412524f57722517b39d186fd10be445b">shaka::HttpFile::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="../../d8/d16/http__file_8cc_source.html#l00233">http_file.cc:233</a></div></div>
<div class="ttc" id="aclassshaka_1_1HttpFile_html_a5ae6eb4ad069afe42a6b3e940cefd49a"><div class="ttname"><a href="../../d1/dc7/classshaka_1_1HttpFile.html#a5ae6eb4ad069afe42a6b3e940cefd49a">shaka::HttpFile::Read</a></div><div class="ttdeci">int64_t Read(void *buffer, uint64_t length) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d16/http__file_8cc_source.html#l00228">http_file.cc:228</a></div></div>
<div class="ttc" id="aclassshaka_1_1HttpFile_html_a97d709df373c5fcbdbcb7e61b6e4f415"><div class="ttname"><a href="../../d1/dc7/classshaka_1_1HttpFile.html#a97d709df373c5fcbdbcb7e61b6e4f415">shaka::HttpFile::Tell</a></div><div class="ttdeci">bool Tell(uint64_t *position) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d16/http__file_8cc_source.html#l00253">http_file.cc:253</a></div></div>
<div class="ttc" id="aclassshaka_1_1HttpFile_html_aa88365f37eda6210577db4a70d68319e"><div class="ttname"><a href="../../d1/dc7/classshaka_1_1HttpFile.html#aa88365f37eda6210577db4a70d68319e">shaka::HttpFile::Size</a></div><div class="ttdeci">int64_t Size() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d16/http__file_8cc_source.html#l00238">http_file.cc:238</a></div></div>
<div class="ttc" id="aclassshaka_1_1HttpFile_html_ad032c195629f85f8725192443518efd3"><div class="ttname"><a href="../../d1/dc7/classshaka_1_1HttpFile.html#ad032c195629f85f8725192443518efd3">shaka::HttpFile::Flush</a></div><div class="ttdeci">bool Flush() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d16/http__file_8cc_source.html#l00243">http_file.cc:243</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_1Status_html"><div class="ttname"><a href="../../d2/d20/classshaka_1_1Status.html">shaka::Status</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d13/status_8h_source.html#l00110">status.h:110</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 Fri Apr 9 2021 21:00:12 for Shaka Packager SDK by&#160;<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>