sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

- Added multicast information.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@319959 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Gustavo André dos Santos Lopes 2011-11-26 16:13:39 +00:00
parent e9cc656f17
commit 9566c12650
1 changed files with 159 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

159
reference/sockets/functions/socket-get-option.xml
View file

@ -241,6 +241,165 @@
<type>int</type>
</entry>
</row>
<row>
<entry><constant>MCAST_JOIN_GROUP</constant></entry>
<entry>
Joins a multicast group. (added in PHP 5.4)
</entry>
<entry>
<type>array</type> with keys <literal>"group"</literal>, specifying
a <type>string</type> with an IPv4 or IPv6 multicast address and
<literal>"interface"</literal>, specifying either an interface
number (type <type>int</type>) or a <literal>string</literal> with
the interface name, like <literal>"eth0"</literal>.
<literal>0</literal> can be specified to indicate the interface
should be selected using routing rules. (can only be used in
<function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>MCAST_LEAVE_GROUP</constant></entry>
<entry>
Leaves a multicast group. (added in PHP 5.4)
</entry>
<entry>
<type>array</type>. See <constant>MCAST_JOIN_GROUP</constant> for
more information. (can only be used in
<function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>MCAST_BLOCK_SOURCE</constant></entry>
<entry>
Blocks packets arriving from a specific source to a specific
multicast group, which must have been previously joined.
(added in PHP 5.4)
</entry>
<entry>
<type>array</type> with the same keys as
<constant>MCAST_JOIN_GROUP</constant>, plus one extra key,
<literal>source</literal>, which maps to a <type>string</type>
specifying an IPv4 or IPv6 address of the source to be blocked.
(can only be used in <function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>MCAST_UNBLOCK_SOURCE</constant></entry>
<entry>
Unblocks (start receiving again) packets arriving from a specific
source address to a specific multicast group, which must have been
previously joined. (added in PHP 5.4)
</entry>
<entry>
<type>array</type> with the same format as
<constant>MCAST_BLOCK_SOURCE</constant>.
(can only be used in <function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>MCAST_JOIN_SOURCE_GROUP</constant></entry>
<entry>
Receive packets destined to a specific multicast group whose source
address matches a specific value. (added in PHP 5.4)
</entry>
<entry>
<type>array</type> with the same format as
<constant>MCAST_BLOCK_SOURCE</constant>.
(can only be used in <function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>MCAST_LEAVE_SOURCE_GROUP</constant></entry>
<entry>
Stop receiving packets destined to a specific multicast group whose
soure address matches a specific value. (added in PHP 5.4)
</entry>
<entry>
<type>array</type> with the same format as
<constant>MCAST_BLOCK_SOURCE</constant>.
(can only be used in <function>socket_set_option</function>)
</entry>
</row>
<row>
<entry><constant>IP_MULTICAST_IF</constant></entry>
<entry>
The outgoing interface for IPv4 multicast packets.
(added in PHP 5.4)
</entry>
<entry>
Either <type>int</type> specifying the interface number or a
<type>string</type> with an interface name, like
<literal>eth0</literal>. The value <type>0</type> can be used to
indicate the routing table is to used in the interface selection.
The function <function>socket_get_option</function> returns an
interface index.
Note that, unlike the C API, this option does NOT take an IP
address. This eliminates the interface difference between
<constant>IP_MULTICAST_IF</constant> and
<constant>IPV6_MULTICAST_IF</constant>.
</entry>
</row>
<row>
<entry><constant>IPV6_MULTICAST_IF</constant></entry>
<entry>
The outgoing interface for IPv6 multicast packets.
(added in PHP 5.4)
</entry>
<entry>
The same as <constant>IP_MULTICAST_IF</constant>.
</entry>
</row>
<row>
<entry><constant>IP_MULTICAST_LOOP</constant></entry>
<entry>
The multicast loopback policy for IPv4 packets, which
determines whether multicast packets sent by this socket also reach
receivers in the same host that have joined the same multicast group
on the outgoing interface used by this socket. This is the case by
default.
(added in PHP 5.4)
</entry>
<entry>
<type>int</type> (either <literal>0</literal> or
<literal>1</literal>). For <function>socket_set_option</function>
any value will be accepted and will be converted to a boolean
following the usual PHP rules.
</entry>
</row>
<row>
<entry><constant>IPV6_MULTICAST_LOOP</constant></entry>
<entry>
Analogous to <constant>IP_MULTICAST_LOOP</constant>, but for IPv6.
(added in PHP 5.4)
</entry>
<entry>
<type>int</type>. See <constant>IP_MULTICAST_LOOP</constant>.
</entry>
</row>
<row>
<entry><constant>IP_MULTICAST_TTL</constant></entry>
<entry>
The time-to-live of outgoing IPv4 multicast packets. This should be
a value between 0 (don't leave the interface) and 255. The default
value is 1 (only the local network is reached).
(added in PHP 5.4)
</entry>
<entry>
<type>int</type> between 0 and 255.
</entry>
</row>
<row>
<entry><constant>IPV6_MULTICAST_HOPS</constant></entry>
<entry>
Analogous to <constant>IP_MULTICAST_TTL</constant>, but for IPv6
packets. The value -1 is also accepted, meaning the route default
should be used.
(added in PHP 5.4)
</entry>
<entry>
<type>int</type> between -1 and 255.
</entry>
</row>
</tbody>
</tgroup>
</table>