.\" 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::ICMP 3pm"
.TH NetPacket::ICMP 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::ICMP \- Assemble and disassemble ICMP (Internet Control Message Protocol) packets.
.SH "VERSION"
.IX Header "VERSION"
version 1.3.0
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use NetPacket::ICMP;
\&
\&  $icmp_obj = NetPacket::ICMP\->decode($raw_pkt);
\&  $icmp_pkt = NetPacket::ICMP\->encode();
\&  $icmp_data = NetPacket::ICMP::strip($raw_pkt);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`NetPacket::ICMP\*(C'\fR provides a set of routines for assembling and
disassembling packets using \s-1ICMP\s0 (Internet Control Message Protocol).
.SS "Methods"
.IX Subsection "Methods"
.ie n .IP """NetPacket::ICMP\->decode([RAW PACKET])""" 4
.el .IP "\f(CWNetPacket::ICMP\->decode([RAW PACKET])\fR" 4
.IX Item "NetPacket::ICMP->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::ICMP\->encode()""" 4
.el .IP "\f(CWNetPacket::ICMP\->encode()\fR" 4
.IX Item "NetPacket::ICMP->encode()"
Return an \s-1ICMP\s0 packet encoded with the instance data specified.
.SS "Functions"
.IX Subsection "Functions"
.ie n .IP """NetPacket::ICMP::strip([RAW PACKET])""" 4
.el .IP "\f(CWNetPacket::ICMP::strip([RAW PACKET])\fR" 4
.IX Item "NetPacket::ICMP::strip([RAW PACKET])"
Return the encapsulated data (or payload) contained in the \s-1ICMP\s0
packet.
.SS "Instance data"
.IX Subsection "Instance data"
The instance data for the \f(CW\*(C`NetPacket::ICMP\*(C'\fR object consists of
the following fields.
.IP "type" 4
.IX Item "type"
The \s-1ICMP\s0 message type of this packet.
.IP "code" 4
.IX Item "code"
The \s-1ICMP\s0 message code of this packet.
.IP "cksum" 4
.IX Item "cksum"
The checksum for 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-1ICMP\s0 message types: 
    \s-1ICMP_ECHOREPLY\s0 \s-1ICMP_UNREACH\s0 \s-1ICMP_SOURCEQUENCH\s0
    \s-1ICMP_REDIRECT\s0 \s-1ICMP_ECHO\s0 \s-1ICMP_ROUTERADVERT\s0
    \s-1ICMP_ROUTERSOLICIT\s0 \s-1ICMP_TIMXCEED\s0 \s-1ICMP_PARAMPROB\s0
    \s-1ICMP_TSTAMP\s0 \s-1ICMP_TSTAMPREPLY\s0 \s-1ICMP_IREQ\s0 \s-1ICMP_IREQREPLY\s0
    \s-1ICMP_MASKREQ\s0 \s-1ICMP_MASKREPLY\s0
.IP "tags" 4
.IX Item "tags"
The following tags group together related exportable items.
.RS 4
.ie n .IP """:types""" 4
.el .IP "\f(CW:types\fR" 4
.IX Item ":types"
.Vb 5
\&  ICMP_ECHOREPLY ICMP_UNREACH ICMP_SOURCEQUENCH
\&  ICMP_REDIRECT ICMP_ECHO ICMP_ROUTERADVERT
\&  ICMP_ROUTERSOLICIT ICMP_TIMXCEED ICMP_PARAMPROB
\&  ICMP_TSTAMP ICMP_TSTAMPREPLY ICMP_IREQ 
\&  ICMP_IREQREPLY ICMP_MASKREQ ICMP_MASKREPLY
.Ve
.ie n .IP """:strip""" 4
.el .IP "\f(CW:strip\fR" 4
.IX Item ":strip"
Import the strip function \f(CW\*(C`icmp_strip\*(C'\fR.
.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 example prints the \s-1ICMP\s0 type, code, and checksum 
fields.
.PP
.Vb 1
\&  #!/usr/bin/perl \-w
\&
\&  use strict;
\&  use Net::PcapUtils;
\&  use NetPacket::Ethernet qw(:strip);
\&  use NetPacket::IP qw(:strip);
\&  use NetPacket::ICMP;
\&
\&  sub process_pkt {
\&      my ($user, $hdr, $pkt) = @_;
\&
\&      my $ip_obj = NetPacket::IP\->decode(eth_strip($pkt));
\&      my $icmp_obj = NetPacket::ICMP\->decode(ip_strip($ip_obj));
\&
\&      print("Type: $icmp_obj\->{type}\en");
\&      print("Code: $icmp_obj\->{code}\en");
\&      print("Checksum: $icmp_obj\->{cksum}\en\en");
\&  }
\&
\&  Net::PcapUtils::loop(\e&process_pkt, FILTER => \*(Aqicmp\*(Aq);
.Ve
.SH "TODO"
.IX Header "TODO"
.IP "Create constants" 4
.IX Item "Create constants"
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2001 Tim Potter and Stephanie Wehner.
.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>
.PP
Stephanie Wehner <atrak@itsx.com>