.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Net::IPTrie 3pm"
.TH Net::IPTrie 3pm "2021-01-07" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::IPTrie \- Perl module for building IPv4 and IPv6 address space hierarchies
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&    use Net::IPTrie;
\&    my $tr = Net::IPTrie\->new(version=>4);  # IPv4
\&    my $n  = $tr\->add(address=>\*(Aq10.0.0.0\*(Aq, prefix=>8);
\&    my $a  = $tr\->add(address=>\*(Aq10.0.0.1\*(Aq, data=>$data) # prefix defaults to 32
\&    $a\->parent\->address eq $n\->address and print "$a is within $n";
\&
\&    # Addresses can be provided in integer (decimal) format
\&    # 10.0.0.7 == 167772167
\&    my $b = $tr\->add(iaddress=>\*(Aq167772167\*(Aq, data=>\*(Aqblah\*(Aq);
\&    if ( my $c = $tr\->find(address=>"10.0.0.7" ) {
\&        print $c\->data;  # should print "blah"
\&    }
\&
\&   # If the IP does not exist:
\&   my $d = $tr\->find(address=>"10.0.0.8")
\&   print $d\->address;  # should print "10.0.0.0", which is the closest parent block
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Vb 3
\& This module uses a radix tree (or trie) to quickly build the hierarchy of a given address space
\& (both IPv4 and IPv6).  This allows the user to perform fast subnet or routing lookups.
\& It is implemented exclusively in Perl.
.Ve
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.SS "new \- Class Constructor"
.IX Subsection "new - Class Constructor"
.Vb 7
\&  Arguments: 
\&    Hash with the following keys:
\&    version \- IP version (4|6)
\&  Returns:   
\&    New Net::IPTrie object
\&  Examples:    
\&    my $tr = Net::IPTrie\->new(version=>4);
.Ve
.SH "INSTANCE METHODS"
.IX Header "INSTANCE METHODS"
.SS "version \- Set or get \s-1IP\s0 version (4 or 6)"
.IX Subsection "version - Set or get IP version (4 or 6)"
.Vb 6
\&  Arguments: 
\&    IP version (4 or 6) \- optional
\&  Returns:   
\&    version (4 or 6)
\&  Examples:  
\&    print $tr\->version;
.Ve
.SS "size \- Set or get \s-1IP\s0 size (32 or 128)"
.IX Subsection "size - Set or get IP size (32 or 128)"
.Vb 6
\&  Arguments:   
\&    Size (32 or 128) \- optional
\&  Returns:     
\&    Address size in bits (32 or 128)
\&  Examples:    
\&    print $tr\->size;
.Ve
.SS "find \- Find an \s-1IP\s0 object in the trie"
.IX Subsection "find - Find an IP object in the trie"
.Vb 5
\&    If the given IP does not exist, there are two options:
\&    a) If the "deep" flag is off, the closest covering IP block is returned. This is
\&       the default behavior.
\&    b) If the "deep" flag is on, the node where the searched IP should be inserted is returned.  
\&       This is basically only useful for the "add" method.
\&
\&  Arguments: 
\&    Hash with following keys:
\&      address  \- String (i.e. "10.0.0.1") address
\&      iaddress \- Integer (i.e. "167772161") address, IPv4 or IPv6.
\&      prefix   \- Prefix Length (optional  \- defaults to host mask)
\&      deep     \- Flag (optional). If not found, return the node where object should be inserted.
\&  Returns:   
\&    Net::IPTrie::Node object.  
\&  Examples:    
\&    my $n = $tr\->find("10.0.0.1", 32);
.Ve
.SS "add \- Add an \s-1IP\s0 to the trie"
.IX Subsection "add - Add an IP to the trie"
.Vb 10
\&  Arguments: 
\&    Hash with following keys:
\&      address  \- String address, IPv4 or IPv6 (i.e. "10.0.0.1")  
\&      iaddress \- Integer address, IPv4 or IPv6 (i.e. "167772161") 
\&      prefix   \- Prefix Length (optional \- defaults to host mask)
\&      data     \- Data (optional)
\&  Returns:   
\&     New Net::IPTrie::Node object
\&  Examples:    
\&    my $n = $tr\->add(address=>"10.0.0.1", prefix=>32, data=>\e$data);
.Ve
.SS "traverse \- Traverse every node in the tree"
.IX Subsection "traverse - Traverse every node in the tree"
.Vb 11
\&  Arguments: 
\&    root \- node object (optional \- defaults to tree root)
\&    code \- coderef (will be passed the Net::IPTrie::Node object to act upon)
\&    mode \- (depth_first only, for now)
\&  Returns:   
\&    Number of actual IP nodes visited
\&  Examples:    
\&    # Store all IP nodes in an array, ordered.
\&    my $list = ();
\&    my $code = sub { push @$list, shift @_ };
\&    my $count = $tr\->traverse(code=>$code);
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Carlos Vicente  <cvicente@cpan.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::IPTrie::Node
Net::Patricia
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2007\-2010, Carlos Vicente <cvicente@cpan.org>. All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0
.PP
\&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE\s0 (\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0