.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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::Frame::Device 3pm"
.TH Net::Frame::Device 3pm "2015-01-04" "perl v5.20.2" "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::Frame::Device \- get network device information and gateway
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&   use Net::Frame::Device;
\&
\&   # Get default values from system
\&   my $device = Net::Frame::Device\->new;
\&
\&   # Get values from a specific device
\&   my $device2 = Net::Frame::Device\->new(dev => \*(Aqvmnet1\*(Aq);
\&
\&   # Get values from a specific target
\&   my $device3 = Net::Frame::Device\->new(target => \*(Aq192.168.10.2\*(Aq);
\&
\&   print "dev: ", $device\->dev, "\en";
\&   print "mac: ", $device\->mac, "\en";
\&   print "ip : ", $device\->ip,  "\en";
\&   print "ip6: ", $device\->ip6, "\en";
\&   print "gatewayIp:  ", $device\->gatewayIp,  "\en" if $device\->gatewayIp;
\&   print "gatewayMac: ", $device\->gatewayMac, "\en" if $device\->gatewayMac;
\&
\&   # Get values from a specific target
\&   my $device5 = Net::Frame::Device\->new(target6 => \*(Aq2001::1\*(Aq);
\&
\&   print "dev: ", $device5\->dev, "\en";
\&   print "mac: ", $device5\->mac, "\en";
\&   print "ip6: ", $device5\->ip6, "\en";
\&   print "gatewayIp6:  ", $device5\->gatewayIp6, "\en" if $device5\->gatewayIp6;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is used to get network information, and is especially useful when you want to do low-level network programming.
.PP
It also provides useful functions to lookup network \s-1MAC\s0 addresses.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.IP "\fBdev\fR" 4
.IX Item "dev"
The network device. undef if none found.
.IP "\fBip\fR" 4
.IX Item "ip"
The IPv4 address of \fBdev\fR. undef if none found.
.IP "\fBip6\fR" 4
.IX Item "ip6"
The IPv6 address of \fBdev\fR. undef if none found.
.IP "\fBmac\fR" 4
.IX Item "mac"
The \s-1MAC\s0 address of \fBdev\fR. undef if none found.
.IP "\fBsubnet\fR" 4
.IX Item "subnet"
The subnet of IPv4 address \fBip\fR. undef if none found.
.IP "\fBsubnet6\fR" 4
.IX Item "subnet6"
The subnet of IPv6 address \fBip6\fR. undef if none found.
.IP "\fBgatewayIp\fR" 4
.IX Item "gatewayIp"
The gateway IPv4 address. It defaults to default gateway that let you access Internet. If none found, or not required in the usage context, it defaults to undef.
.IP "\fBgatewayIp6\fR" 4
.IX Item "gatewayIp6"
The gateway IPv6 address. It defaults to default gateway that let you access Internet. If none found, or not required in the usage context, it defaults to undef.
.IP "\fBgatewayMac\fR" 4
.IX Item "gatewayMac"
The \s-1MAC\s0 address \fBgatewayIp\fR. See \fBlookupMac\fR method.
.IP "\fBgatewayMac6\fR" 4
.IX Item "gatewayMac6"
The \s-1MAC\s0 address \fBgatewayIp6\fR. See \fBlookupMac6\fR method.
.IP "\fBtarget\fR" 4
.IX Item "target"
This attribute is used when you want to detect which \fBdev\fR, \fBip\fR, \fBmac\fR attributes to use for a specific target. See \fB\s-1SYNOPSIS\s0\fR.
.IP "\fBtarget6\fR" 4
.IX Item "target6"
This attribute is used when you want to detect which \fBdev\fR, \fBip6\fR, \fBmac\fR attributes to use for a specific target. See \fB\s-1SYNOPSIS\s0\fR.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew\fR" 4
.IX Item "new"
.PD 0
.IP "\fBnew\fR (hash)" 4
.IX Item "new (hash)"
.PD
Object constructor. See \fB\s-1SYNOPSIS\s0\fR for default values.
.IP "\fBupdateFromDefault\fR" 4
.IX Item "updateFromDefault"
Will update attributes according to the default interface that has access to Internet.
.IP "\fBupdateFromDev\fR" 4
.IX Item "updateFromDev"
.PD 0
.IP "\fBupdateFromDev\fR (dev)" 4
.IX Item "updateFromDev (dev)"
.PD
Will update attributes according to \fBdev\fR attribute, or if you specify 'dev' as a parameter, it will use it for updating (and will also set \fBdev\fR to this new value).
.IP "\fBupdateFromTarget\fR" 4
.IX Item "updateFromTarget"
.PD 0
.IP "\fBupdateFromTarget\fR (target)" 4
.IX Item "updateFromTarget (target)"
.PD
Will update attributes according to \fBtarget\fR attribute, or if you specify 'target' as a parameter, it will use it for updating (and will also set \fBtarget\fR to this new value).
.IP "\fBupdateFromTarget6\fR" 4
.IX Item "updateFromTarget6"
.PD 0
.IP "\fBupdateFromTarget6\fR (target6)" 4
.IX Item "updateFromTarget6 (target6)"
.PD
Will update attributes according to \fBtarget6\fR attribute, or if you specify 'target6' as a parameter, it will use it for updating (and will also set \fBtarget6\fR to this new value).
.IP "\fBlookupMac\fR (IPv4 address, [ retry, timeout ])" 4
.IX Item "lookupMac (IPv4 address, [ retry, timeout ])"
Will try to get the \s-1MAC\s0 address of the specified IPv4 address. First, it checks against \s-1ARP\s0 cache table. Then, verify the target is on the same subnet as we are, and if yes, it does the \s-1ARP\s0 request. If not on the same subnet, it tries to resolve the gateway \s-1MAC\s0 address (by using \fBgatewayIp\fR attribute). You can add optional parameters retry count and timeout in seconds. Returns undef on failure.
.IP "\fBlookupMac6\fR (IPv6 address, [ retry, timeout ])" 4
.IX Item "lookupMac6 (IPv6 address, [ retry, timeout ])"
Will try to get the \s-1MAC\s0 address of the specified IPv6 address (using ICMPv6). First, verify the target is on the same subnet as we are, and if yes, it does the ICMPv6 lookup request. If not on the same subnet, it tries to resolve the gateway \s-1MAC\s0 address (by using \fBgatewayIp6\fR attribute). You can add optional parameters retry count and timeout in seconds. Returns undef on failure.
.IP "\fBdebugDeviceList\fR" 4
.IX Item "debugDeviceList"
Just for debugging purposes, especially on Windows systems.
.SH "AUTHOR"
.IX Header "AUTHOR"
Patrice <GomoR> Auffret
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2006\-2015, Patrice <GomoR> Auffret
.PP
You may distribute this module under the terms of the Artistic license.
See \s-1LICENSE\s0.Artistic file in the source distribution archive.