shaka-packager/docs/d7/d7a/classshaka_1_1media_1_1UdpF...

472 lines
31 KiB
HTML
Raw Normal View History

<!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.6"/>
<title>DASH Media Packaging SDK: shaka::media::UdpFile 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">DASH Media Packaging SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
<li><a href="../../namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="../../annotated.html"><span>Classes</span></a></li>
<li><a href="../../files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="../../search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="../../annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="../../classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="../../hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="../../functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a></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"><b>media</b></li><li class="navelem"><a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html">UdpFile</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="../../d4/d5d/classshaka_1_1media_1_1UdpFile-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::UdpFile Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implements <a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html" title="Implements UdpFile, which receives UDP unicast and multicast streams. ">UdpFile</a>, which receives UDP unicast and multicast streams.
<a href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d8/d9f/udp__file_8h_source.html">udp_file.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for shaka::media::UdpFile:</div>
<div class="dyncontent">
<div class="center">
<img src="../../d7/d7a/classshaka_1_1media_1_1UdpFile.png" usemap="#shaka::media::UdpFile_map" alt=""/>
<map id="shaka::media::UdpFile_map" name="shaka::media::UdpFile_map">
<area href="../../d3/d61/classshaka_1_1media_1_1File.html" title="Define an abstract file interface. " alt="shaka::media::File" shape="rect" coords="0,0,133,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:a9668328623027330d9552f116d61ae86"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a9668328623027330d9552f116d61ae86">UdpFile</a> (const char *address_and_port)</td></tr>
<tr class="separator:a9668328623027330d9552f116d61ae86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">File implementation overrides.</div></td></tr>
<tr class="memitem:aeff24fee715763b5a62edd0d3b3c114e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#aeff24fee715763b5a62edd0d3b3c114e">Close</a> () override</td></tr>
<tr class="separator:aeff24fee715763b5a62edd0d3b3c114e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e6387d6c23e6cfd7a91ed432fe3e81c"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a9e6387d6c23e6cfd7a91ed432fe3e81c">Read</a> (void *buffer, uint64_t length) override</td></tr>
<tr class="separator:a9e6387d6c23e6cfd7a91ed432fe3e81c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7039c2dbc214f755a9eaaab4d3e10cb9"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a7039c2dbc214f755a9eaaab4d3e10cb9">Write</a> (const void *buffer, uint64_t length) override</td></tr>
<tr class="separator:a7039c2dbc214f755a9eaaab4d3e10cb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a852424c6982850686f0419e84e222708"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a852424c6982850686f0419e84e222708">Size</a> () override</td></tr>
<tr class="separator:a852424c6982850686f0419e84e222708"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66276fd0b6a7effe314ccd63e223d149"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a66276fd0b6a7effe314ccd63e223d149">Flush</a> () override</td></tr>
<tr class="separator:a66276fd0b6a7effe314ccd63e223d149"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78fa34d29e01054536a19eaac7ed51c4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a78fa34d29e01054536a19eaac7ed51c4">Seek</a> (uint64_t position) override</td></tr>
<tr class="separator:a78fa34d29e01054536a19eaac7ed51c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affb3b5c69847e5f40671e65a7110358c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#affb3b5c69847e5f40671e65a7110358c">Tell</a> (uint64_t *position) override</td></tr>
<tr class="separator:affb3b5c69847e5f40671e65a7110358c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshaka_1_1media_1_1File"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshaka_1_1media_1_1File')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">shaka::media::File</a></td></tr>
<tr class="memitem:abe158b9e7b1e073956a16c55a8fcf5f4 inherit pub_methods_classshaka_1_1media_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/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a> () const </td></tr>
<tr class="separator:abe158b9e7b1e073956a16c55a8fcf5f4 inherit pub_methods_classshaka_1_1media_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="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a67890562cd5864afdffeb7326af91df0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67890562cd5864afdffeb7326af91df0"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a67890562cd5864afdffeb7326af91df0">Open</a> () override</td></tr>
<tr class="memdesc:a67890562cd5864afdffeb7326af91df0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal open. Should not be used directly. <br/></td></tr>
<tr class="separator:a67890562cd5864afdffeb7326af91df0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classshaka_1_1media_1_1File"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classshaka_1_1media_1_1File')"><img src="../../closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">shaka::media::File</a></td></tr>
<tr class="memitem:a476502e5ab3eaed4427fd3b8468211ce inherit pro_methods_classshaka_1_1media_1_1File"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a476502e5ab3eaed4427fd3b8468211ce"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>File</b> (const std::string &amp;<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>)</td></tr>
<tr class="separator:a476502e5ab3eaed4427fd3b8468211ce inherit pro_methods_classshaka_1_1media_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb5c0673c6d8120d636385a1ad3b3f71 inherit pro_methods_classshaka_1_1media_1_1File"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#aeb5c0673c6d8120d636385a1ad3b3f71">~File</a> ()</td></tr>
<tr class="separator:aeb5c0673c6d8120d636385a1ad3b3f71 inherit pro_methods_classshaka_1_1media_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_1media_1_1File"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classshaka_1_1media_1_1File')"><img src="../../closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">shaka::media::File</a></td></tr>
<tr class="memitem:a921efa1c8f7978e3b5aac33d648b0250 inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a921efa1c8f7978e3b5aac33d648b0250">Open</a> (const char *<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>, const char *mode)</td></tr>
<tr class="separator:a921efa1c8f7978e3b5aac33d648b0250 inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1e9fc834093c8b35c0f8c1957974fda inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#ad1e9fc834093c8b35c0f8c1957974fda">OpenWithNoBuffering</a> (const char *<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>, const char *mode)</td></tr>
<tr class="separator:ad1e9fc834093c8b35c0f8c1957974fda inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92cdfd68e6384dfcc14c78b20c98368e inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a92cdfd68e6384dfcc14c78b20c98368e">Delete</a> (const char *<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>)</td></tr>
<tr class="separator:a92cdfd68e6384dfcc14c78b20c98368e inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6981994874ee5832e3394744fd51fd79 inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memItemLeft" align="right" valign="top">static int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a6981994874ee5832e3394744fd51fd79">GetFileSize</a> (const char *<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>)</td></tr>
<tr class="separator:a6981994874ee5832e3394744fd51fd79 inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a622dbc8abacebb40b816aa0174ba7c60 inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a622dbc8abacebb40b816aa0174ba7c60">ReadFileToString</a> (const char *<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#abe158b9e7b1e073956a16c55a8fcf5f4">file_name</a>, std::string *contents)</td></tr>
<tr class="separator:a622dbc8abacebb40b816aa0174ba7c60 inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afacdff207ba8359eaa029d8b1414c641 inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#afacdff207ba8359eaa029d8b1414c641">Copy</a> (const char *from_file_name, const char *to_file_name)</td></tr>
<tr class="separator:afacdff207ba8359eaa029d8b1414c641 inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c218b7f815bae0f48800b385ddce67e inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memItemLeft" align="right" valign="top">static int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a1c218b7f815bae0f48800b385ddce67e">CopyFile</a> (<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> *source, <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> *destination)</td></tr>
<tr class="separator:a1c218b7f815bae0f48800b385ddce67e inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f5ebcd3bdebb7fb02a7a7adf378b344 inherit pub_static_methods_classshaka_1_1media_1_1File"><td class="memItemLeft" align="right" valign="top">static int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html#a9f5ebcd3bdebb7fb02a7a7adf378b344">CopyFile</a> (<a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> *source, <a class="el" href="../../d3/d61/classshaka_1_1media_1_1File.html">File</a> *destination, int64_t max_copy)</td></tr>
<tr class="separator:a9f5ebcd3bdebb7fb02a7a7adf378b344 inherit pub_static_methods_classshaka_1_1media_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>Implements <a class="el" href="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html" title="Implements UdpFile, which receives UDP unicast and multicast streams. ">UdpFile</a>, which receives UDP unicast and multicast streams. </p>
<p>Definition at line <a class="el" href="../../d8/d9f/udp__file_8h_source.html#l00021">21</a> of file <a class="el" href="../../d8/d9f/udp__file_8h_source.html">udp_file.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9668328623027330d9552f116d61ae86"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">shaka::media::UdpFile::UdpFile </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>address_and_port</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_name</td><td>C string containing the address of the stream to receive. It should be of the form "&lt;ip_address&gt;:&lt;port&gt;". </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html#l00084">84</a> of file <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html">udp_file_posix.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aeff24fee715763b5a62edd0d3b3c114e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::UdpFile::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="../../d7/d7a/classshaka_1_1media_1_1UdpFile.html#a66276fd0b6a7effe314ccd63e223d149">Flush()</a> and de-allocate resources associated with this file, and delete this <a class="el" href="../../d3/d61/classshaka_1_1media_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/d61/classshaka_1_1media_1_1File.html#a2bfb0c180840356933652a795527b5c8">shaka::media::File</a>.</p>
<p>Definition at line <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html#l00090">90</a> of file <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html">udp_file_posix.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a66276fd0b6a7effe314ccd63e223d149"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::UdpFile::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="../../d9/de6/classshaka_1_1media_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/d61/classshaka_1_1media_1_1File.html#aba73e887fbfe2de3a679c679ddf03f4b">shaka::media::File</a>.</p>
<p>Definition at line <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html#l00127">127</a> of file <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html">udp_file_posix.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a9e6387d6c23e6cfd7a91ed432fe3e81c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t shaka::media::UdpFile::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/d61/classshaka_1_1media_1_1File.html#aed0c0793fd8751330583314a4d3012b9">shaka::media::File</a>.</p>
<p>Definition at line <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html#l00099">99</a> of file <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html">udp_file_posix.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a78fa34d29e01054536a19eaac7ed51c4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::UdpFile::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/d61/classshaka_1_1media_1_1File.html#a3baaa3207abaeb6af1a8239ee866b5d3">shaka::media::File</a>.</p>
<p>Definition at line <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html#l00132">132</a> of file <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html">udp_file_posix.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a852424c6982850686f0419e84e222708"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t shaka::media::UdpFile::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/d61/classshaka_1_1media_1_1File.html#adffa2c3d12ae0a579704cf1f5b3bf8ab">shaka::media::File</a>.</p>
<p>Definition at line <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html#l00120">120</a> of file <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html">udp_file_posix.cc</a>.</p>
</div>
</div>
<a class="anchor" id="affb3b5c69847e5f40671e65a7110358c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::UdpFile::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/d61/classshaka_1_1media_1_1File.html#a57dd80258b1989f85d99c154ba377db8">shaka::media::File</a>.</p>
<p>Definition at line <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html#l00137">137</a> of file <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html">udp_file_posix.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a7039c2dbc214f755a9eaaab4d3e10cb9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t shaka::media::UdpFile::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/d61/classshaka_1_1media_1_1File.html#a3149670c0d085e71f0aa085ee87fdda5">shaka::media::File</a>.</p>
<p>Definition at line <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html#l00115">115</a> of file <a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html">udp_file_posix.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>media/file/<a class="el" href="../../d8/d9f/udp__file_8h_source.html">udp_file.h</a></li>
<li>media/file/<a class="el" href="../../dc/ddf/udp__file__posix_8cc_source.html">udp_file_posix.cc</a></li>
<li>media/file/<a class="el" href="../../d3/d15/udp__file__win_8cc_source.html">udp_file_win.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 22 2016 16:48:13 for DASH Media Packaging SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>