<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Portable Runtime: IP Multicast</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">Apache Portable Runtime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">IP Multicast<div class="ingroups"><a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a> » <a class="el" href="group__apr__network__io.html">Network Routines</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga731894962f9b20b2ee3ccd057053ef71"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mcast.html#ga731894962f9b20b2ee3ccd057053ef71">apr_mcast_join</a> (<a class="el" href="group__apr__network__io.html#ga49262b223e7434746e1f1737659aa2c3">apr_socket_t</a> *sock, <a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> *join, <a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> *iface, <a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> *source)</td></tr>
<tr class="separator:ga731894962f9b20b2ee3ccd057053ef71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadd3d59b5f628786093277b962c863d13"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mcast.html#gadd3d59b5f628786093277b962c863d13">apr_mcast_leave</a> (<a class="el" href="group__apr__network__io.html#ga49262b223e7434746e1f1737659aa2c3">apr_socket_t</a> *sock, <a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> *addr, <a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> *iface, <a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> *source)</td></tr>
<tr class="separator:gadd3d59b5f628786093277b962c863d13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga373041d43cb0fd05b2974b9fef0ae30f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mcast.html#ga373041d43cb0fd05b2974b9fef0ae30f">apr_mcast_hops</a> (<a class="el" href="group__apr__network__io.html#ga49262b223e7434746e1f1737659aa2c3">apr_socket_t</a> *sock, apr_byte_t ttl)</td></tr>
<tr class="separator:ga373041d43cb0fd05b2974b9fef0ae30f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga84bc14970499f79de8b71d77898f68ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mcast.html#ga84bc14970499f79de8b71d77898f68ee">apr_mcast_loopback</a> (<a class="el" href="group__apr__network__io.html#ga49262b223e7434746e1f1737659aa2c3">apr_socket_t</a> *sock, apr_byte_t opt)</td></tr>
<tr class="separator:ga84bc14970499f79de8b71d77898f68ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9949eb40d8bfb670f9bce997cebcdcae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mcast.html#ga9949eb40d8bfb670f9bce997cebcdcae">apr_mcast_interface</a> (<a class="el" href="group__apr__network__io.html#ga49262b223e7434746e1f1737659aa2c3">apr_socket_t</a> *sock, <a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> *iface)</td></tr>
<tr class="separator:ga9949eb40d8bfb670f9bce997cebcdcae"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga373041d43cb0fd05b2974b9fef0ae30f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga373041d43cb0fd05b2974b9fef0ae30f">◆ </a></span>apr_mcast_hops()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_mcast_hops </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__network__io.html#ga49262b223e7434746e1f1737659aa2c3">apr_socket_t</a> * </td>
<td class="paramname"><em>sock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_byte_t </td>
<td class="paramname"><em>ttl</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the Multicast Time to Live (ttl) for a multicast transmission. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sock</td><td>The socket to set the multicast ttl </td></tr>
<tr><td class="paramname">ttl</td><td>Time to live to Assign. 0-255, default=1 </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>If the TTL is 0, packets will only be seen by sockets on the local machine, and only when multicast loopback is enabled. </dd></dl>
</div>
</div>
<a id="ga9949eb40d8bfb670f9bce997cebcdcae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9949eb40d8bfb670f9bce997cebcdcae">◆ </a></span>apr_mcast_interface()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_mcast_interface </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__network__io.html#ga49262b223e7434746e1f1737659aa2c3">apr_socket_t</a> * </td>
<td class="paramname"><em>sock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> * </td>
<td class="paramname"><em>iface</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the Interface to be used for outgoing Multicast Transmissions. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sock</td><td>The socket to set the multicast interface on </td></tr>
<tr><td class="paramname">iface</td><td>Address of the interface to use for Multicast </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga731894962f9b20b2ee3ccd057053ef71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga731894962f9b20b2ee3ccd057053ef71">◆ </a></span>apr_mcast_join()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_mcast_join </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__network__io.html#ga49262b223e7434746e1f1737659aa2c3">apr_socket_t</a> * </td>
<td class="paramname"><em>sock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> * </td>
<td class="paramname"><em>join</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> * </td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> * </td>
<td class="paramname"><em>source</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Join a Multicast Group </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sock</td><td>The socket to join a multicast group </td></tr>
<tr><td class="paramname">join</td><td>The address of the multicast group to join </td></tr>
<tr><td class="paramname">iface</td><td>Address of the interface to use. If NULL is passed, the default multicast interface will be used. (OS Dependent) </td></tr>
<tr><td class="paramname">source</td><td>Source Address to accept transmissions from (non-NULL implies Source-Specific Multicast) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gadd3d59b5f628786093277b962c863d13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadd3d59b5f628786093277b962c863d13">◆ </a></span>apr_mcast_leave()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_mcast_leave </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__network__io.html#ga49262b223e7434746e1f1737659aa2c3">apr_socket_t</a> * </td>
<td class="paramname"><em>sock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> * </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> * </td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__sockaddr__t.html">apr_sockaddr_t</a> * </td>
<td class="paramname"><em>source</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Leave a Multicast Group. All arguments must be the same as apr_mcast_join. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sock</td><td>The socket to leave a multicast group </td></tr>
<tr><td class="paramname">addr</td><td>The address of the multicast group to leave </td></tr>
<tr><td class="paramname">iface</td><td>Address of the interface to use. If NULL is passed, the default multicast interface will be used. (OS Dependent) </td></tr>
<tr><td class="paramname">source</td><td>Source Address to accept transmissions from (non-NULL implies Source-Specific Multicast) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga84bc14970499f79de8b71d77898f68ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga84bc14970499f79de8b71d77898f68ee">◆ </a></span>apr_mcast_loopback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_mcast_loopback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__network__io.html#ga49262b223e7434746e1f1737659aa2c3">apr_socket_t</a> * </td>
<td class="paramname"><em>sock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_byte_t </td>
<td class="paramname"><em>opt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Toggle IP Multicast Loopback </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sock</td><td>The socket to set multicast loopback </td></tr>
<tr><td class="paramname">opt</td><td>0=disable, 1=enable </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
