Initial commit of OpenSPARC T2 architecture model.

[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / man / man3 / Net::netent.3

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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::netent 3"
.TH Net::netent 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
.SH "NAME"
Net::netent \- by\-name interface to Perl's built\-in getnet*() functions
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use Net::netent qw(:FIELDS);
\& getnetbyname("loopback")               or die "bad net";
\& printf "%s is %08X\en", $n_name, $n_net;
.Ve
.PP
.Vb 1
\& use Net::netent;
.Ve
.PP
.Vb 6
\& $n = getnetbyname("loopback")          or die "bad net";
\& { # there's gotta be a better way, eh?
\&     @bytes = unpack("C4", pack("N", $n->net));
\&     shift @bytes while @bytes && $bytes[0] == 0;
\& }
\& printf "%s is %08X [%d.%d.%d.%d]\en", $n->name, $n->net, @bytes;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module's default exports override the core \fIgetnetbyname()\fR and
\&\fIgetnetbyaddr()\fR functions, replacing them with versions that return
\&\*(L"Net::netent\*(R" objects.  This object has methods that return the similarly
named structure field name from the C's netent structure from \fInetdb.h\fR;
namely name, aliases, addrtype, and net.  The aliases 
method returns an array reference, the rest scalars.  
.PP
You may also import all the structure fields directly into your namespace
as regular variables using the :FIELDS import tag.  (Note that this still
overrides your core functions.)  Access these fields as variables named
with a preceding \f(CW\*(C`n_\*(C'\fR.  Thus, \f(CW\*(C`$net_obj\->name()\*(C'\fR corresponds to
\&\f(CW$n_name\fR if you import the fields.  Array references are available as
regular array variables, so for example \f(CW\*(C`@{ $net_obj\->aliases()
}\*(C'\fR would be simply \f(CW@n_aliases\fR.
.PP
The \fIgetnet()\fR function is a simple front-end that forwards a numeric
argument to \fIgetnetbyaddr()\fR, and the rest
to \fIgetnetbyname()\fR.
.PP
To access this functionality without the core overrides,
pass the \f(CW\*(C`use\*(C'\fR an empty import list, and then access
function functions with their full qualified names.
On the other hand, the built-ins are still available
via the \f(CW\*(C`CORE::\*(C'\fR pseudo\-package.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
The \fIgetnet()\fR functions do this in the Perl core:
.PP
.Vb 1
\&    sv_setiv(sv, (I32)nent->n_net);
.Ve
.PP
The \fIgethost()\fR functions do this in the Perl core:
.PP
.Vb 1
\&    sv_setpvn(sv, hent->h_addr, len);
.Ve
.PP
That means that the address comes back in binary for the
host functions, and as a regular perl integer for the net ones.
This seems a bug, but here's how to deal with it:
.PP
.Vb 3
\& use strict;
\& use Socket;
\& use Net::netent;
.Ve
.PP
.Vb 1
\& @ARGV = ('loopback') unless @ARGV;
.Ve
.PP
.Vb 1
\& my($n, $net);
.Ve
.PP
.Vb 1
\& for $net ( @ARGV ) {
.Ve
.PP
.Vb 4
\&     unless ($n = getnetbyname($net)) {
\&        warn "$0: no such net: $net\en";
\&        next;
\&     }
.Ve
.PP
.Vb 4
\&     printf "\en%s is %s%s\en", 
\&            $net, 
\&            lc($n->name) eq lc($net) ? "" : "*really* ",
\&            $n->name;
.Ve
.PP
.Vb 2
\&     print "\etaliases are ", join(", ", @{$n->aliases}), "\en"
\&                if @{$n->aliases};
.Ve
.PP
.Vb 8
\&     # this is stupid; first, why is this not in binary?
\&     # second, why am i going through these convolutions
\&     # to make it looks right
\&     {
\&        my @a = unpack("C4", pack("N", $n->net));
\&        shift @a while @a && $a[0] == 0;
\&        printf "\etaddr is %s [%d.%d.%d.%d]\en", $n->net, @a;
\&     }
.Ve
.PP
.Vb 8
\&     if ($n = getnetbyaddr($n->net)) {
\&        if (lc($n->name) ne lc($net)) {
\&            printf "\etThat addr reverses to net %s!\en", $n->name;
\&            $net = $n->name;
\&            redo;
\&        } 
\&     }
\& }
.Ve
.SH "NOTE"
.IX Header "NOTE"
While this class is currently implemented using the Class::Struct
module to build a struct-like class, you shouldn't rely upon this.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tom Christiansen