.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Socket::Multicast6 3pm"
.TH Socket::Multicast6 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Socket::Multicast6 \- Constructors and constants for IPv4 and IPv6 multicast socket operations.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Socket::Multicast6 qw(:all);
\&
\&  my $ip = getprotobyname( \*(Aqip\*(Aq );
\&  
\&  my $ip_mreq = pack_ip_mreq( inet_aton( $mcast_addr ), inet_aton( $if_addr ) );
\&
\&  my $ipv6_mreq = pack_ipv6_mreq( inet_pton( AF_INET6, $mcast6_addr ), $if_index );
\&
\&  setsockopt( $sock, $ip, IP_ADD_MEMBERSHIP, $ip_mreq )
\&    or die( "setsockopt IP_ADD_MEMBERSHIP failed: $!" );
\&
\&  setsockopt( $sock, $ip, IP_DROP_MEMBERSHIP, $ip_mreq )
\&    or die( "setsockopt IP_DROP_MEMBERSHIP failed: $!" );
\&
\&  setsockopt( $sock, $ip, IP_MULTICAST_LOOP, pack( \*(AqC\*(Aq, $loop ) )
\&    or die( "setsockopt IP_MULTICAST_LOOP failed: $!" );
\&
\&  setsockopt( $sock, $ip, IP_MULTICAST_TTL, pack( \*(AqC\*(Aq, $ttl ) )
\&    or die( "setsockopt IP_MULTICAST_TTL failed: $!" );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is used to gain access to constants and utility functions
used when manipulating multicast socket attributes.
.PP
For simple, object-oriented way of doing the same thing, take a look 
at IO::Socket::Multicast6 or IO::Socket::Multicast.
.SH EXPORTS
.IX Header "EXPORTS"
By default nothing is exported, you can use the 'ipv4', 'ipv6' and 'independent' to 
export a specific protocol family, or 'all' to export all symbols.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.ie n .IP "$ip_mreq = pack_ip_mreq(MCAST_ADDR, IF_ADDR)" 4
.el .IP "\f(CW$ip_mreq\fR = pack_ip_mreq(MCAST_ADDR, IF_ADDR)" 4
.IX Item "$ip_mreq = pack_ip_mreq(MCAST_ADDR, IF_ADDR)"
.PD 0
.ie n .IP "$ip_mreq_source = pack_ip_mreq_source(MCAST_ADDR, SOURCE_ADDR, IF_ADDR)" 4
.el .IP "\f(CW$ip_mreq_source\fR = pack_ip_mreq_source(MCAST_ADDR, SOURCE_ADDR, IF_ADDR)" 4
.IX Item "$ip_mreq_source = pack_ip_mreq_source(MCAST_ADDR, SOURCE_ADDR, IF_ADDR)"
.ie n .IP "$ipv6_mreq = pack_ipv6_mreq(MCAST6_ADDR, IF_INDEX)" 4
.el .IP "\f(CW$ipv6_mreq\fR = pack_ipv6_mreq(MCAST6_ADDR, IF_INDEX)" 4
.IX Item "$ipv6_mreq = pack_ipv6_mreq(MCAST6_ADDR, IF_INDEX)"
.PD
.SH CONSTANTS
.IX Header "CONSTANTS"
.IP IP_MULTICAST_IF 4
.IX Item "IP_MULTICAST_IF"
.PD 0
.IP IP_MULTICAST_TTL 4
.IX Item "IP_MULTICAST_TTL"
.IP IP_MULTICAST_LOOP 4
.IX Item "IP_MULTICAST_LOOP"
.IP IP_ADD_MEMBERSHIP 4
.IX Item "IP_ADD_MEMBERSHIP"
.IP IP_DROP_MEMBERSHIP 4
.IX Item "IP_DROP_MEMBERSHIP"
.IP IP_ADD_SOURCE_MEMBERSHIP 4
.IX Item "IP_ADD_SOURCE_MEMBERSHIP"
.IP IP_DROP_SOURCE_MEMBERSHIP 4
.IX Item "IP_DROP_SOURCE_MEMBERSHIP"
.IP IPV6_MULTICAST_IF 4
.IX Item "IPV6_MULTICAST_IF"
.IP IPV6_MULTICAST_HOPS 4
.IX Item "IPV6_MULTICAST_HOPS"
.IP IPV6_MULTICAST_LOOP 4
.IX Item "IPV6_MULTICAST_LOOP"
.IP IPV6_JOIN_GROUP 4
.IX Item "IPV6_JOIN_GROUP"
.IP IPV6_LEAVE_GROUP 4
.IX Item "IPV6_LEAVE_GROUP"
.IP MCAST_JOIN_GROUP 4
.IX Item "MCAST_JOIN_GROUP"
.IP MCAST_BLOCK_SOURCE 4
.IX Item "MCAST_BLOCK_SOURCE"
.IP MCAST_UNBLOCK_SOURCE 4
.IX Item "MCAST_UNBLOCK_SOURCE"
.IP MCAST_LEAVE_GROUP 4
.IX Item "MCAST_LEAVE_GROUP"
.IP MCAST_JOIN_SOURCE_GROUP 4
.IX Item "MCAST_JOIN_SOURCE_GROUP"
.IP MCAST_LEAVE_SOURCE_GROUP 4
.IX Item "MCAST_LEAVE_SOURCE_GROUP"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
IO::Socket::Multicast6 (The easier, object-oriented way)
.SH AUTHOR
.IX Header "AUTHOR"
Based on Socket::Multicast by Jonathan Steinert, <hachi@cpan.org>
Socket::Multicast6 by Nicholas J Humfrey, <njh@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2006 Nicholas J Humfrey
Copyright (C) 2006 Jonathan Steinert
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.6.1 or,
at your option, any later version of Perl 5 you may have available.