ip::multicast::join

ip::multicast::join_group

Socket option to join a multicast group on a specified interface.

typedef implementation_defined join_group;

Types

Name	Description
container	Determine the container for the specified elements.
rebind	Rebind the traits to a new set of signatures.
receive_cancelled_signature	The signature of a channel cancellation notification.
receive_closed_signature	The signature of a channel closed notification.

Member Functions

Name	Description
invoke_receive_cancelled [static]	Invoke the specified handler with a cancellation notification.
invoke_receive_closed [static]	Invoke the specified handler with a closed notification.

Implements the IPPROTO_IP/IP_ADD_MEMBERSHIP socket option.

Examples

Setting the option to join a multicast group:

boost::asio::ip::udp::socket socket(my_context);
...
boost::asio::ip::address multicast_address =
  boost::asio::ip::make_address("225.0.0.1");
boost::asio::ip::multicast::join_group option(multicast_address);
socket.set_option(option);

Requirements

Header: boost/asio/ip/multicast.hpp

Convenience header: boost/asio.hpp