shaka-packager/docs/d9/dfe/classshaka_1_1UdpOptions.html

164 lines
9.4 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"/>
2018-02-10 23:37:42 +00:00
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::UdpOptions 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"/>
2018-02-10 23:37:42 +00:00
<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;">
2018-02-10 23:37:42 +00:00
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Shaka Packager SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2018-02-10 23:37:42 +00:00
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
2018-02-10 23:37:42 +00:00
<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)">
2018-02-10 23:37:42 +00:00
</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="../../d9/dfe/classshaka_1_1UdpOptions.html">UdpOptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="../../d6/d74/classshaka_1_1UdpOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::UdpOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Options parsed from UDP url string of the form: udp://ip:port[?options].
<a href="../../d9/dfe/classshaka_1_1UdpOptions.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../de/dbf/udp__options_8h_source.html">udp_options.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a5fc4a86f29f92e4ad62fb87460a46dc0"><td class="memItemLeft" align="right" valign="top"><a id="a5fc4a86f29f92e4ad62fb87460a46dc0"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>address</b> () const</td></tr>
<tr class="separator:a5fc4a86f29f92e4ad62fb87460a46dc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf1b50b9117295f59d1d378270bedfe7"><td class="memItemLeft" align="right" valign="top"><a id="aaf1b50b9117295f59d1d378270bedfe7"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>port</b> () const</td></tr>
<tr class="separator:aaf1b50b9117295f59d1d378270bedfe7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbeb3b57cba5527aa853e719dbde3b7e"><td class="memItemLeft" align="right" valign="top"><a id="abbeb3b57cba5527aa853e719dbde3b7e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>reuse</b> () const</td></tr>
<tr class="separator:abbeb3b57cba5527aa853e719dbde3b7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acda2b3bdfc2ad0ddfedf1cffa8227c39"><td class="memItemLeft" align="right" valign="top"><a id="acda2b3bdfc2ad0ddfedf1cffa8227c39"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>interface_address</b> () const</td></tr>
<tr class="separator:acda2b3bdfc2ad0ddfedf1cffa8227c39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c397584b9056520f9fa9954029f920e"><td class="memItemLeft" align="right" valign="top"><a id="a5c397584b9056520f9fa9954029f920e"></a>
unsigned&#160;</td><td class="memItemRight" valign="bottom"><b>timeout_us</b> () const</td></tr>
<tr class="separator:a5c397584b9056520f9fa9954029f920e"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-05-23 23:12:00 +00:00
<tr class="memitem:a37315d92b02d42584041413a777765a5"><td class="memItemLeft" align="right" valign="top"><a id="a37315d92b02d42584041413a777765a5"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>source_address</b> () const</td></tr>
<tr class="separator:a37315d92b02d42584041413a777765a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12fca4deb02a16d7ed9133adf0a5500c"><td class="memItemLeft" align="right" valign="top"><a id="a12fca4deb02a16d7ed9133adf0a5500c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_source_specific_multicast</b> () const</td></tr>
<tr class="separator:a12fca4deb02a16d7ed9133adf0a5500c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2691d7ec4b85dfec8ecdb685374f06a"><td class="memItemLeft" align="right" valign="top"><a id="ae2691d7ec4b85dfec8ecdb685374f06a"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>buffer_size</b> () const</td></tr>
<tr class="separator:ae2691d7ec4b85dfec8ecdb685374f06a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
2018-02-10 23:37:42 +00:00
<tr class="memitem:a3dff92e7ffb1ed0864dd87842aa2ad03"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; <a class="el" href="../../d9/dfe/classshaka_1_1UdpOptions.html">UdpOptions</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/dfe/classshaka_1_1UdpOptions.html#a3dff92e7ffb1ed0864dd87842aa2ad03">ParseFromString</a> (base::StringPiece udp_url)</td></tr>
<tr class="separator:a3dff92e7ffb1ed0864dd87842aa2ad03"><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>Options parsed from UDP url string of the form: udp://ip:port[?options]. </p>
2018-02-10 23:37:42 +00:00
<p class="definition">Definition at line <a class="el" href="../../de/dbf/udp__options_8h_source.html#l00015">15</a> of file <a class="el" href="../../de/dbf/udp__options_8h_source.html">udp_options.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
2018-02-10 23:37:42 +00:00
<a id="a3dff92e7ffb1ed0864dd87842aa2ad03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dff92e7ffb1ed0864dd87842aa2ad03">&#9670;&nbsp;</a></span>ParseFromString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt; <a class="el" href="../../d9/dfe/classshaka_1_1UdpOptions.html">UdpOptions</a> &gt; shaka::UdpOptions::ParseFromString </td>
<td>(</td>
<td class="paramtype">base::StringPiece&#160;</td>
<td class="paramname"><em>udp_url</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2018-02-10 23:37:42 +00:00
<p>Parse from UDP url. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">udp_url</td><td>is the url of the form udp://ip:port[?options] </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="../../d9/dfe/classshaka_1_1UdpOptions.html" title="Options parsed from UDP url string of the form: udp://ip:port[?options]. ">UdpOptions</a> object on success, nullptr otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../da/d1d/udp__options_8cc_source.html#l00075">75</a> of file <a class="el" href="../../da/d1d/udp__options_8cc_source.html">udp_options.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="../../de/dbf/udp__options_8h_source.html">udp_options.h</a></li>
<li>packager/file/<a class="el" href="../../da/d1d/udp__options_8cc_source.html">udp_options.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 20 2018 10:46:53 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
2018-02-10 23:37:42 +00:00
</a> 1.8.13
</small></address>
</body>
</html>