Chris@16: //
Chris@16: // ip/multicast.hpp
Chris@16: // ~~~~~~~~~~~~~~~~
Chris@16: //
Chris@101: // Copyright (c) 2003-2015 Christopher M. Kohlhoff (chris at kohlhoff dot com)
Chris@16: //
Chris@16: // Distributed under the Boost Software License, Version 1.0. (See accompanying
Chris@16: // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16: //
Chris@16: 
Chris@16: #ifndef BOOST_ASIO_IP_MULTICAST_HPP
Chris@16: #define BOOST_ASIO_IP_MULTICAST_HPP
Chris@16: 
Chris@16: #if defined(_MSC_VER) && (_MSC_VER >= 1200)
Chris@16: # pragma once
Chris@16: #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
Chris@16: 
Chris@16: #include <boost/asio/detail/config.hpp>
Chris@16: #include <cstddef>
Chris@16: #include <boost/asio/ip/detail/socket_option.hpp>
Chris@16: 
Chris@16: #include <boost/asio/detail/push_options.hpp>
Chris@16: 
Chris@16: namespace boost {
Chris@16: namespace asio {
Chris@16: namespace ip {
Chris@16: namespace multicast {
Chris@16: 
Chris@16: /// Socket option to join a multicast group on a specified interface.
Chris@16: /**
Chris@16:  * Implements the IPPROTO_IP/IP_ADD_MEMBERSHIP socket option.
Chris@16:  *
Chris@16:  * @par Examples
Chris@16:  * Setting the option to join a multicast group:
Chris@16:  * @code
Chris@16:  * boost::asio::ip::udp::socket socket(io_service); 
Chris@16:  * ...
Chris@16:  * boost::asio::ip::address multicast_address =
Chris@16:  *   boost::asio::ip::address::from_string("225.0.0.1");
Chris@16:  * boost::asio::ip::multicast::join_group option(multicast_address);
Chris@16:  * socket.set_option(option);
Chris@16:  * @endcode
Chris@16:  *
Chris@16:  * @par Concepts:
Chris@16:  * SettableSocketOption.
Chris@16:  */
Chris@16: #if defined(GENERATING_DOCUMENTATION)
Chris@16: typedef implementation_defined join_group;
Chris@16: #else
Chris@16: typedef boost::asio::ip::detail::socket_option::multicast_request<
Chris@16:   BOOST_ASIO_OS_DEF(IPPROTO_IP),
Chris@16:   BOOST_ASIO_OS_DEF(IP_ADD_MEMBERSHIP),
Chris@16:   BOOST_ASIO_OS_DEF(IPPROTO_IPV6),
Chris@16:   BOOST_ASIO_OS_DEF(IPV6_JOIN_GROUP)> join_group;
Chris@16: #endif
Chris@16: 
Chris@16: /// Socket option to leave a multicast group on a specified interface.
Chris@16: /**
Chris@16:  * Implements the IPPROTO_IP/IP_DROP_MEMBERSHIP socket option.
Chris@16:  *
Chris@16:  * @par Examples
Chris@16:  * Setting the option to leave a multicast group:
Chris@16:  * @code
Chris@16:  * boost::asio::ip::udp::socket socket(io_service); 
Chris@16:  * ...
Chris@16:  * boost::asio::ip::address multicast_address =
Chris@16:  *   boost::asio::ip::address::from_string("225.0.0.1");
Chris@16:  * boost::asio::ip::multicast::leave_group option(multicast_address);
Chris@16:  * socket.set_option(option);
Chris@16:  * @endcode
Chris@16:  *
Chris@16:  * @par Concepts:
Chris@16:  * SettableSocketOption.
Chris@16:  */
Chris@16: #if defined(GENERATING_DOCUMENTATION)
Chris@16: typedef implementation_defined leave_group;
Chris@16: #else
Chris@16: typedef boost::asio::ip::detail::socket_option::multicast_request<
Chris@16:   BOOST_ASIO_OS_DEF(IPPROTO_IP),
Chris@16:   BOOST_ASIO_OS_DEF(IP_DROP_MEMBERSHIP),
Chris@16:   BOOST_ASIO_OS_DEF(IPPROTO_IPV6),
Chris@16:   BOOST_ASIO_OS_DEF(IPV6_LEAVE_GROUP)> leave_group;
Chris@16: #endif
Chris@16: 
Chris@16: /// Socket option for local interface to use for outgoing multicast packets.
Chris@16: /**
Chris@16:  * Implements the IPPROTO_IP/IP_MULTICAST_IF socket option.
Chris@16:  *
Chris@16:  * @par Examples
Chris@16:  * Setting the option:
Chris@16:  * @code
Chris@16:  * boost::asio::ip::udp::socket socket(io_service); 
Chris@16:  * ...
Chris@16:  * boost::asio::ip::address_v4 local_interface =
Chris@16:  *   boost::asio::ip::address_v4::from_string("1.2.3.4");
Chris@16:  * boost::asio::ip::multicast::outbound_interface option(local_interface);
Chris@16:  * socket.set_option(option);
Chris@16:  * @endcode
Chris@16:  *
Chris@16:  * @par Concepts:
Chris@16:  * SettableSocketOption.
Chris@16:  */
Chris@16: #if defined(GENERATING_DOCUMENTATION)
Chris@16: typedef implementation_defined outbound_interface;
Chris@16: #else
Chris@16: typedef boost::asio::ip::detail::socket_option::network_interface<
Chris@16:   BOOST_ASIO_OS_DEF(IPPROTO_IP),
Chris@16:   BOOST_ASIO_OS_DEF(IP_MULTICAST_IF),
Chris@16:   BOOST_ASIO_OS_DEF(IPPROTO_IPV6),
Chris@16:   BOOST_ASIO_OS_DEF(IPV6_MULTICAST_IF)> outbound_interface;
Chris@16: #endif
Chris@16: 
Chris@16: /// Socket option for time-to-live associated with outgoing multicast packets.
Chris@16: /**
Chris@16:  * Implements the IPPROTO_IP/IP_MULTICAST_TTL socket option.
Chris@16:  *
Chris@16:  * @par Examples
Chris@16:  * Setting the option:
Chris@16:  * @code
Chris@16:  * boost::asio::ip::udp::socket socket(io_service); 
Chris@16:  * ...
Chris@16:  * boost::asio::ip::multicast::hops option(4);
Chris@16:  * socket.set_option(option);
Chris@16:  * @endcode
Chris@16:  *
Chris@16:  * @par
Chris@16:  * Getting the current option value:
Chris@16:  * @code
Chris@16:  * boost::asio::ip::udp::socket socket(io_service); 
Chris@16:  * ...
Chris@16:  * boost::asio::ip::multicast::hops option;
Chris@16:  * socket.get_option(option);
Chris@16:  * int ttl = option.value();
Chris@16:  * @endcode
Chris@16:  *
Chris@16:  * @par Concepts:
Chris@16:  * GettableSocketOption, SettableSocketOption.
Chris@16:  */
Chris@16: #if defined(GENERATING_DOCUMENTATION)
Chris@16: typedef implementation_defined hops;
Chris@16: #else
Chris@16: typedef boost::asio::ip::detail::socket_option::multicast_hops<
Chris@16:   BOOST_ASIO_OS_DEF(IPPROTO_IP),
Chris@16:   BOOST_ASIO_OS_DEF(IP_MULTICAST_TTL),
Chris@16:   BOOST_ASIO_OS_DEF(IPPROTO_IPV6),
Chris@16:   BOOST_ASIO_OS_DEF(IPV6_MULTICAST_HOPS)> hops;
Chris@16: #endif
Chris@16: 
Chris@16: /// Socket option determining whether outgoing multicast packets will be
Chris@16: /// received on the same socket if it is a member of the multicast group.
Chris@16: /**
Chris@16:  * Implements the IPPROTO_IP/IP_MULTICAST_LOOP socket option.
Chris@16:  *
Chris@16:  * @par Examples
Chris@16:  * Setting the option:
Chris@16:  * @code
Chris@16:  * boost::asio::ip::udp::socket socket(io_service); 
Chris@16:  * ...
Chris@16:  * boost::asio::ip::multicast::enable_loopback option(true);
Chris@16:  * socket.set_option(option);
Chris@16:  * @endcode
Chris@16:  *
Chris@16:  * @par
Chris@16:  * Getting the current option value:
Chris@16:  * @code
Chris@16:  * boost::asio::ip::udp::socket socket(io_service); 
Chris@16:  * ...
Chris@16:  * boost::asio::ip::multicast::enable_loopback option;
Chris@16:  * socket.get_option(option);
Chris@16:  * bool is_set = option.value();
Chris@16:  * @endcode
Chris@16:  *
Chris@16:  * @par Concepts:
Chris@16:  * GettableSocketOption, SettableSocketOption.
Chris@16:  */
Chris@16: #if defined(GENERATING_DOCUMENTATION)
Chris@16: typedef implementation_defined enable_loopback;
Chris@16: #else
Chris@16: typedef boost::asio::ip::detail::socket_option::multicast_enable_loopback<
Chris@16:   BOOST_ASIO_OS_DEF(IPPROTO_IP),
Chris@16:   BOOST_ASIO_OS_DEF(IP_MULTICAST_LOOP),
Chris@16:   BOOST_ASIO_OS_DEF(IPPROTO_IPV6),
Chris@16:   BOOST_ASIO_OS_DEF(IPV6_MULTICAST_LOOP)> enable_loopback;
Chris@16: #endif
Chris@16: 
Chris@16: } // namespace multicast
Chris@16: } // namespace ip
Chris@16: } // namespace asio
Chris@16: } // namespace boost
Chris@16: 
Chris@16: #include <boost/asio/detail/pop_options.hpp>
Chris@16: 
Chris@16: #endif // BOOST_ASIO_IP_MULTICAST_HPP