.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" 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 .\" ======================================================================== .\" .IX Title "Net::Works 3pm" .TH Net::Works 3pm "2019-01-15" "perl v5.28.1" "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::Works \- Sane APIs for IP addresses and networks .SH "VERSION" .IX Header "VERSION" version 0.22 .SH "DESCRIPTION" .IX Header "DESCRIPTION" The NetAddr::IP module is very complete, correct, and useful. However, its \&\s-1API\s0 design is a bit crufty. This distro provides an alternative \s-1API\s0 that aims to address the biggest problems with that module's \s-1API,\s0 as well as adding some additional features. .PP This distro contains two modules, Net::Works::Address and Net::Works::Network. .PP \&\fB\s-1NOTE:\s0 This distro's APIs are still in flux. Use at your own risk.\fR .SH "Net::Works VERSUS NetAddr::IP" .IX Header "Net::Works VERSUS NetAddr::IP" Here are some of the key differences between the two distributions: .IP "\(bu" 4 Separation of address from network .Sp \&\f(CW\*(C`Net::Works\*(C'\fR provides two classes, one for single \s-1IP\s0 addresses and one for networks (and subnets). With NetAddr::IP a single address is represented as a /32 or /128 subnet. This is technically correct but can make the \s-1API\s0 harder to use. Whenever you want a single \s-1IP\s0 you're always stuck checking that the object you're working with is the size of a single address subnet. .IP "\(bu" 4 Multiple constructors .Sp Net::Works allows you to construct an \s-1IP\s0 address from a string (\*(L"192.0.2.1\*(R") or an integer (3221225985) using separate constructors. .IP "\(bu" 4 Next & previous \s-1IP\s0 .Sp You can get the next and previous address from Net::Works::Address object, regardless of whether or not that address is in the same subnet. .IP "\(bu" 4 Constructors throw exceptions .Sp If you pass bad data to a constructor you'll get an exception. .IP "\(bu" 4 Sane iterator and first/last .Sp The iterator provided by Net::Works::Network has no confusing special cases. It always returns all the addresses in a network, including the network and broadcast addresses. Similarly, the \f(CW\*(C`$network\->first()\*(C'\fR and \f(CW\*(C`$network\->last()\*(C'\fR do not return different results for different sized networks. .IP "\(bu" 4 Split a range into subnets .Sp The Net::Works::Network class provides a \f(CW\*(C`Net::Works::Network\->range_as_subnets\*(C'\fR method that takes a start and end \s-1IP\s0 address and splits this into a set of subnets that include all addresses in the range. .IP "\(bu" 4 Does less .Sp This distro does not support every method provided by NetAddr::IP. Patches to add more features are welcome, however. .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \f(CW\*(C`bug\-net\-works@rt.cpan.org\*(C'\fR, or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Dave Rolsky .IP "\(bu" 4 Greg Oschwald .IP "\(bu" 4 Olaf Alders .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .IP "\(bu" 4 Alexander Hartmaier .IP "\(bu" 4 Dave Rolsky .IP "\(bu" 4 Greg Oschwald .IP "\(bu" 4 \&\s-1TJ\s0 Mather .IP "\(bu" 4 William Stevenson .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2016 by MaxMind, Inc. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.