Patrice Auffret > Net-Frame-Layer-PPPoES > Net::Frame::Layer::PPPoES

Download:
Net-Frame-Layer-PPPoES-1.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.01   Source  

NAME ^

Net::Frame::Layer::PPPoES - PPP-over-Ethernet layer object

SYNOPSIS ^

   use Net::Frame::Layer::PPPoES qw(:consts);

   # Build a layer
   my $layer = Net::Frame::Layer::PPPoES->new(
      version       => 1,
      type          => 1,
      code          => 0,
      sessionId     => 1,
      payloadLength => 0,
      pppProtocol   => NF_PPPoE_PPP_PROTOCOL_IPv4,
   );
   $layer->pack;

   print 'RAW: '.$layer->dump."\n";

   # Read a raw layer
   my $layer = Net::Frame::Layer::PPPoES->new(raw => $raw);

   print $layer->print."\n";
   print 'PAYLOAD: '.unpack('H*', $layer->payload)."\n"
      if $layer->payload;

DESCRIPTION ^

This modules implements the encoding and decoding of the PPPoES layer.

See also Net::Frame::Layer for other attributes and methods.

ATTRIBUTES ^

version - 4 bits
code - 4 bits
type - 8 bits
sessionId - 16 bits
payloadLength - 16 bits
pppProtocol - 16 bits

For this last attribute, we can note that it is included in the computation of payloadLength.

The following are inherited attributes. See Net::Frame::Layer for more information.

raw
payload
nextLayer

METHODS ^

new
new (hash)

Object constructor. You can pass attributes that will overwrite default ones. See SYNOPSIS for default values.

The following are inherited methods. Some of them may be overriden in this layer, and some others may not be meaningful in this layer. See Net::Frame::Layer for more information.

layer
computeLengths
computeChecksums
pack
unpack
encapsulate
getLength
getPayloadLength
print
dump

CONSTANTS ^

Load them: use Net::Frame::Layer::PPPoES qw(:consts);

NF_PPPoE_HDR_LEN
NF_PPPoE_PPP_PROTOCOL_IPv4
NF_PPPoE_PPP_PROTOCOL_PPPLCP

SEE ALSO ^

Net::Frame::Layer

AUTHOR ^

Patrice <GomoR> Auffret

COPYRIGHT AND LICENSE ^

Copyright (c) 2006-2010, Patrice <GomoR> Auffret

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

syntax highlighting: