.\" 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 3pm" .TH NetPacket 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 \- assemble/disassemble network packets at the protocol level .SH "VERSION" .IX Header "VERSION" version 1.3.0 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& # NetPacket is a base class only .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`NetPacket\*(C'\fR provides a base class for a cluster of modules related to decoding and encoding of network protocols. Each \f(CW\*(C`NetPacket\*(C'\fR descendent module knows how to encode and decode packets for the network protocol it implements. Consult the documentation for the module in question for protocol-specific implementation. .PP Note that there is no inheritance in the \f(CW\*(C`NetPacket::\*(C'\fR cluster of modules other than each protocol module being a \f(CW\*(C`NetPacket\*(C'\fR. This was seen to be too restrictive as imposing inheritance relationships (for example between the \s-1IP\s0, \s-1UDP\s0 and \s-1TCP\s0 protocols) would make things like tunneling or other unusual situations difficult. .ie n .SH "WRITING YOUR OWN ""NetPacket::"" MODULE" .el .SH "WRITING YOUR OWN \f(CWNetPacket::\fP MODULE" .IX Header "WRITING YOUR OWN NetPacket:: MODULE" You are encouraged to write additional \f(CW\*(C`NetPacket::\*(C'\fR modules as well as improve existing ones. Contact the maintainer of the module in question with your suggestions or changes. .PP The following sections are a list of suggestions and conventions for writing a \f(CW\*(C`NetPacket::\*(C'\fR module. .SS "Naming Conventions" .IX Subsection "Naming Conventions" When creating a module in the \f(CW\*(C`NetPacket::\*(C'\fR namespace, it is suggested that you stick to a couple of conventions when naming packet contents. This will hopefully lead to a consistent namespace making the \&\f(CW\*(C`NetPacket::\*(C'\fR easier to use. .PP Content names are all lowercase, with underscores separating multiple words. The following abbreviations are recommended: .PP .Vb 8 \& Word Abbreviation \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& source src \& destination dest \& checksum cksum \& identifier id \& version ver \& protocol proto .Ve .SS "Required Methods" .IX Subsection "Required Methods" \&\fIencode()\fR, \fIdecode()\fR, \fIstrip()\fR .SS "Required Fields" .IX Subsection "Required Fields" Every NetPacket:: object should have the following fields. .IP "_parent" 4 .IX Item "_parent" A link to the parent \f(CW\*(C`NetPacket::\*(C'\fR object in which this \&\f(CW\*(C`NetPacket::\*(C'\fR object is encaulated. This field is undefined if there is no parent object. .IP "_frame" 4 .IX Item "_frame" A copy of the raw data of the packet. .IP "data" 4 .IX Item "data" This field should contain the data encapsulated in the packet (i.e any headers or trailers stripped off) or undef if the packet contains no data. Note that in this sense, \*(L"data\*(R" is taken to mean information not relevant to the particular protocol being decoded. For example, an \s-1ARP\s0 packet contains many header fields but no data. A \s-1UDP\s0 datagram, however contains header fields and a payload. .SH "SEE ALSO" .IX Header "SEE ALSO" Joel Knight has a patch for NetPacket for IPv6 support available at http://www.packetmischief.ca/code/netpacket/. .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" 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 "AUTHORS" .IX Header "AUTHORS" Tim Potter .PP Stephanie Wehner .PP Yanick Champoux