Diff of autodoc.git/traditional_manual/chapter_9.html (c9603724f0901ff4196ba043c0f16bc4801a472c » 402d187d25da5a6c108ab8699423595202bd5f23)

autodoc.git/traditional_manual/chapter_9.html:2690: <hr /> <dl class='group--doc'> <dt class='head--type'>Method add_membership </dt> <dd><code><code class='datatype'>int</code> add_membership(<code class='datatype'>string</code> <code class='argument'>group</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>address</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Join a multicast group. <code>group</code> contains the address of the - multicast group the application wants to join or leave. It must be - a valid multicast address. <code>address</code> is the address of the local - interface with wich the system should join to the multicast group. - If not provided the system will select an appropriate interface. - See also the Unix man page for setsocketopt IPPROTO_IP - ADD_MEMBERSHIP. + <dd class='body--doc'>Join a multicast group. </dd> - + <dt class='head--doc'>Parameter <code class='parameter'>group</code></dt> + <dd></dd><dd class='body--doc'><code>group</code> contains the address of the multicast group the + application wants to join. It must be a valid multicast address. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>address</code></dt> + <dd></dd><dd class='body--doc'><code>address</code> is the address of the local interface with which + the system should join to the multicast group. If not provided + the system will select an appropriate interface. + See also the Unix man page for setsocketopt IPPROTO_IP IP_ADD_MEMBERSHIP + and IPPROTO_IPV6 IPV6_ADD_MEMBERSHIP. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The <code>address</code> parameter is currently not supported for IPv6. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function did not support IPv6 in Pike 7.8 and earlier. + </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>drop_membership</code> + <dd class='body--doc'><code>drop_membership()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method bind </dt> <dd><code><code class='object unresolved'>UDP</code> bind(<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>port</code>)</code> <code><code class='object unresolved'>UDP</code> bind(<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>port</code>, <code class='datatype'>string</code> <code class='argument'>address</code>)</code></dd>
autodoc.git/traditional_manual/chapter_9.html:2770: <hr /> <dl class='group--doc'> <dt class='head--type'>Method drop_membership </dt> <dd><code><code class='datatype'>int</code> drop_membership(<code class='datatype'>string</code> <code class='argument'>group</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>address</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Leave a multicast group. </dd> + <dt class='head--doc'>Parameter <code class='parameter'>group</code></dt> + <dd></dd><dd class='body--doc'><code>group</code> contains the address of the multicast group the + application wants to join. It must be a valid multicast address. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>address</code></dt> + <dd></dd><dd class='body--doc'><code>address</code> is the address of the local interface with which + the system should join to the multicast group. If not provided + the system will select an appropriate interface. + See also the Unix man page for setsocketopt IPPROTO_IP IP_DROP_MEMBERSHIP + and IPPROTO_IPV6 IPV6_DROP_MEMBERSHIP. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The <code>address</code> parameter is currently not supported for IPv6. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function did not support IPv6 in Pike 7.8 and earlier. + </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>add_membership</code> + <dd class='body--doc'><code>add_membership()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method enable_broadcast </dt> <dd><code><code class='datatype'>bool</code> enable_broadcast()</code></dd>
autodoc.git/traditional_manual/chapter_9.html:2804: <hr /> <dl class='group--doc'> <dt class='head--type'>Method enable_multicast </dt> <dd><code><code class='datatype'>bool</code> enable_multicast(<code class='datatype'>string</code> <code class='argument'>reply_address</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Set the local device for a multicast socket. See also the Unix man - page for setsocketopt IPPROTO_IP IP_MULTICAST_IF. + <dd class='body--doc'>Set the local device for a multicast socket. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>reply_address</code></dt> + <dd></dd><dd class='body--doc'>Local address that should appear in the multicast packets. + See also the Unix man page for setsocketopt IPPROTO_IP IP_MULTICAST_IF + and IPPROTO_IPV6 IPV6_MULTICAST_IF. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function did not support IPv6 in Pike 7.8. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method errno </dt> <dd><code><code class='datatype'>int</code> errno()</code></dd>
autodoc.git/traditional_manual/chapter_9.html:2979: <hr /> <dl class='group--doc'> <dt class='head--type'>Method set_multicast_ttl </dt> <dd><code><code class='datatype'>int</code> set_multicast_ttl(<code class='datatype'>int</code> <code class='argument'>ttl</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Set the time-to-live value of outgoing multicast packets for this - socket. It is very important for multicast packets to set the - smallest TTL possible. The default is 1 which means that multicast - packets don't leacl the local network unless the user program - explicitly request it. See also the Unix man page for setsocketopt - IPPROTO_IP IP_MULTICAST_TTL. + <dd class='body--doc'>Set the time-to-live value of outgoing multicast packets + for this socket. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>ttl</code></dt> + <dd></dd><dd class='body--doc'>The number of router hops sent multicast packets should + survive. + It is very important for multicast packets to set the + smallest TTL possible. The default before calling this + function is 1 which means that multicast packets don't + leak from the local network unless the user program + explicitly requests it. + See also the Unix man page for setsocketopt IPPROTO_IP IP_MULTICAST_TTL + and IPPROTO_IPV6 IPV6_MULTICAST_HOPS. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function did not support IPv6 in Pike 7.8 and earlier. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>add_membership()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method set_nonblocking </dt> <dd><code><code class='object unresolved'>UDP</code> set_nonblocking()</code> <code><code class='object unresolved'>UDP</code> set_nonblocking(<code class='datatype'>function</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>string</code>), <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) <code class='argument'>read_cb</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra_args</code>)</code></dd>

autodoc.git / traditional_manual / chapter_9.html