Net::Frame::Layer::PPPLCP - PPP Link Control Protocol layer object


Net-Frame-Layer-PPPLCP documentation Contained in the Net-Frame-Layer-PPPLCP distribution.

Index


Code Index:

NAME

Top

Net::Frame::Layer::PPPLCP - PPP Link Control Protocol layer object

SYNOPSIS

Top

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

   # Build a layer
   my $layer = Net::Frame::Layer::PPPLCP->new(
      code        => NF_PPPLCP_CODE_ECHO_REQUEST,
      identifier  => 1,
      length      => NF_PPPLCP_HDR_LEN,
      magicNumber => 0xffffffff,
   );
   $layer->pack;

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

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

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

DESCRIPTION

Top

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

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

ATTRIBUTES

Top

code - 8 bits
identifier - 8 bits
length - 16 bits
magicNumber - 32 bits

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

raw
payload
nextLayer

METHODS

Top

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

Top

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

NF_PPPLCP_HDR_LEN
NF_PPPLCP_CODE_ECHO_REQUEST
NF_PPPLCP_CODE_ECHO_REPLY

SEE ALSO

Top

Net::Frame::Layer

AUTHOR

Top

Patrice <GomoR> Auffret

COPYRIGHT AND LICENSE

Top


Net-Frame-Layer-PPPLCP documentation Contained in the Net-Frame-Layer-PPPLCP distribution.

#
# $Id: PPPLCP.pm,v 1.1 2007/04/01 17:14:36 gomor Exp $
#
package Net::Frame::Layer::PPPLCP;
use strict;
use warnings;

our $VERSION = '1.00';

use Net::Frame::Layer qw(:consts);
require Exporter;
our @ISA = qw(Net::Frame::Layer Exporter);

our %EXPORT_TAGS = (
   consts => [qw(
      NF_PPPLCP_HDR_LEN
      NF_PPPLCP_CODE_ECHO_REQUEST
      NF_PPPLCP_CODE_ECHO_REPLY
   )],
);
our @EXPORT_OK = (
   @{$EXPORT_TAGS{consts}},
);

use constant NF_PPPLCP_HDR_LEN           => 8;
use constant NF_PPPLCP_CODE_ECHO_REQUEST => 0x09;
use constant NF_PPPLCP_CODE_ECHO_REPLY   => 0x0a;

our @AS = qw(
   code
   identifier
   length
   magicNumber
);
__PACKAGE__->cgBuildIndices;
__PACKAGE__->cgBuildAccessorsScalar(\@AS);

sub new {
   shift->SUPER::new(
      code        => NF_PPPLCP_CODE_ECHO_REQUEST,
      identifier  => 1,
      length      => NF_PPPLCP_HDR_LEN,
      magicNumber => 0xffffffff,
      @_,
   );
}

sub getLength { shift->length }

sub getPayloadLength { shift->getLength - NF_PPPLCP_HDR_LEN }

sub pack {
   my $self = shift;

   $self->raw($self->SUPER::pack('CCnN',
      $self->code,
      $self->identifier,
      $self->length,
      $self->magicNumber,
   )) or return undef;

   $self->raw;
}

sub unpack {
   my $self = shift;

   my ($code, $identifier, $length, $magicNumber, $payload) =
      $self->SUPER::unpack('CCnN a*', $self->raw)
         or return undef;

   $self->code($code);
   $self->identifier($identifier);
   $self->length($length);
   $self->magicNumber($magicNumber);

   $self->payload($payload);

   $self;
}

sub encapsulate { shift->nextLayer }

sub print {
   my $self = shift;

   my $l = $self->layer;
   sprintf "$l: code:0x%02x  identifier:0x%02x  length:%d  magicNumber:0x%04x",
      $self->code,
      $self->identifier,
      $self->length,
      $self->magicNumber,
   ;
}

1;

__END__