#
# $Id: TypeCapabilities.pm 1640 2009-11-09 17:58:27Z gomor $
#
package Net::Packet::CDP::TypeCapabilities;
use strict;
use warnings;

require Net::Packet::CDP::Type;
our @ISA = qw(Net::Packet::CDP::Type);

use Net::Packet::Consts qw(:cdp);

our @AS = qw(
   capabilities
);
__PACKAGE__->cgBuildIndices;
__PACKAGE__->cgBuildAccessorsScalar(\@AS);

#no strict 'vars';

sub new {
   shift->SUPER::new(
      type         => NP_CDP_TYPE_CAPABILITIES,
      length       => 8,
      capabilities => 0x00000000,
      @_,
   );
}

sub pack {
   my $self = shift;

   $self->raw($self->SUPER::pack('nnN',
      $self->type,
      $self->length,
      $self->capabilities,
   )) or return undef;

   1;
}

sub unpack {
   my $self = shift;

   my ($type, $length, $capabilities, $payload) =
      $self->SUPER::unpack('nnN a*', $self->raw)
         or return undef;

   $self->type($type);
   $self->length($length);
   $self->capabilities($capabilities);

   $self->payload($payload);

   1;
}

sub print {
   my $self = shift;

   my $i = $self->is;
   my $l = $self->layer;
   sprintf "$l: $i: type:0x%04x  length:%d  capabilities:0x%08x",
      $self->type, $self->length, $self->capabilities;
}

1;

__END__

=head1 NAME

Net::Packet::CDP::TypeCapabilities - Cisco Discovery Protocol Capabilities extension header

=head1 SYNOPSIS

   use Net::Packet::Consts qw(:cdp);
   require Net::Packet::CDP::TypeCapabilities;

   # Build a layer
   my $layer = Net::Packet::CDP::TypeCapabilities->new(
      type         => NP_CDP_TYPE_CAPABILITIES,
      length       => 8,
      capabilities => 0x00000000,
   );
   $layer->pack;

   print 'RAW: '.unpack('H*', $layer->raw)."\n";

   # Read a raw layer
   my $layer = Net::Packet::CDP::TypeCapabilities->new(raw => $raw);

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

=head1 DESCRIPTION

This modules implements the encoding and decoding of the Cisco Discovery Protocol Capabilities type extension header.

=head1 ATTRIBUTES

=over 4

=item B<type> - 16 bits

=item B<length> - 16 bits

=item B<capabilities> - 32 bits

=back

=head1 METHODS

=over 4

=item B<new>

Object constructor. You can pass attributes that will overwrite default ones. Default values:

type:         NP_CDP_TYPE_CAPABILITIES

length:       8

capabilities: 0x00000000

=item B<pack>

Packs all attributes into a raw format, in order to inject to network. Returns 1 on success, undef otherwise.

=item B<unpack>

Unpacks raw data from network and stores attributes into the object. Returns 1 on success, undef otherwise.

=back

=head1 CONSTANTS

See B<Net::Packet::CDP> CONSTANTS.

=over 4

=back

=head1 AUTHOR

Patrice E<lt>GomoRE<gt> Auffret

=head1 COPYRIGHT AND LICENSE

Copyright (c) 2004-2009, Patrice E<lt>GomoRE<gt> Auffret

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

=head1 RELATED MODULES

L<NetPacket>, L<Net::RawIP>, L<Net::RawSock>

=cut
