multicast.h

Go to the documentation of this file.

/*
   +----------------------------------------------------------------------+
   | Copyright (c) The PHP Group                                          |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.01 of the PHP license,      |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | https://www.php.net/license/3_01.txt                                 |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
   | Authors: Gustavo Lopes    <cataphract@php.net>                       |
   +----------------------------------------------------------------------+
 */
 
// TODO using setsourcefilter api on freebsd to support both ipv4/ipv6.
#if defined(MCAST_JOIN_GROUP) && !defined(__APPLE__) && !defined(__FreeBSD__)
# define RFC3678_API 1
/* has block/unblock and source membership, in this case for both IPv4 and IPv6 */
# define HAS_MCAST_EXT 1
#elif defined(IP_ADD_SOURCE_MEMBERSHIP) && !defined(__APPLE__)
/* has block/unblock and source membership, but only for IPv4 */
# define HAS_MCAST_EXT 1
#endif
 
#ifndef RFC3678_API
# define PHP_MCAST_JOIN_GROUP           IP_ADD_MEMBERSHIP
# define PHP_MCAST_LEAVE_GROUP          IP_DROP_MEMBERSHIP
# ifdef HAS_MCAST_EXT
#  define PHP_MCAST_BLOCK_SOURCE        IP_BLOCK_SOURCE
#  define PHP_MCAST_UNBLOCK_SOURCE      IP_UNBLOCK_SOURCE
#  define PHP_MCAST_JOIN_SOURCE_GROUP   IP_ADD_SOURCE_MEMBERSHIP
#  define PHP_MCAST_LEAVE_SOURCE_GROUP  IP_DROP_SOURCE_MEMBERSHIP
# endif
#else
# define PHP_MCAST_JOIN_GROUP           MCAST_JOIN_GROUP
# define PHP_MCAST_LEAVE_GROUP          MCAST_LEAVE_GROUP
# define PHP_MCAST_BLOCK_SOURCE         MCAST_BLOCK_SOURCE
# define PHP_MCAST_UNBLOCK_SOURCE       MCAST_UNBLOCK_SOURCE
# define PHP_MCAST_JOIN_SOURCE_GROUP    MCAST_JOIN_SOURCE_GROUP
# define PHP_MCAST_LEAVE_SOURCE_GROUP   MCAST_LEAVE_SOURCE_GROUP
#endif
 
int php_do_setsockopt_ip_mcast(php_socket *php_sock,
                               int level,
                               int optname,
                               zval *arg4);
 
int php_do_setsockopt_ipv6_mcast(php_socket *php_sock,
                                 int level,
                                 int optname,
                                 zval *arg4);
 
zend_result php_if_index_to_addr4(
        unsigned if_index,
        php_socket *php_sock,
        struct in_addr *out_addr);
 
zend_result php_add4_to_if_index(
        struct in_addr *addr,
        php_socket *php_sock,
        unsigned *if_index);
 
zend_result php_string_to_if_index(const char *val, unsigned *out);
 
int php_mcast_join(
    php_socket *sock,
    int level,
    struct sockaddr *group,
    socklen_t group_len,
    unsigned int if_index);
 
int php_mcast_leave(
    php_socket *sock,
    int level,
    struct sockaddr *group,
    socklen_t group_len,
    unsigned int if_index);
 
#ifdef HAS_MCAST_EXT
int php_mcast_join_source(
    php_socket *sock,
    int level,
    struct sockaddr *group,
    socklen_t group_len,
    struct sockaddr *source,
    socklen_t source_len,
    unsigned int if_index);
 
int php_mcast_leave_source(
    php_socket *sock,
    int level,
    struct sockaddr *group,
    socklen_t group_len,
    struct sockaddr *source,
    socklen_t source_len,
    unsigned int if_index);
 
int php_mcast_block_source(
    php_socket *sock,
    int level,
    struct sockaddr *group,
    socklen_t group_len,
    struct sockaddr *source,
    socklen_t source_len,
    unsigned int if_index);
 
int php_mcast_unblock_source(
    php_socket *sock,
    int level,
    struct sockaddr *group,
    socklen_t group_len,
    struct sockaddr *source,
    socklen_t source_len,
    unsigned int if_index);
#endif