Blame lib/Net/DNS/RR/LP.pm

Packit e6c8bb
package Net::DNS::RR::LP;
Packit e6c8bb
Packit e6c8bb
#
Packit e6c8bb
# $Id: LP.pm 1597 2017-09-22 08:04:02Z willem $
Packit e6c8bb
#
Packit e6c8bb
our $VERSION = (qw$LastChangedRevision: 1597 $)[1];
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
use strict;
Packit e6c8bb
use warnings;
Packit e6c8bb
use base qw(Net::DNS::RR);
Packit e6c8bb
Packit e6c8bb
=head1 NAME
Packit e6c8bb
Packit e6c8bb
Net::DNS::RR::LP - DNS LP resource record
Packit e6c8bb
Packit e6c8bb
=cut
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
use integer;
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
sub _decode_rdata {			## decode rdata from wire-format octet string
Packit e6c8bb
	my $self = shift;
Packit e6c8bb
	my ( $data, $offset ) = @_;
Packit e6c8bb
Packit e6c8bb
	$self->{preference} = unpack( "\@$offset n", $$data );
Packit e6c8bb
	$self->{target} = decode Net::DNS::DomainName( $data, $offset + 2 );
Packit e6c8bb
}
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
sub _encode_rdata {			## encode rdata as wire-format octet string
Packit e6c8bb
	my $self = shift;
Packit e6c8bb
Packit e6c8bb
	my $target = $self->{target};
Packit e6c8bb
	pack 'n a*', $self->preference, $target->encode();
Packit e6c8bb
}
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
sub _format_rdata {			## format rdata portion of RR string.
Packit e6c8bb
	my $self = shift;
Packit e6c8bb
Packit e6c8bb
	my $target = $self->{target};
Packit e6c8bb
	join ' ', $self->preference, $target->string;
Packit e6c8bb
}
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
sub _parse_rdata {			## populate RR from rdata in argument list
Packit e6c8bb
	my $self = shift;
Packit e6c8bb
Packit e6c8bb
	$self->preference(shift);
Packit e6c8bb
	$self->target(shift);
Packit e6c8bb
}
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
sub preference {
Packit e6c8bb
	my $self = shift;
Packit e6c8bb
Packit e6c8bb
	$self->{preference} = 0 + shift if scalar @_;
Packit e6c8bb
	$self->{preference} || 0;
Packit e6c8bb
}
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
sub target {
Packit e6c8bb
	my $self = shift;
Packit e6c8bb
Packit e6c8bb
	$self->{target} = new Net::DNS::DomainName(shift) if scalar @_;
Packit e6c8bb
	$self->{target}->name if $self->{target};
Packit e6c8bb
}
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
sub FQDN { shift->{target}->fqdn; }
Packit e6c8bb
sub fqdn { shift->{target}->fqdn; }
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
my $function = sub {			## sort RRs in numerically ascending order.
Packit e6c8bb
	$Net::DNS::a->{'preference'} <=> $Net::DNS::b->{'preference'};
Packit e6c8bb
};
Packit e6c8bb
Packit e6c8bb
__PACKAGE__->set_rrsort_func( 'preference', $function );
Packit e6c8bb
Packit e6c8bb
__PACKAGE__->set_rrsort_func( 'default_sort', $function );
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
1;
Packit e6c8bb
__END__
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
=head1 SYNOPSIS
Packit e6c8bb
Packit e6c8bb
    use Net::DNS;
Packit e6c8bb
    $rr = new Net::DNS::RR('name IN LP preference FQDN');
Packit e6c8bb
Packit e6c8bb
    $rr = new Net::DNS::RR(
Packit e6c8bb
	name	   => 'example.com',
Packit e6c8bb
	type	   => 'LP',
Packit e6c8bb
	preference => 10,
Packit e6c8bb
	target	   => 'target.example.com.'
Packit e6c8bb
	);
Packit e6c8bb
Packit e6c8bb
=head1 DESCRIPTION
Packit e6c8bb
Packit e6c8bb
Class for DNS Locator Pointer (LP) resource records.
Packit e6c8bb
Packit e6c8bb
The LP DNS resource record (RR) is used to hold the name of a
Packit e6c8bb
subnetwork for ILNP.  The name is an FQDN which can then be used to
Packit e6c8bb
look up L32 or L64 records.  LP is, effectively, a Locator Pointer to
Packit e6c8bb
L32 and/or L64 records.
Packit e6c8bb
Packit e6c8bb
=head1 METHODS
Packit e6c8bb
Packit e6c8bb
The available methods are those inherited from the base class augmented
Packit e6c8bb
by the type-specific methods defined in this package.
Packit e6c8bb
Packit e6c8bb
Use of undocumented package features or direct access to internal data
Packit e6c8bb
structures is discouraged and could result in program termination or
Packit e6c8bb
other unpredictable behaviour.
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
=head2 preference
Packit e6c8bb
Packit e6c8bb
    $preference = $rr->preference;
Packit e6c8bb
    $rr->preference( $preference );
Packit e6c8bb
Packit e6c8bb
A 16 bit unsigned integer in network byte order that indicates the
Packit e6c8bb
relative preference for this LP record among other LP records
Packit e6c8bb
associated with this owner name.  Lower values are preferred over
Packit e6c8bb
higher values.
Packit e6c8bb
Packit e6c8bb
=head2 FQDN, fqdn
Packit e6c8bb
Packit e6c8bb
=head2 target
Packit e6c8bb
Packit e6c8bb
    $target = $rr->target;
Packit e6c8bb
    $rr->target( $target );
Packit e6c8bb
Packit e6c8bb
The FQDN field contains the DNS target name that is used to
Packit e6c8bb
reference L32 and/or L64 records.
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
=head1 COPYRIGHT
Packit e6c8bb
Packit e6c8bb
Copyright (c)2012 Dick Franks.
Packit e6c8bb
Packit e6c8bb
All rights reserved.
Packit e6c8bb
Packit e6c8bb
Package template (c)2009,2012 O.M.Kolkman and R.W.Franks.
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
=head1 LICENSE
Packit e6c8bb
Packit e6c8bb
Permission to use, copy, modify, and distribute this software and its
Packit e6c8bb
documentation for any purpose and without fee is hereby granted, provided
Packit e6c8bb
that the above copyright notice appear in all copies and that both that
Packit e6c8bb
copyright notice and this permission notice appear in supporting
Packit e6c8bb
documentation, and that the name of the author not be used in advertising
Packit e6c8bb
or publicity pertaining to distribution of the software without specific
Packit e6c8bb
prior written permission.
Packit e6c8bb
Packit e6c8bb
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Packit e6c8bb
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Packit e6c8bb
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
Packit e6c8bb
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Packit e6c8bb
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
Packit e6c8bb
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
Packit e6c8bb
DEALINGS IN THE SOFTWARE.
Packit e6c8bb
Packit e6c8bb
Packit e6c8bb
=head1 SEE ALSO
Packit e6c8bb
Packit e6c8bb
L<perl>, L<Net::DNS>, L<Net::DNS::RR>, RFC6742
Packit e6c8bb
Packit e6c8bb
=cut