Debian Codegraph @

upstream/debian-unstable/man3/Net::hostent.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Net::hostent 3perl"
58 .TH Net::hostent 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Net::hostent \- by\-name interface to Perl's built\-in gethost*() functions
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use Net::hostent;
69 .Ve
70 .SH DESCRIPTION
71 .IX Header "DESCRIPTION"
72 This module's default exports override the core \fBgethostbyname()\fR and
73 \&\fBgethostbyaddr()\fR functions, replacing them with versions that return
74 "Net::hostent" objects. This object has methods that return the similarly
75 named structure field name from the C's hostent structure from \fInetdb.h\fR;
76 namely name, aliases, addrtype, length, and addr_list. The aliases and
77 addr_list methods return array reference, the rest scalars. The addr
78 method is equivalent to the zeroth element in the addr_list array
79 reference.
80 .PP
81 You may also import all the structure fields directly into your namespace
82 as regular variables using the :FIELDS import tag. (Note that this still
83 overrides your core functions.) Access these fields as variables named
84 with a preceding \f(CW\*(C`h_\*(C'\fR. Thus, \f(CW\*(C`$host_obj\->name()\*(C'\fR corresponds to
85 \&\f(CW$h_name\fR if you import the fields. Array references are available as
86 regular array variables, so for example \f(CW\*(C`@{ $host_obj\->aliases()
87 }\*(C'\fR would be simply \f(CW@h_aliases\fR.
88 .PP
89 The \fBgethost()\fR function is a simple front-end that forwards a numeric
90 argument to \fBgethostbyaddr()\fR by way of Socket::inet_aton, and the rest
91 to \fBgethostbyname()\fR.
92 .PP
93 To access this functionality without the core overrides,
94 pass the \f(CW\*(C`use\*(C'\fR an empty import list, and then access
95 function functions with their full qualified names.
96 On the other hand, the built-ins are still available
97 via the \f(CW\*(C`CORE::\*(C'\fR pseudo-package.
98 .SH EXAMPLES
99 .IX Header "EXAMPLES"
100 .Vb 2
101 \& use Net::hostent;
102 \& use Socket;
103 \&
104 \& @ARGV = (\*(Aqnetscape.com\*(Aq) unless @ARGV;
105 \&
106 \& for $host ( @ARGV ) {
107 \&
108 \& unless ($h = gethost($host)) {
109 \& warn "$0: no such host: $host\en";
110 \& next;
111 \& }
112 \&
113 \& printf "\en%s is %s%s\en",
114 \& $host,
115 \& lc($h\->name) eq lc($host) ? "" : "*really* ",
116 \& $h\->name;
117 \&
118 \& print "\etaliases are ", join(", ", @{$h\->aliases}), "\en"
119 \& if @{$h\->aliases};
120 \&
121 \& if ( @{$h\->addr_list} > 1 ) {
122 \& my $i;
123 \& for $addr ( @{$h\->addr_list} ) {
124 \& printf "\etaddr #%d is [%s]\en", $i++, inet_ntoa($addr);
125 \& }
126 \& } else {
127 \& printf "\etaddress is [%s]\en", inet_ntoa($h\->addr);
128 \& }
129 \&
130 \& if ($h = gethostbyaddr($h\->addr)) {
131 \& if (lc($h\->name) ne lc($host)) {
132 \& printf "\etThat addr reverses to host %s!\en", $h\->name;
133 \& $host = $h\->name;
134 \& redo;
135 \& }
136 \& }
137 \& }
138 .Ve
139 .SH NOTE
140 .IX Header "NOTE"
141 While this class is currently implemented using the Class::Struct
142 module to build a struct-like class, you shouldn't rely upon this.
143 .SH AUTHOR
144 .IX Header "AUTHOR"
145 Tom Christiansen