.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "NetPacket::IGMP 3pm"
.TH NetPacket::IGMP 3pm "2011-11-20" "perl v5.14.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"
NetPacket::IGMP \- Assemble and disassemble IGMP (Internet Group Mangement Protocol) packets.
.SH "VERSION"
.IX Header "VERSION"
version 1.3.0
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use NetPacket::IGMP;
\&
\&  $igmp_obj = NetPacket::IGMP\->decode($raw_pkt);
\&  $igmp_pkt = NetPacket::IGMP\->encode(params...);   # Not implemented
\&  $igmp_data = NetPacket::IGMP::strip($raw_pkt);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`NetPacket::IGMP\*(C'\fR provides a set of routines for assembling and
disassembling packets using \s-1IGMP\s0 (Internet Group Mangement Protocol).
.SS "Methods"
.IX Subsection "Methods"
.ie n .IP """NetPacket::IGMP\->decode([RAW PACKET])""" 4
.el .IP "\f(CWNetPacket::IGMP\->decode([RAW PACKET])\fR" 4
.IX Item "NetPacket::IGMP->decode([RAW PACKET])"
Decode the raw packet data given and return an object containing
instance data.  This method will quite happily decode garbage input.
It is the responsibility of the programmer to ensure valid packet data
is passed to this method.
.ie n .IP """NetPacket::IGMP\->encode(param => value)""" 4
.el .IP "\f(CWNetPacket::IGMP\->encode(param => value)\fR" 4
.IX Item "NetPacket::IGMP->encode(param => value)"
Return an \s-1IGMP\s0 packet encoded with the instance data specified.  Not
implemented.
.SS "Functions"
.IX Subsection "Functions"
.ie n .IP """NetPacket::IGMP::strip([RAW PACKET])""" 4
.el .IP "\f(CWNetPacket::IGMP::strip([RAW PACKET])\fR" 4
.IX Item "NetPacket::IGMP::strip([RAW PACKET])"
Return the encapsulated data (or payload) contained in the \s-1IGMP\s0
packet.  This function returns undef as there is no encapsulated data
in an \s-1IGMP\s0 packet.
.SS "Instance data"
.IX Subsection "Instance data"
The instance data for the \f(CW\*(C`NetPacket::IGMP\*(C'\fR object consists of
the following fields.
.IP "version" 4
.IX Item "version"
The \s-1IGMP\s0 version of this packet.
.IP "type" 4
.IX Item "type"
The message type for this packet.
.IP "len" 4
.IX Item "len"
The length (including length of header) in bytes for this packet.
.IP "subtype" 4
.IX Item "subtype"
The message subtype for this packet.
.IP "cksum" 4
.IX Item "cksum"
The checksum for this packet.
.IP "group_addr" 4
.IX Item "group_addr"
The group address specified in this packet.
.IP "data" 4
.IX Item "data"
The encapsulated data (payload) for this packet.
.SS "Exports"
.IX Subsection "Exports"
.IP "default" 4
.IX Item "default"
none
.IP "exportable" 4
.IX Item "exportable"
\&\s-1IGMP_VERSION_RFC998\s0 \s-1IGMP_VERSION_RFC1112\s0 \s-1IGMP_HOST_MQUERY\s0
\&\s-1IGMP_HOST_MREPORT\s0 \s-1IGMP_IP_NO_HOSTS\s0 \s-1IGMP_IP_ALL_HOSTS\s0
\&\s-1IGMP_IP_ALL_ROUTERS\s0
.IP "tags" 4
.IX Item "tags"
The following tags group together related exportable items.
.RS 4
.ie n .IP """:strip""" 4
.el .IP "\f(CW:strip\fR" 4
.IX Item ":strip"
Import the strip function \f(CW\*(C`igmp_strip\*(C'\fR.
.ie n .IP """:versions""" 4
.el .IP "\f(CW:versions\fR" 4
.IX Item ":versions"
\&\s-1IGMP_VERSION_RFC998\s0 \s-1IGMP_VERSION_RFC1112\s0
.ie n .IP """:msgtypes""" 4
.el .IP "\f(CW:msgtypes\fR" 4
.IX Item ":msgtypes"
\&\s-1IGMP_HOST_MQUERY\s0 \s-1IGMP_HOST_MREPORT\s0
.ie n .IP """:group_addrs""" 4
.el .IP "\f(CW:group_addrs\fR" 4
.IX Item ":group_addrs"
\&\s-1IGMP_IP_NO_HOSTS\s0 \s-1IGMP_IP_ALL_HOSTS\s0 \s-1IGMP_IP_ALL_ROUTERS\s0
.ie n .IP """:ALL""" 4
.el .IP "\f(CW:ALL\fR" 4
.IX Item ":ALL"
All the above exportable items.
.RE
.RS 4
.RE
.SH "EXAMPLE"
.IX Header "EXAMPLE"
The following script dumps \s-1UDP\s0 frames by \s-1IP\s0 address and \s-1UDP\s0 port
to standard output.
.PP
.Vb 1
\&  #!/usr/bin/perl \-w
\&
\&  use strict;
\&  use Net::PcapUtils;
\&  use NetPacket::Ethernet qw(:strip);
\&  use NetPacket::IP;
\&  use NetPacket::IGMP;
\&
\&  sub process_pkt {
\&      my($arg, $hdr, $pkt) = @_;
\&
\&      my $ip_obj = NetPacket::IP\->decode(eth_strip($pkt));
\&      my $igmp_obj = NetPacket::IGMP\->decode($ip_obj\->{data});
\&
\&      print("$ip_obj\->{src_ip} \-> $ip_obj\->{dest_ip} ",
\&            "$igmp_obj\->{type}/$igmp_obj\->{subtype} ",
\&            "$igmp_obj\->{group_addr}\en");
\&  }
\&
\&  Net::PcapUtils::loop(\e&process_pkt, FILTER => \*(Aqigmp\*(Aq);
.Ve
.SH "TODO"
.IX Header "TODO"
.IP "Implement \fIencode()\fR function" 4
.IX Item "Implement encode() function"
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2001 Tim Potter.
.PP
Copyright (c) 1995,1996,1997,1998,1999 \s-1ANU\s0 and \s-1CSIRO\s0 on behalf of 
the participants in the \s-1CRC\s0 for Advanced Computational Systems
('ACSys').
.PP
This module is free software.  You can redistribute it and/or
modify it under the terms of the Artistic License 2.0.
.PP
This program is distributed in the hope that it will be useful,
but without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tim Potter <tpot@samba.org>