NAME
Net::IPv6Addr - Check validity of IPv6 addresses
VERSION
This documents version 0.7 of Net::IPv6Addr corresponding to git commit 83d5db1fd6c943e35e1893c5b129923857481701 released on Sat Aug 26 07:50:04 2017 +0900.
SYNOPSIS
use Net::IPv6Addr;
my $addr = "dead:beef:cafe:babe::f0ad";
Net::IPv6Addr::ipv6_parse($addr);
my $x = Net::IPv6Addr->new($addr);
print $x->to_string_preferred(), "\n";produces output
dead:beef:cafe:babe:0:0:0:f0ad(This example is included as synopsis.pl in the distribution.)
DESCRIPTION
Net::IPv6Addr checks strings for valid IPv6 addresses, as specified in RFC1884. You throw possible addresses at it, it either accepts them or throws an exception.
This module is able to process addresses formatted in the style referenced by RFC1924.
METHODS AND FUNCTIONS
new
my $ni = Net::IPv6Addr->new ('dead:beef:cafe:babe::f0ad');Parameters
A string to be interpreted as an IPv6 address.
Returns
A Net::IPv6Addr object if successful.
Notes
Throws an exception if the string isn't a valid address.
ipv6_parse
my $ni = Net::IPv6Addr::ipv6_parse ('dead:beef:cafe:babe::f0ad');Parameters
A string containing an IPv6 address string. Optionally, it may also include a / character, and a numeric prefix length, in that order.
or
An IPv6 address string. Optionally, a numeric prefix length.
Returns
What you gave it, more or less, if it does parse out correctly.
Notes
Throws an exception on malformed input. This is not an object method or class method; it's just a subroutine.
is_ipv6
my $niok = Net::IPv6Addr::is_ipv6 ('dead:beef:cafe:babe::f0ad');Parameters
A string containing an IPv6 address string. Optionally, it may also include a / character, and a numeric prefix length, in that order.
-or-
An IPv6 address string. Optionally, a numeric prefix length.
Returns
What you gave it, more or less, if it does parse out correctly, otherwise returns undef.
Notes
This is not an object method or class method; it is just a subroutine.
ipv6_chkip
my $niok = Net::IPv6Addr::ipv6_chkip ('dead:beef:cafe:babe::f0ad');Parameters
An IPv6 address string.
Returns
Something true if it's a valid address; something false otherwise.
to_string_preferred
my $tsp = $ni->to_string_preferred ();
my $tsp = Net::IPv6Addr::to_string_preferred ('dead:beef:cafe:babe::f0ad');Parameters
If used as an object method, none; if used as a plain old subroutine, an IPv6 address string in any format.
Returns
The IPv6 address, formatted in the "preferred" way (as detailed by RFC1884).
Notes
Invalid input will generate an exception.
to_string_compressed
Parameters
If used as an object method, none; if used as a plain old subroutine, an IPv6 address string in any format.
Returns
The IPv6 address in "compressed" format (as detailed by RFC1884).
Notes
Invalid input will generate an exception.
to_string_ipv4
Parameters
If used as an object method, none; if used as a plain old subroutine, an IPv6 address string in any format.
Returns
The IPv6 address in IPv4 format (as detailed by RFC1884).
Notes
Invalid input (such as an address that was not originally IPv4) will generate an exception.
to_string_ipv4_compressed
Parameters
If used as an object method, none; if used as a plain old subroutine, an IPv6 address string in any format.
Returns
The IPv6 address in compressed IPv4 format (as detailed by RFC1884).
Notes
Invalid input (such as an address that was not originally IPv4) will generate an exception.
to_string_base85
Parameters
If used as an object method, none; if used as a plain old subroutine, an IPv6 address string in any format.
Returns
The IPv6 address in the style detailed by RFC1924.
Notes
Invalid input will generate an exception.
to_bigint
Parameters
If used as an object method, none; if used as a plain old subroutine, an IPv6 address string in any format.
Returns
The BigInt representation of IPv6 address.
Notes
Invalid input will generate an exception.
to_array
Parameters
If used as an object method, none; if used as a plain old subroutine, an IPv6 address string in any format.
Returns
An array [0..7] of 16 bit hexadecimal numbers.
Notes
Invalid input will generate an exception.
to_intarray
Parameters
If used as an object method, none; if used as a plain old subroutine, an IPv6 address string in any format.
Returns
An array [0..7] of decimal numbers.
Notes
Invalid input will generate an exception.
to_string_ip6_int
Parameters
If used as an object method, none; if used as a plain old subroutine, an IPv6 address string in any format.
Returns
The reverse-address pointer as defined by RFC1886.
Notes
Invalid input will generate an exception.
in_network_of_size
Parameters
If used as an object method, network size in bits
If used as a plain old subroutine, an IPv6 address string in any format and network size in bits. Network size may be given with / notation.
Returns
Network IPv6Addr of given size.
Notes
Invalid input will generate an exception.
in_network
my $ok = $x->in_network("aa:bb:cc:dd::/64");Parameters
If used as an object method, network and its size in bits
If used as a plain old subroutine, an IPv6 address string in any format network address string and size in bits. Network size may be given with / notation.
Returns
A true value if address is a member of the network, false otherwise.
Notes
Invalid input will generate an exception.
EXPORTS
As of version 0.7, nothing at all can be exported, so all of the routines need to be called in fully-qualified format, like Net::IPv6Addr::is_ipv6. This may change in future versions of the module.
BUGS
Report them at https://rt.cpan.org/Dist/Display.html?Name=Net-IPv6Addr or by email to bug-Net-IPv6Addr [at] rt.cpan.org.
DEPENDENCIES
Net::IPv4Addr, Math::Base85, Math::BigInt
Reverse dependencies
Search grep.cpan.me for uses of this module
SEE ALSO
RFCs
RFC1884, RFC1886, RFC1924, RFC2373
Other CPAN modules
HISTORY
This module was originally written by Tony Monroe in 2001 to simplify the task of maintaining DNS records after he set himself up with Freenet6.
In 2017 the module was adopted by Ben Bullock with the help of Neil Bowers as part of "CPAN day".
AUTHOR
Tony Monroe(*)
The module's interface probably looks like it vaguely resembles Net::IPv4Addr by Francis J. Lacoste <francis dot lacoste at iNsu dot COM>.
Some fixes and subroutines from Jyrki Soini <jyrki dot soini at sonera dot com>.
(*) The current module maintainer does not have any contact information for Tony Monroe. Those wishing to contact him can do so via Neil Bowers (neilb@cpan.org).
LICENSE
This distribution is copyright (c) 2001-2002 Tony Monroe. All rights reserved. This software is distributed under the same license terms as Perl itself. This software comes with NO WARRANTIES WHATSOEVER, express, implied, or otherwise.