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/d1/dc7/classshaka_1_1HttpFile.html

445 lines
32 KiB
HTML
Raw Permalink Blame 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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::HttpFile Class Reference</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.17 -->
<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');
/* @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="../../d8/daf/namespaceshaka.html">shaka</a></li><li class="navelem"><a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../df/dee/classshaka_1_1HttpFile-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::HttpFile Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d9/d2f/http__file_8h_source.html">http_file.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::HttpFile:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d1/dc7/classshaka_1_1HttpFile.png" usemap="#shaka::HttpFile_map" alt=""/>
<map id="shaka::HttpFile_map" name="shaka::HttpFile_map">
<area href="../../d3/d73/classshaka_1_1File.html" title="Define an abstract file interface." alt="shaka::File" shape="rect" coords="0,0,94,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a13a267444d0e125884dc0b65350839b0"><td class="memItemLeft" align="right" valign="top"><a id="a13a267444d0e125884dc0b65350839b0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>HttpFile</b> (HttpMethod method, const std::string &amp;url)</td></tr>
<tr class="separator:a13a267444d0e125884dc0b65350839b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9920b7b1a53c19d8511040d4b736d4ae"><td class="memItemLeft" align="right" valign="top"><a id="a9920b7b1a53c19d8511040d4b736d4ae"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>HttpFile</b> (HttpMethod method, const std::string &amp;url, const std::string &amp;upload_content_type, const std::vector&lt; std::string &gt; &amp;headers, uint32_t timeout_in_seconds)</td></tr>
<tr class="separator:a9920b7b1a53c19d8511040d4b736d4ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c3cc4cd1ddc7d32fbab25605cd6f4a2"><td class="memItemLeft" align="right" valign="top"><a id="a3c3cc4cd1ddc7d32fbab25605cd6f4a2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>HttpFile</b> (const <a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a> &amp;)=delete</td></tr>
<tr class="separator:a3c3cc4cd1ddc7d32fbab25605cd6f4a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bfea885f20bf6912c4751d7ac6069c0"><td class="memItemLeft" align="right" valign="top"><a id="a9bfea885f20bf6912c4751d7ac6069c0"></a>
<a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a> &amp;)=delete</td></tr>
<tr class="separator:a9bfea885f20bf6912c4751d7ac6069c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d46b1aedb2ac6af5f8614c385bb973d"><td class="memItemLeft" align="right" valign="top"><a id="a0d46b1aedb2ac6af5f8614c385bb973d"></a>
<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>CloseWithStatus</b> ()</td></tr>
<tr class="separator:a0d46b1aedb2ac6af5f8614c385bb973d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">File implementation overrides.</div></td></tr>
<tr class="memitem:a3fba23d4dc1f8ad1d92d2e2de377e1f6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html#a3fba23d4dc1f8ad1d92d2e2de377e1f6">Close</a> () override</td></tr>
<tr class="separator:a3fba23d4dc1f8ad1d92d2e2de377e1f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ae6eb4ad069afe42a6b3e940cefd49a"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html#a5ae6eb4ad069afe42a6b3e940cefd49a">Read</a> (void *buffer, uint64_t length) override</td></tr>
<tr class="separator:a5ae6eb4ad069afe42a6b3e940cefd49a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a412524f57722517b39d186fd10be445b"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html#a412524f57722517b39d186fd10be445b">Write</a> (const void *buffer, uint64_t length) override</td></tr>
<tr class="separator:a412524f57722517b39d186fd10be445b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa88365f37eda6210577db4a70d68319e"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html#aa88365f37eda6210577db4a70d68319e">Size</a> () override</td></tr>
<tr class="separator:aa88365f37eda6210577db4a70d68319e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad032c195629f85f8725192443518efd3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html#ad032c195629f85f8725192443518efd3">Flush</a> () override</td></tr>
<tr class="separator:ad032c195629f85f8725192443518efd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1664c0e4a8d13db5a1e1cadc5b637cd6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html#a1664c0e4a8d13db5a1e1cadc5b637cd6">Seek</a> (uint64_t position) override</td></tr>
<tr class="separator:a1664c0e4a8d13db5a1e1cadc5b637cd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97d709df373c5fcbdbcb7e61b6e4f415"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html#a97d709df373c5fcbdbcb7e61b6e4f415">Tell</a> (uint64_t *position) override</td></tr>
<tr class="separator:a97d709df373c5fcbdbcb7e61b6e4f415"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a268437f6b45da1fe07f3d541c6b6f808"><td class="memItemLeft" align="right" valign="top"><a id="a268437f6b45da1fe07f3d541c6b6f808"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html#a268437f6b45da1fe07f3d541c6b6f808">Open</a> () override</td></tr>
<tr class="memdesc:a268437f6b45da1fe07f3d541c6b6f808"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal open. Should not be used directly. <br /></td></tr>
<tr class="separator:a268437f6b45da1fe07f3d541c6b6f808"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshaka_1_1File"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshaka_1_1File')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d3/d73/classshaka_1_1File.html">shaka::File</a></td></tr>
<tr class="memitem:a4b06e08bb0295cb89fca45f9356ecbae inherit pub_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a> () const</td></tr>
<tr class="separator:a4b06e08bb0295cb89fca45f9356ecbae inherit pub_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classshaka_1_1File"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classshaka_1_1File')"><img src="../../closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="../../d3/d73/classshaka_1_1File.html">shaka::File</a></td></tr>
<tr class="memitem:ac7b5143f9b8c3e786762fe4ada2b8dcf inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d3/d73/classshaka_1_1File.html">File</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#ac7b5143f9b8c3e786762fe4ada2b8dcf">Open</a> (const char *<a class="el" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>, const char *mode)</td></tr>
<tr class="separator:ac7b5143f9b8c3e786762fe4ada2b8dcf inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a50526352bd6e946c4f33d3e8431b2d inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d3/d73/classshaka_1_1File.html">File</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#a0a50526352bd6e946c4f33d3e8431b2d">OpenWithNoBuffering</a> (const char *<a class="el" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>, const char *mode)</td></tr>
<tr class="separator:a0a50526352bd6e946c4f33d3e8431b2d inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a383c9f670511961f334569fd1a7a103b inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#a383c9f670511961f334569fd1a7a103b">Delete</a> (const char *<a class="el" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>)</td></tr>
<tr class="separator:a383c9f670511961f334569fd1a7a103b inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac978d5c0585850d4d9948fdf39b33292 inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#ac978d5c0585850d4d9948fdf39b33292">GetFileSize</a> (const char *<a class="el" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>)</td></tr>
<tr class="separator:ac978d5c0585850d4d9948fdf39b33292 inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9a19cb5fc45664ca440996bf1201c30 inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#ac9a19cb5fc45664ca440996bf1201c30">ReadFileToString</a> (const char *<a class="el" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>, std::string *contents)</td></tr>
<tr class="separator:ac9a19cb5fc45664ca440996bf1201c30 inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a483ce187d628385d342748315d72f8ab inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#a483ce187d628385d342748315d72f8ab">WriteStringToFile</a> (const char *<a class="el" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>, const std::string &amp;contents)</td></tr>
<tr class="separator:a483ce187d628385d342748315d72f8ab inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b5280fe058359b5991037f90dde2b77 inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#a4b5280fe058359b5991037f90dde2b77">WriteFileAtomically</a> (const char *<a class="el" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>, const std::string &amp;contents)</td></tr>
<tr class="separator:a4b5280fe058359b5991037f90dde2b77 inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2cbec5c6dc1c97ada010acd83b9728a inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#af2cbec5c6dc1c97ada010acd83b9728a">Copy</a> (const char *from_file_name, const char *to_file_name)</td></tr>
<tr class="separator:af2cbec5c6dc1c97ada010acd83b9728a inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85633ec9f051eb9f32b07ff7e7740d1c inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#a85633ec9f051eb9f32b07ff7e7740d1c">CopyFile</a> (<a class="el" href="../../d3/d73/classshaka_1_1File.html">File</a> *source, <a class="el" href="../../d3/d73/classshaka_1_1File.html">File</a> *destination)</td></tr>
<tr class="separator:a85633ec9f051eb9f32b07ff7e7740d1c inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07e2d2f98597320f71fb96dff74cfcb2 inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#a07e2d2f98597320f71fb96dff74cfcb2">CopyFile</a> (<a class="el" href="../../d3/d73/classshaka_1_1File.html">File</a> *source, <a class="el" href="../../d3/d73/classshaka_1_1File.html">File</a> *destination, int64_t max_copy)</td></tr>
<tr class="separator:a07e2d2f98597320f71fb96dff74cfcb2 inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8eb71689f5456ba0b1a401c57386caaf inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#a8eb71689f5456ba0b1a401c57386caaf">IsLocalRegularFile</a> (const char *<a class="el" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>)</td></tr>
<tr class="separator:a8eb71689f5456ba0b1a401c57386caaf inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a90ebd27f7728a7075cf3ba97396cae inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#a7a90ebd27f7728a7075cf3ba97396cae">MakeCallbackFileName</a> (const <a class="el" href="../../d9/da8/structshaka_1_1BufferCallbackParams.html">BufferCallbackParams</a> &amp;callback_params, const std::string &amp;name)</td></tr>
<tr class="separator:a7a90ebd27f7728a7075cf3ba97396cae inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae87642f9661588e47479721cd101bf7d inherit pub_static_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#ae87642f9661588e47479721cd101bf7d">ParseCallbackFileName</a> (const std::string &amp;callback_file_name, const <a class="el" href="../../d9/da8/structshaka_1_1BufferCallbackParams.html">BufferCallbackParams</a> **callback_params, std::string *name)</td></tr>
<tr class="separator:ae87642f9661588e47479721cd101bf7d inherit pub_static_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classshaka_1_1File"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classshaka_1_1File')"><img src="../../closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="../../d3/d73/classshaka_1_1File.html">shaka::File</a></td></tr>
<tr class="memitem:a33ead01d4090de618937d4e989a9f27f inherit pro_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top"><a id="a33ead01d4090de618937d4e989a9f27f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>File</b> (const std::string &amp;<a class="el" href="../../d3/d73/classshaka_1_1File.html#a4b06e08bb0295cb89fca45f9356ecbae">file_name</a>)</td></tr>
<tr class="separator:a33ead01d4090de618937d4e989a9f27f inherit pro_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92d1a67d1560a5290eb36447c50fabf9 inherit pro_methods_classshaka_1_1File"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d73/classshaka_1_1File.html#a92d1a67d1560a5290eb36447c50fabf9">~File</a> ()</td></tr>
<tr class="separator:a92d1a67d1560a5290eb36447c50fabf9 inherit pro_methods_classshaka_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html">HttpFile</a> reads or writes network requests.</p>
<p>Note that calling Flush will indicate EOF for the upload and no more can be uploaded.</p>
<p>About how to use this, please visit the corresponding documentation [1].</p>
<p>[1] <a href="https://google.github.io/shaka-packager/html/tutorials/http_upload.html">https://google.github.io/shaka-packager/html/tutorials/http_upload.html</a> </p>
<p class="definition">Definition at line <a class="el" href="../../d9/d2f/http__file_8h_source.html#l00038">38</a> of file <a class="el" href="../../d9/d2f/http__file_8h_source.html">http_file.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a3fba23d4dc1f8ad1d92d2e2de377e1f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fba23d4dc1f8ad1d92d2e2de377e1f6">&#9670;&nbsp;</a></span>Close()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::HttpFile::Close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="../../d1/dc7/classshaka_1_1HttpFile.html#ad032c195629f85f8725192443518efd3">Flush()</a> and de-allocate resources associated with this file, and delete this <a class="el" href="../../d3/d73/classshaka_1_1File.html" title="Define an abstract file interface.">File</a> object. THIS IS THE ONE TRUE WAY TO DEALLOCATE THIS OBJECT. </p><dl class="section return"><dt>Returns</dt><dd>true on success. For writable files, returning false MAY INDICATE DATA LOSS. </dd></dl>
<p>Implements <a class="el" href="../../d3/d73/classshaka_1_1File.html#a932666ed1d6a565bf387a9d8b39a8948">shaka::File</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../d8/d16/http__file_8cc_source.html#l00236">236</a> of file <a class="el" href="../../d8/d16/http__file_8cc_source.html">http_file.cc</a>.</p>
</div>
</div>
<a id="ad032c195629f85f8725192443518efd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad032c195629f85f8725192443518efd3">&#9670;&nbsp;</a></span>Flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::HttpFile::Flush </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush the file so that recently written data will survive an application crash (but not necessarily an OS crash). For instance, in <a class="el" href="../../d7/dbd/classshaka_1_1LocalFile.html" title="Implement LocalFile which deals with local storage.">LocalFile</a> the data is flushed into the OS but not necessarily to disk. </p><dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
<p>Implements <a class="el" href="../../d3/d73/classshaka_1_1File.html#a5fa625751e03b9e7652ba1bfa98b8ca4">shaka::File</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../d8/d16/http__file_8cc_source.html#l00255">255</a> of file <a class="el" href="../../d8/d16/http__file_8cc_source.html">http_file.cc</a>.</p>
</div>
</div>
<a id="a5ae6eb4ad069afe42a6b3e940cefd49a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ae6eb4ad069afe42a6b3e940cefd49a">&#9670;&nbsp;</a></span>Read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t shaka::HttpFile::Read </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data and return it in buffer. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>points to a block of memory with a size of at least <em>length</em> bytes. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">length</td><td>indicates number of bytes to be read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes read, or a value &lt; 0 on error. Zero on end-of-file, or if 'length' is zero. </dd></dl>
<p>Implements <a class="el" href="../../d3/d73/classshaka_1_1File.html#a6e1ecb2904b609554d332290f20fde0a">shaka::File</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../d8/d16/http__file_8cc_source.html#l00240">240</a> of file <a class="el" href="../../d8/d16/http__file_8cc_source.html">http_file.cc</a>.</p>
</div>
</div>
<a id="a1664c0e4a8d13db5a1e1cadc5b637cd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1664c0e4a8d13db5a1e1cadc5b637cd6">&#9670;&nbsp;</a></span>Seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::HttpFile::Seek </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>position</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Seek to the specifield position in the file. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>is the position to seek to. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise. </dd></dl>
<p>Implements <a class="el" href="../../d3/d73/classshaka_1_1File.html#a486bda715b58b1a1863fbfc8d48da62a">shaka::File</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../d8/d16/http__file_8cc_source.html#l00260">260</a> of file <a class="el" href="../../d8/d16/http__file_8cc_source.html">http_file.cc</a>.</p>
</div>
</div>
<a id="aa88365f37eda6210577db4a70d68319e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa88365f37eda6210577db4a70d68319e">&#9670;&nbsp;</a></span>Size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t shaka::HttpFile::Size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Size of the file in bytes. A return value less than zero indicates a problem getting the size. </dd></dl>
<p>Implements <a class="el" href="../../d3/d73/classshaka_1_1File.html#aeb98b64a05f141140e110170bef1bc55">shaka::File</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../d8/d16/http__file_8cc_source.html#l00250">250</a> of file <a class="el" href="../../d8/d16/http__file_8cc_source.html">http_file.cc</a>.</p>
</div>
</div>
<a id="a97d709df373c5fcbdbcb7e61b6e4f415"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97d709df373c5fcbdbcb7e61b6e4f415">&#9670;&nbsp;</a></span>Tell()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::HttpFile::Tell </td>
<td>(</td>
<td class="paramtype">uint64_t *&#160;</td>
<td class="paramname"><em>position</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current file position. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>is a pointer to contain the current file position upon successful return. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on succcess, false otherwise. </dd></dl>
<p>Implements <a class="el" href="../../d3/d73/classshaka_1_1File.html#a07ae6476e88dab6c0cd9d8c0073b667d">shaka::File</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../d8/d16/http__file_8cc_source.html#l00265">265</a> of file <a class="el" href="../../d8/d16/http__file_8cc_source.html">http_file.cc</a>.</p>
</div>
</div>
<a id="a412524f57722517b39d186fd10be445b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a412524f57722517b39d186fd10be445b">&#9670;&nbsp;</a></span>Write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t shaka::HttpFile::Write </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write block of data. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>points to a block of memory with at least <em>length</em> bytes. </td></tr>
<tr><td class="paramname">length</td><td>indicates number of bytes to write. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes written, or a value &lt; 0 on error. </dd></dl>
<p>Implements <a class="el" href="../../d3/d73/classshaka_1_1File.html#a8c498531ecbd205fceb0be3478361801">shaka::File</a>.</p>
<p class="definition">Definition at line <a class="el" href="../../d8/d16/http__file_8cc_source.html#l00245">245</a> of file <a class="el" href="../../d8/d16/http__file_8cc_source.html">http_file.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>packager/file/<a class="el" href="../../d9/d2f/http__file_8h_source.html">http_file.h</a></li>
<li>packager/file/<a class="el" href="../../d8/d16/http__file_8cc_source.html">http_file.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 22 2021 00:16:05 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.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink