trAvis - MANAGER
Edit File: group__apr__mcast.html
<!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.5"/> <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/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">Apache Portable Runtime </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <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 Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</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><!-- top --> <!-- 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</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 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__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 class="anchor" id="ga373041d43cb0fd05b2974b9fef0ae30f"></a> <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 class="anchor" id="ga9949eb40d8bfb670f9bce997cebcdcae"></a> <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 class="anchor" id="ga731894962f9b20b2ee3ccd057053ef71"></a> <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 class="anchor" id="gadd3d59b5f628786093277b962c863d13"></a> <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 class="anchor" id="ga84bc14970499f79de8b71d77898f68ee"></a> <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.5 </small></address> </body> </html>