Net::Packet::Layer

Section: User Contributed Perl Documentation (3pm)
Updated: 2009-11-09
Index Return to Main Contents

NAME

Net::Packet::Layer - base class for all layer modules

This is the base class for Net::Packet::Layer2, Net::Packet::Layer3, Net::Packet::Layer4 and Net::Packet::Layer7 modules.

It just provides those layers with inheritable attributes and methods.

raw: Stores the raw layer (as captured from the network, or packed to send to network).
payload: Stores what is not part of the layer, that is the encapsulated part to be decoded by upper layers.

is: Returns the string describing the layer type (example: 'IPv4').
layer: Returns the string describing the layer number (example: 'L3' for IPv4).
encapsulate: Returns the next layer type (parsed from payload). This is the same string as returned by is method.
computeLengths
computeChecksums: Generally, when a layer is built, some attributes are not yet known until the full Net::Packet::Frame is assembled. Those methods computes various lengths and checksums attributes found in a specific layer. Return 1 on success, undef otherwise.
print: Just returns a string in a human readable format describing attributes found in the layer.
dump: Just returns a string in hexadecimal format which is how the layer appears on the network.
getKey
getKeyReverse: These methods are used to respectively store and retrieve analyzed frames respectively to and from a hashref. This is to make it quick to get possible responses from a probe.
pack: Will pack all attributes into raw network format. This method MUST be implemented into each supported layers.
unpack: Will unpack raw network format to respective attributes. This method MUST be implemented into each supported layers.
getLength: Returns the layer length in bytes.
getPayloadLength: Returns the total length of remaining raw data in bytes (without calling layer length).
isLayer2
isLayer3
isLayer4
isLayer7: Returns true if the calling object is, respectively, layer 2, 3, 4 or 7.

Load them: use Net::Packet::Consts qw(:layer);

Patrice <GomoR> Auffret

You may distribute this module under the terms of the Artistic license. See LICENSE.Artistic file in the source distribution archive.

NetPacket, Net::RawIP, Net::RawSock

This document was created by